Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_fastcgi_module.xml @ 1928:2c14a16c61eb
Added modules section to development guide.
author | Vladimir Homutov <vl@nginx.com> |
---|---|
date | Fri, 10 Mar 2017 16:33:09 +0300 |
parents | 66a30a380fba |
children | dd96a09dd4f7 |
rev | line source |
---|---|
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2 |
580
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
575
diff
changeset
|
3 <!-- |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
575
diff
changeset
|
4 Copyright (C) Igor Sysoev |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
575
diff
changeset
|
5 Copyright (C) Nginx, Inc. |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
575
diff
changeset
|
6 --> |
be54c443235a
Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents:
575
diff
changeset
|
7 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
9 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
10 <module name="Module ngx_http_fastcgi_module" |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 link="/en/docs/http/ngx_http_fastcgi_module.html" |
589 | 12 lang="en" |
1923
66a30a380fba
Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents:
1912
diff
changeset
|
13 rev="44"> |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
14 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
15 <section id="summary"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
16 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
17 <para> |
966 | 18 The <literal>ngx_http_fastcgi_module</literal> module allows passing |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
19 requests to a FastCGI server. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
20 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
21 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
22 </section> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
23 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
24 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
25 <section id="example" name="Example Configuration"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
26 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
27 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
28 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
29 location / { |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
30 fastcgi_pass localhost:9000; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
31 fastcgi_index index.php; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
32 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
33 fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
34 fastcgi_param QUERY_STRING $query_string; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
35 fastcgi_param REQUEST_METHOD $request_method; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
36 fastcgi_param CONTENT_TYPE $content_type; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
37 fastcgi_param CONTENT_LENGTH $content_length; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
38 } |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
39 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
40 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
41 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
42 </section> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
43 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
44 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
45 <section id="directives" name="Directives"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
46 |
772
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
47 <directive name="fastcgi_bind"> |
1885
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
48 <syntax> |
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
49 <value>address</value> |
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
50 [<literal>transparent</literal>] | |
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
51 <literal>off</literal></syntax> |
772
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
52 <default/> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
53 <context>http</context> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
54 <context>server</context> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
55 <context>location</context> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
56 <appeared-in>0.8.22</appeared-in> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
57 |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
58 <para> |
966 | 59 Makes outgoing connections to a FastCGI server originate |
1748
be371be7a5c8
Documented optional port for proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1731
diff
changeset
|
60 from the specified local IP address with an optional port (1.11.2). |
966 | 61 Parameter value can contain variables (1.3.12). |
815
ed29fd8be462
*_bind: variables support and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
793
diff
changeset
|
62 The special value <literal>off</literal> (1.3.12) cancels the effect |
ed29fd8be462
*_bind: variables support and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
793
diff
changeset
|
63 of the <literal>fastcgi_bind</literal> directive |
966 | 64 inherited from the previous configuration level, which allows the |
1748
be371be7a5c8
Documented optional port for proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1731
diff
changeset
|
65 system to auto-assign the local IP address and port. |
772
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
66 </para> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
67 |
1696
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
68 <para id="fastcgi_bind_transparent"> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
69 The <literal>transparent</literal> parameter (1.11.0) allows |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
70 outgoing connections to a FastCGI server originate |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
71 from a non-local IP address, |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
72 for example, from a real IP address of a client: |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
73 <example> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
74 fastcgi_bind $remote_addr transparent; |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
75 </example> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
76 In order for this parameter to work, |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
77 it is necessary to run nginx worker processes with the |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
78 <link doc="../ngx_core_module.xml" id="user">superuser</link> privileges |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
79 and configure kernel routing table |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
80 to intercept network traffic from the FastCGI server. |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
81 </para> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
82 |
772
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
83 </directive> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
84 |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
85 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
86 <directive name="fastcgi_buffer_size"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
87 <syntax><value>size</value></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
88 <default>4k|8k</default> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
89 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
90 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
91 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
92 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
93 <para> |
966 | 94 Sets the <value>size</value> of the buffer used for reading the first part |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
95 of the response received from the FastCGI server. |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 This part usually contains a small response header. |
1550
305f2c338181
Fixed description of default value of proxy_buffer_size and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1542
diff
changeset
|
97 By default, the buffer size is equal to one memory page. |
305f2c338181
Fixed description of default value of proxy_buffer_size and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1542
diff
changeset
|
98 This is either 4K or 8K, depending on a platform. |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
99 It can be made smaller, however. |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
100 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
101 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
102 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
103 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
104 |
995
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
105 <directive name="fastcgi_buffering"> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
106 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
107 <default>on</default> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
108 <context>http</context> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
109 <context>server</context> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
110 <context>location</context> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
111 <appeared-in>1.5.6</appeared-in> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
112 |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
113 <para> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
114 Enables or disables buffering of responses from the FastCGI server. |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
115 </para> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
116 |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
117 <para> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
118 When buffering is enabled, nginx receives a response from the FastCGI server |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
119 as soon as possible, saving it into the buffers set by the |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
120 <link id="fastcgi_buffer_size"/> and <link id="fastcgi_buffers"/> directives. |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
121 If the whole response does not fit into memory, a part of it can be saved |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
122 to a <link id="fastcgi_temp_path">temporary file</link> on the disk. |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
123 Writing to temporary files is controlled by the |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
124 <link id="fastcgi_max_temp_file_size"/> and |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
125 <link id="fastcgi_temp_file_write_size"/> directives. |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
126 </para> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
127 |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
128 <para> |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
129 When buffering is disabled, the response is passed to a client synchronously, |
995
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
130 immediately as it is received. |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
131 nginx will not try to read the whole response from the FastCGI server. |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
132 The maximum size of the data that nginx can receive from the server |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
133 at a time is set by the <link id="fastcgi_buffer_size"/> directive. |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
134 </para> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
135 |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
136 <para> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
137 Buffering can also be enabled or disabled by passing |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
138 “<literal>yes</literal>” or “<literal>no</literal>” in the |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
139 <header>X-Accel-Buffering</header> response header field. |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
140 This capability can be disabled using the |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
141 <link id="fastcgi_ignore_headers"/> directive. |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
142 </para> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
143 |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
144 </directive> |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
145 |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
146 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
147 <directive name="fastcgi_buffers"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
148 <syntax><value>number</value> <value>size</value></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
149 <default>8 4k|8k</default> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
150 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
151 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
152 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
154 <para> |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
155 Sets the <value>number</value> and <value>size</value> of the |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
156 buffers used for reading a response from the FastCGI server, |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
157 for a single connection. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 By default, the buffer size is equal to one memory page. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
159 This is either 4K or 8K, depending on a platform. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
160 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
161 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
162 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
163 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
164 |
411
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
165 <directive name="fastcgi_busy_buffers_size"> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
166 <syntax><value>size</value></syntax> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
167 <default>8k|16k</default> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
168 <context>http</context> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
169 <context>server</context> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
170 <context>location</context> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
171 |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
172 <para> |
995
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
173 When <link id="fastcgi_buffering">buffering</link> of responses from the FastCGI |
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
174 server is enabled, limits the total <value>size</value> of buffers that |
411
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
175 can be busy sending a response to the client while the response is not |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
176 yet fully read. |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
177 In the meantime, the rest of the buffers can be used for reading the response |
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
178 and, if needed, buffering part of the response to a temporary file. |
966 | 179 By default, <value>size</value> is limited by the size of two buffers set by the |
411
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
180 <link id="fastcgi_buffer_size"/> and <link id="fastcgi_buffers"/> directives. |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
181 </para> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
182 |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
183 </directive> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
184 |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
185 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
186 <directive name="fastcgi_cache"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
187 <syntax><value>zone</value> | <literal>off</literal></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
188 <default>off</default> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
189 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
190 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
191 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
192 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
193 <para> |
575
ebcb351d9eb3
Consistently using the term "shared memory zone".
Ruslan Ermilov <ru@nginx.com>
parents:
509
diff
changeset
|
194 Defines a shared memory zone used for caching. |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
195 The same zone can be used in several places. |
1382
94cac978bda3
Documented variables support in proxy_cache and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1379
diff
changeset
|
196 Parameter value can contain variables (1.7.9). |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
197 The <literal>off</literal> parameter disables caching inherited |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
198 from the previous configuration level. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
199 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
200 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
201 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
202 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
203 |
1909
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
204 <directive name="fastcgi_cache_background_update"> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
205 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
206 <default>off</default> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
207 <context>http</context> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
208 <context>server</context> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
209 <context>location</context> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
210 <appeared-in>1.11.10</appeared-in> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
211 |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
212 <para> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
213 Allows starting a background subrequest |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
214 to update an expired cache item, |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
215 while a stale cached response is returned to the client. |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
216 Note that it is necessary to |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
217 <link id="fastcgi_cache_use_stale_updating">allow</link> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
218 the usage of a stale cached response when it is being updated. |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
219 </para> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
220 |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
221 </directive> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
222 |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
223 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
224 <directive name="fastcgi_cache_bypass"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 <syntax><value>string</value> ...</syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
226 <default/> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
227 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
228 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
229 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
230 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
231 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
232 Defines conditions under which the response will not be taken from a cache. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
233 If at least one value of the string parameters is not empty and is not |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
234 equal to “0” then the response will not be taken from the cache: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
235 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
236 fastcgi_cache_bypass $cookie_nocache $arg_nocache$arg_comment; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
237 fastcgi_cache_bypass $http_pragma $http_authorization; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
238 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
239 Can be used along with the <link id="fastcgi_no_cache"/> directive. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
240 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
241 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
242 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
243 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
244 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
245 <directive name="fastcgi_cache_key"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
246 <syntax><value>string</value></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
247 <default/> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
248 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
249 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
250 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
251 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
252 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
253 Defines a key for caching, for example |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
254 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
255 fastcgi_cache_key localhost:9000$request_uri; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
256 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
257 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
258 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
259 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
260 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
261 |
302
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
262 <directive name="fastcgi_cache_lock"> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
263 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
264 <default>off</default> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
265 <context>http</context> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
266 <context>server</context> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
267 <context>location</context> |
310
86732337c730
Added a historical information for proxy_cache_lock, proxy_cache_lock_timeout,
Ruslan Ermilov <ru@nginx.com>
parents:
302
diff
changeset
|
268 <appeared-in>1.1.12</appeared-in> |
302
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
269 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
270 <para> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
271 When enabled, only one request at a time will be allowed to populate |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
272 a new cache element identified according to the <link id="fastcgi_cache_key"/> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
273 directive by passing a request to a FastCGI server. |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
274 Other requests of the same cache element will either wait |
966 | 275 for a response to appear in the cache or the cache lock for |
302
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
276 this element to be released, up to the time set by the |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
277 <link id="fastcgi_cache_lock_timeout"/> directive. |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
278 </para> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
279 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
280 </directive> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
281 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
282 |
1379
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
283 <directive name="fastcgi_cache_lock_age"> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
284 <syntax><value>time</value></syntax> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
285 <default>5s</default> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
286 <context>http</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
287 <context>server</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
288 <context>location</context> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
289 <appeared-in>1.7.8</appeared-in> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
290 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
291 <para> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
292 If the last request passed to the FastCGI server |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
293 for populating a new cache element |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
294 has not completed for the specified <value>time</value>, |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
295 one more request may be passed to the FastCGI server. |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
296 </para> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
297 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
298 </directive> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
299 |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
300 |
302
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
301 <directive name="fastcgi_cache_lock_timeout"> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
302 <syntax><value>time</value></syntax> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
303 <default>5s</default> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
304 <context>http</context> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
305 <context>server</context> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
306 <context>location</context> |
310
86732337c730
Added a historical information for proxy_cache_lock, proxy_cache_lock_timeout,
Ruslan Ermilov <ru@nginx.com>
parents:
302
diff
changeset
|
307 <appeared-in>1.1.12</appeared-in> |
302
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
308 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
309 <para> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
310 Sets a timeout for <link id="fastcgi_cache_lock"/>. |
1379
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
311 When the <value>time</value> expires, |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
312 the request will be passed to the FastCGI server, |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
313 however, the response will not be cached. |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
314 <note> |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
315 Before 1.7.8, the response could be cached. |
91f5c089f4ca
Documented fastcgi_cache_lock_age and look-alikes.
Ruslan Ermilov <ru@nginx.com>
parents:
1353
diff
changeset
|
316 </note> |
302
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
317 </para> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
318 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
319 </directive> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
320 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
298
diff
changeset
|
321 |
1838
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
322 <directive name="fastcgi_cache_max_range_offset"> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
323 <syntax><value>number</value></syntax> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
324 <default/> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
325 <context>http</context> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
326 <context>server</context> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
327 <context>location</context> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
328 <appeared-in>1.11.6</appeared-in> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
329 |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
330 <para> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
331 Sets an offset in bytes for byte-range requests. |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
332 If the range is beyond the offset, |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
333 the range request will be passed to the FastCGI server |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
334 and the response will not be cached. |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
335 </para> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
336 |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
337 </directive> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
338 |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1812
diff
changeset
|
339 |
793
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
340 <directive name="fastcgi_cache_methods"> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
341 <syntax> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
342 <literal>GET</literal> | |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
343 <literal>HEAD</literal> | |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
344 <literal>POST</literal> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
345 ...</syntax> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
346 <default>GET HEAD</default> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
347 <context>http</context> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
348 <context>server</context> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
349 <context>location</context> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
350 <appeared-in>0.7.59</appeared-in> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
351 |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
352 <para> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
353 If the client request method is listed in this directive then |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
354 the response will be cached. |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
355 “<literal>GET</literal>” and “<literal>HEAD</literal>” methods are always |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
356 added to the list, though it is recommended to specify them explicitly. |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
357 See also the <link id="fastcgi_no_cache"/> directive. |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
358 </para> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
359 |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
360 </directive> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
361 |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
362 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
363 <directive name="fastcgi_cache_min_uses"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
364 <syntax><value>number</value></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
365 <default>1</default> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
366 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
367 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
368 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
369 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
370 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
371 Sets the <value>number</value> of requests after which the response |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
372 will be cached. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
373 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
374 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
375 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
376 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
377 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
378 <directive name="fastcgi_cache_path"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
379 <syntax> |
364 | 380 <value>path</value> |
381 [<literal>levels</literal>=<value>levels</value>] | |
1384
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
382 [<literal>use_temp_path</literal>=<literal>on</literal>|<literal>off</literal>] |
364 | 383 <literal>keys_zone</literal>=<value>name</value>:<value>size</value> |
384 [<literal>inactive</literal>=<value>time</value>] | |
508
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
385 [<literal>max_size</literal>=<value>size</value>] |
1810
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
386 [<literal>manager_files</literal>=<value>number</value>] |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
387 [<literal>manager_sleep</literal>=<value>time</value>] |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
388 [<literal>manager_threshold</literal>=<value>time</value>] |
508
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
389 [<literal>loader_files</literal>=<value>number</value>] |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
390 [<literal>loader_sleep</literal>=<value>time</value>] |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
391 [<literal>loader_threshold</literal>=<value>time</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
392 [<literal>purger</literal>=<literal>on</literal>|<literal>off</literal>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
393 [<literal>purger_files</literal>=<value>number</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
394 [<literal>purger_sleep</literal>=<value>time</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
395 [<literal>purger_threshold</literal>=<value>time</value>]</syntax> |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
396 <default/> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
397 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
398 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
399 <para> |
966 | 400 Sets the path and other parameters of a cache. |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
401 Cache data are stored in files. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
402 Both the key and file name in a cache are a result of |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
403 applying the MD5 function to the proxied URL. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
404 |
1796
1d576e8d6ead
Clarified the "levels" parameter of proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1748
diff
changeset
|
405 The <literal>levels</literal> parameter defines hierarchy levels of a cache: |
1d576e8d6ead
Clarified the "levels" parameter of proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1748
diff
changeset
|
406 from 1 to 3, each level accepts values 1 or 2. |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
407 For example, in the following configuration |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
408 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
409 fastcgi_cache_path /data/nginx/cache levels=1:2 keys_zone=one:10m; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
410 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
411 file names in a cache will look like this: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
412 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
413 /data/nginx/cache/<emphasis>c</emphasis>/<emphasis>29</emphasis>/b7f54b2df7773722d382f4809d650<emphasis>29c</emphasis> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
414 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
415 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
416 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
417 <para> |
966 | 418 A cached response is first written to a temporary file, |
419 and then the file is renamed. | |
420 Starting from version 0.8.9, temporary files and the cache can be put on | |
421 different file systems. | |
422 However, be aware that in this case a file is copied | |
423 across two file systems instead of the cheap renaming operation. | |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
424 It is thus recommended that for any given location both cache and a directory |
1384
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
425 holding temporary files |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
426 are put on the same file system. |
1384
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
427 A directory for temporary files is set based on |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
428 the <literal>use_temp_path</literal> parameter (1.7.10). |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
429 If this parameter is omitted or set to the value <literal>on</literal>, |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
430 the directory set by the <link id="fastcgi_temp_path"/> directive |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
431 for the given location will be used. |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
432 If the value is set to <literal>off</literal>, |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
433 temporary files will be put directly in the cache directory. |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
434 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
435 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
436 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
437 In addition, all active keys and information about data are stored |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
438 in a shared memory zone, whose <value>name</value> and <value>size</value> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
439 are configured by the <literal>keys_zone</literal> parameter. |
1189
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1185
diff
changeset
|
440 One megabyte zone can store about 8 thousand keys. |
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1185
diff
changeset
|
441 </para> |
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1185
diff
changeset
|
442 |
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1185
diff
changeset
|
443 <para> |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
444 Cached data that are not accessed during the time specified by the |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
445 <literal>inactive</literal> parameter get removed from the cache |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
446 regardless of their freshness. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
447 By default, <literal>inactive</literal> is set to 10 minutes. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
448 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
449 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
450 <para> |
966 | 451 The special “cache manager” process monitors the maximum cache size set |
452 by the <literal>max_size</literal> parameter. | |
453 When this size is exceeded, it removes the least recently used data. | |
1810
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
454 The data is removed in iterations configured by |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
455 <literal>manager_files</literal>, |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
456 <literal>manager_threshold</literal>, and |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
457 <literal>manager_sleep</literal> parameters (1.11.5). |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
458 During one iteration no more than <literal>manager_files</literal> items |
1812
35ec213c16cf
Removed extraneous whitespace.
Ruslan Ermilov <ru@nginx.com>
parents:
1810
diff
changeset
|
459 are deleted (by default, 100). |
1810
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
460 The duration of one iteration is limited by the |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
461 <literal>manager_threshold</literal> parameter (by default, 200 milliseconds). |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
462 Between iterations, a pause configured by the <literal>manager_sleep</literal> |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
463 parameter (by default, 50 milliseconds) is made. |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
464 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
465 |
508
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
466 <para> |
966 | 467 A minute after the start the special “cache loader” process is activated. |
468 It loads information about previously cached data stored on file system | |
508
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
469 into a cache zone. |
1810
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
470 The loading is also done in iterations. |
508
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
471 During one iteration no more than <literal>loader_files</literal> items |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
472 are loaded (by default, 100). |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
473 Besides, the duration of one iteration is limited by the |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
474 <literal>loader_threshold</literal> parameter (by default, 200 milliseconds). |
966 | 475 Between iterations, a pause configured by the <literal>loader_sleep</literal> |
476 parameter (by default, 50 milliseconds) is made. | |
508
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
477 </para> |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
478 |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
479 <para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
480 Additionally, |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
481 the following parameters are available as part of our |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
482 <commercial_version>commercial subscription</commercial_version>: |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
483 </para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
484 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
485 <para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
486 <list type="tag"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
487 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
488 <tag-name id="purger"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
489 <literal>purger</literal>=<literal>on</literal>|<literal>off</literal> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
490 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
491 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
492 Instructs whether cache entries that match a |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
493 <link id="fastcgi_cache_purge">wildcard key</link> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
494 will be removed from the disk by the cache purger (1.7.12). |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
495 Setting the parameter to <literal>on</literal> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
496 (default is <literal>off</literal>) |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
497 will activate the “cache purger” process that |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
498 permanently iterates through all cache entries |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
499 and deletes the entries that match the wildcard key. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
500 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
501 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
502 <tag-name id="purger_files"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
503 <literal>purger_files</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
504 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
505 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
506 Sets the number of items that will be scanned during one iteration (1.7.12). |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
507 By default, <literal>purger_files</literal> is set to 10. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
508 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
509 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
510 <tag-name id="purger_threshold"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
511 <literal>purger_threshold</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
512 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
513 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
514 Sets the duration of one iteration (1.7.12). |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
515 By default, <literal>purger_threshold</literal> is set to 50 milliseconds. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
516 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
517 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
518 <tag-name id="purger_sleep"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
519 <literal>purger_sleep</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
520 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
521 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
522 Sets a pause between iterations (1.7.12). |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
523 By default, <literal>purger_sleep</literal> is set to 50 milliseconds. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
524 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
525 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
526 </list> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
527 </para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
528 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
529 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
530 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
531 |
1028
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
532 <directive name="fastcgi_cache_purge"> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
533 <syntax>string ...</syntax> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
534 <default/> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
535 <context>http</context> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
536 <context>server</context> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
537 <context>location</context> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
538 <appeared-in>1.5.7</appeared-in> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
539 |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
540 <para> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
541 Defines conditions under which the request will be considered a cache |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
542 purge request. |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
543 If at least one value of the string parameters is not empty and is not equal |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
544 to “0” then the cache entry with a corresponding |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
545 <link id="fastcgi_cache_key">cache key</link> is removed. |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
546 The result of successful operation is indicated by returning |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
547 the <http-status code="204" text="No Content"/> response. |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
548 </para> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
549 |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
550 <para> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
551 If the <link id="fastcgi_cache_key">cache key</link> of a purge request ends |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
552 with an asterisk (“<literal>*</literal>”), all cache entries matching the |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
553 wildcard key will be removed from the cache. |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
554 However, these entries will remain on the disk until they are deleted |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
555 for either <link id="fastcgi_cache_path">inactivity</link>, |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
556 or processed by the <link id="purger">cache purger</link> (1.7.12), |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
557 or a client attempts to access them. |
1028
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
558 </para> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
559 |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
560 <para> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
561 Example configuration: |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
562 <example> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
563 fastcgi_cache_path /data/nginx/cache keys_zone=cache_zone:10m; |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
564 |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
565 map $request_method $purge_method { |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
566 PURGE 1; |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
567 default 0; |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
568 } |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
569 |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
570 server { |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
571 ... |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
572 location / { |
1185
f9c8336fe43c
Aligned configuration examples with fastcgi/scgi_cache_purge.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
573 fastcgi_pass backend; |
f9c8336fe43c
Aligned configuration examples with fastcgi/scgi_cache_purge.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
574 fastcgi_cache cache_zone; |
f9c8336fe43c
Aligned configuration examples with fastcgi/scgi_cache_purge.
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
575 fastcgi_cache_key $uri; |
1028
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
576 fastcgi_cache_purge $purge_method; |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
577 } |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
578 } |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
579 </example> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
580 <note> |
1128
1594ed379f1f
De-i18n'ed <commercial_version/>.
Ruslan Ermilov <ru@nginx.com>
parents:
1088
diff
changeset
|
581 This functionality is available as part of our |
1594ed379f1f
De-i18n'ed <commercial_version/>.
Ruslan Ermilov <ru@nginx.com>
parents:
1088
diff
changeset
|
582 <commercial_version>commercial subscription</commercial_version>. |
1028
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
583 </note> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
584 </para> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
585 |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
586 </directive> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
587 |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
588 |
1011
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
589 <directive name="fastcgi_cache_revalidate"> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
590 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
591 <default>off</default> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
592 <context>http</context> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
593 <context>server</context> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
594 <context>location</context> |
1015
af77dd40abeb
Documented the appearance of "fastcgi_" and "proxy_cache_revalidate".
Vladimir Homutov <vl@nginx.com>
parents:
1011
diff
changeset
|
595 <appeared-in>1.5.7</appeared-in> |
1011
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
596 |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
597 <para> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
598 Enables revalidation of expired cache items using conditional requests with |
1246
5be7716a5684
Documented If-None-Match in proxy_cache_revalidate and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1189
diff
changeset
|
599 the <header>If-Modified-Since</header> and <header>If-None-Match</header> |
5be7716a5684
Documented If-None-Match in proxy_cache_revalidate and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1189
diff
changeset
|
600 header fields. |
1011
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
601 </para> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
602 |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
603 </directive> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
604 |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
605 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
606 <directive name="fastcgi_cache_use_stale"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
607 <syntax> |
364 | 608 <literal>error</literal> | |
609 <literal>timeout</literal> | | |
610 <literal>invalid_header</literal> | | |
611 <literal>updating</literal> | | |
612 <literal>http_500</literal> | | |
613 <literal>http_503</literal> | | |
917
e26a18eb5ccd
Documented http_403 in proxy_next_upstream and friends.
Maxim Dounin <mdounin@mdounin.ru>
parents:
907
diff
changeset
|
614 <literal>http_403</literal> | |
364 | 615 <literal>http_404</literal> | |
616 <literal>off</literal> | |
617 ...</syntax> | |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
618 <default>off</default> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
619 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
620 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
621 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
622 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
623 <para> |
966 | 624 Determines in which cases a stale cached response can be used |
625 when an error occurs during communication with the FastCGI server. | |
626 The directive’s parameters match the parameters of the | |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
627 <link id="fastcgi_next_upstream"/> directive. |
505
837bcf62b628
Emphasized on what the "updating" parameter of the "fastcgi_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
498
diff
changeset
|
628 </para> |
837bcf62b628
Emphasized on what the "updating" parameter of the "fastcgi_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
498
diff
changeset
|
629 |
837bcf62b628
Emphasized on what the "updating" parameter of the "fastcgi_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
498
diff
changeset
|
630 <para> |
1542
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
631 The <literal>error</literal> parameter also permits |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
632 using a stale cached response if a FastCGI server to process a request |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
633 cannot be selected. |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
634 </para> |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
635 |
1909
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
636 <para id="fastcgi_cache_use_stale_updating"> |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
637 Additionally, the <literal>updating</literal> parameter permits |
966 | 638 using a stale cached response if it is currently being updated. |
639 This allows minimizing the number of accesses to FastCGI servers | |
505
837bcf62b628
Emphasized on what the "updating" parameter of the "fastcgi_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
498
diff
changeset
|
640 when updating cached data. |
1912
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
641 </para> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
642 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
643 <para> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
644 Using a stale cached response |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
645 can also be enabled directly in the response header |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
646 for a specified number of seconds after the response became stale (1.11.10). |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
647 This has lower priority than using the directive parameters. |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
648 <list type="bullet" compact="no"> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
649 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
650 <listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
651 The |
1910
41cf2c2d8c5c
Cache: support for stale-while-revalidate and stale-if-error.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1909
diff
changeset
|
652 “<link url="https://tools.ietf.org/html/rfc5861#section-3">stale-while-revalidate</link>” |
1912
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
653 extension of the <header>Cache-Control</header> header field permits |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
654 using a stale cached response if it is currently being updated. |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
655 </listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
656 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
657 <listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
658 The |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
659 “<link url="https://tools.ietf.org/html/rfc5861#section-4">stale-if-error</link>” |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
660 extension of the <header>Cache-Control</header> header field permits |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
661 using a stale cached response in case of an error. |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
662 </listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
663 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
664 </list> |
505
837bcf62b628
Emphasized on what the "updating" parameter of the "fastcgi_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
498
diff
changeset
|
665 </para> |
837bcf62b628
Emphasized on what the "updating" parameter of the "fastcgi_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
498
diff
changeset
|
666 |
837bcf62b628
Emphasized on what the "updating" parameter of the "fastcgi_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
498
diff
changeset
|
667 <para> |
509 | 668 To minimize the number of accesses to FastCGI servers when |
505
837bcf62b628
Emphasized on what the "updating" parameter of the "fastcgi_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
498
diff
changeset
|
669 populating a new cache element, the <link id="fastcgi_cache_lock"/> |
837bcf62b628
Emphasized on what the "updating" parameter of the "fastcgi_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
498
diff
changeset
|
670 directive can be used. |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
671 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
672 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
673 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
674 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
675 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
676 <directive name="fastcgi_cache_valid"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
677 <syntax>[<value>code</value> ...] <value>time</value></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
678 <default/> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
679 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
680 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
681 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
682 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
683 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
684 Sets caching time for different response codes. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
685 For example, the following directives |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
686 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
687 fastcgi_cache_valid 200 302 10m; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
688 fastcgi_cache_valid 404 1m; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
689 </example> |
966 | 690 set 10 minutes of caching for responses with codes 200 and 302 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
691 and 1 minute for responses with code 404. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
692 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
693 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
694 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
695 If only caching <value>time</value> is specified |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
696 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
697 fastcgi_cache_valid 5m; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
698 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
699 then only 200, 301, and 302 responses are cached. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
700 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
701 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
702 <para> |
966 | 703 In addition, the <literal>any</literal> parameter can be specified |
704 to cache any responses: | |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
705 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
706 fastcgi_cache_valid 200 302 10m; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
707 fastcgi_cache_valid 301 1h; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
708 fastcgi_cache_valid any 1m; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
709 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
710 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
711 |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
712 <para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
713 Parameters of caching can also be set directly |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
714 in the response header. |
966 | 715 This has higher priority than setting of caching time using the directive. |
1349
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
716 <list type="bullet" compact="no"> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
717 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
718 <listitem> |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
719 The <header>X-Accel-Expires</header> header field sets caching time of a |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
720 response in seconds. |
966 | 721 The zero value disables caching for a response. |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
722 If the value starts with the <literal>@</literal> prefix, it sets an absolute |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
723 time in seconds since Epoch, up to which the response may be cached. |
1349
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
724 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
725 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
726 <listitem> |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
727 If the header does not include the <header>X-Accel-Expires</header> field, |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
728 parameters of caching may be set in the header fields |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
729 <header>Expires</header> or <header>Cache-Control</header>. |
1349
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
730 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
731 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
732 <listitem> |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
733 If the header includes the <header>Set-Cookie</header> field, such a |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
734 response will not be cached. |
1349
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
735 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
736 |
1353
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
737 <listitem> |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
738 If the header includes the <header>Vary</header> field |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
739 with the special value “<literal>*</literal>”, such a |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
740 response will not be cached (1.7.7). |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
741 If the header includes the <header>Vary</header> field |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
742 with another value, such a response will be cached |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
743 taking into account the corresponding request header fields (1.7.7). |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
744 </listitem> |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
745 |
1349
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
746 </list> |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
747 Processing of one or more of these response header fields can be disabled |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
748 using the <link id="fastcgi_ignore_headers"/> directive. |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
749 </para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
750 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
751 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
752 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
753 |
862
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
754 <directive name="fastcgi_catch_stderr"> |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
755 <syntax><value>string</value></syntax> |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
756 <default/> |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
757 <context>http</context> |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
758 <context>server</context> |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
759 <context>location</context> |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
760 |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
761 <para> |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
762 Sets a string to search for in the error stream of a response |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
763 received from a FastCGI server. |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
764 If the <value>string</value> is found then it is considered that the FastCGI |
966 | 765 server has returned an <link id="fastcgi_next_upstream">invalid response</link>. |
766 This allows handling application errors in nginx, for example: | |
862
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
767 <example> |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
768 location /php { |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
769 fastcgi_pass backend:9000; |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
770 ... |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
771 fastcgi_catch_stderr "PHP Fatal error"; |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
772 fastcgi_next_upstream error timeout invalid_header; |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
773 } |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
774 </example> |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
775 </para> |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
776 |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
777 </directive> |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
778 |
6a40b8e7219a
Documented the "fastcgi_catch_stderr" directive.
Homutov Vladimir <vl@nginx.com>
parents:
815
diff
changeset
|
779 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
780 <directive name="fastcgi_connect_timeout"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
781 <syntax><value>time</value></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
782 <default>60s</default> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
783 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
784 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
785 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
786 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
787 <para> |
966 | 788 Defines a timeout for establishing a connection with a FastCGI server. |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
789 It should be noted that this timeout cannot usually exceed 75 seconds. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
790 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
791 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
792 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
793 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
794 |
1338 | 795 <directive name="fastcgi_force_ranges"> |
1337
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
796 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
797 <default>off</default> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
798 <context>http</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
799 <context>server</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
800 <context>location</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
801 <appeared-in>1.7.7</appeared-in> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
802 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
803 <para> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
804 Enables byte-range support |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
805 for both cached and uncached responses from the FastCGI server |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
806 regardless of the <header>Accept-Ranges</header> field in these responses. |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
807 </para> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
808 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
809 </directive> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
810 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
811 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
812 <directive name="fastcgi_hide_header"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
813 <syntax><value>field</value></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
814 <default/> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
815 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
816 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
817 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
818 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
819 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
820 By default, |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
821 nginx does not pass the header fields <header>Status</header> and |
966 | 822 <header>X-Accel-...</header> from the response of a FastCGI |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
823 server to a client. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
824 The <literal>fastcgi_hide_header</literal> directive sets additional fields |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
825 that will not be passed. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
826 If, on the contrary, the passing of fields needs to be permitted, |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
827 the <link id="fastcgi_pass_header"/> directive can be used. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
828 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
829 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
830 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
831 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
832 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
833 <directive name="fastcgi_ignore_client_abort"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
834 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
835 <default>off</default> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
836 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
837 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
838 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
839 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
840 <para> |
966 | 841 Determines whether the connection with a FastCGI server should be |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
842 closed when a client closes the connection without waiting |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
843 for a response. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
844 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
845 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
846 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
847 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
848 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
849 <directive name="fastcgi_ignore_headers"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
850 <syntax><value>field</value> ...</syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
851 <default/> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
852 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
853 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
854 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
855 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
856 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
857 Disables processing of certain response header fields from the FastCGI server. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
858 The following fields can be ignored: <header>X-Accel-Redirect</header>, |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
859 <header>X-Accel-Expires</header>, <header>X-Accel-Limit-Rate</header> (1.1.6), |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
860 <header>X-Accel-Buffering</header> (1.1.6), |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
861 <header>X-Accel-Charset</header> (1.1.6), <header>Expires</header>, |
1345
da296387cdac
Documented the Vary support in proxy_ignore_headers and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1343
diff
changeset
|
862 <header>Cache-Control</header>, <header>Set-Cookie</header> (0.8.44), |
da296387cdac
Documented the Vary support in proxy_ignore_headers and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1343
diff
changeset
|
863 and <header>Vary</header> (1.7.7). |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
864 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
865 |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
866 <para> |
966 | 867 If not disabled, processing of these header fields has the following |
868 effect: | |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
869 <list type="bullet" compact="no"> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
870 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
871 <listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
872 <header>X-Accel-Expires</header>, <header>Expires</header>, |
1345
da296387cdac
Documented the Vary support in proxy_ignore_headers and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1343
diff
changeset
|
873 <header>Cache-Control</header>, <header>Set-Cookie</header>, |
da296387cdac
Documented the Vary support in proxy_ignore_headers and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1343
diff
changeset
|
874 and <header>Vary</header> |
966 | 875 set the parameters of response <link id="fastcgi_cache_valid">caching</link>; |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
876 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
877 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
878 <listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
879 <header>X-Accel-Redirect</header> performs an |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
880 <link doc="ngx_http_core_module.xml" id="internal">internal |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
881 redirect</link> to the specified URI; |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
882 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
883 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
884 <listitem> |
966 | 885 <header>X-Accel-Limit-Rate</header> sets the |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
886 <link doc="ngx_http_core_module.xml" id="limit_rate">rate |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
887 limit</link> for transmission of a response to a client; |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
888 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
889 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
890 <listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
891 <header>X-Accel-Buffering</header> enables or disables |
995
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
892 <link id="fastcgi_buffering">buffering</link> of a response; |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
893 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
894 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
895 <listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
896 <header>X-Accel-Charset</header> sets the desired |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
897 <link doc="ngx_http_charset_module.xml" id="charset"/> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
898 of a response. |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
899 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
900 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
901 </list> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
902 </para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
505
diff
changeset
|
903 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
904 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
905 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
906 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
907 <directive name="fastcgi_index"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
908 <syntax><value>name</value></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
909 <default/> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
910 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
911 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
912 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
913 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
914 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
915 Sets a file name that will be appended after a URI that ends with |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
916 a slash, in the value of the <var>$fastcgi_script_name</var> variable. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
917 For example, with these settings |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
918 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
919 fastcgi_index index.php; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
920 fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
921 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
922 and the “<literal>/page.php</literal>” request, |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
923 the <literal>SCRIPT_FILENAME</literal> parameter will be equal to |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
924 “<literal>/home/www/scripts/php/page.php</literal>”, |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
925 and with the “<literal>/</literal>” request it will be equal to |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
926 “<literal>/home/www/scripts/php/index.php</literal>”. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
927 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
928 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
929 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
930 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
931 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
932 <directive name="fastcgi_intercept_errors"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
933 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
934 <default>off</default> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
935 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
936 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
937 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
938 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
939 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
940 Determines whether FastCGI server responses with codes greater than or equal |
1803
621d0c682113
Clarified description of proxy_intercept_errors and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1796
diff
changeset
|
941 to 300 should be passed to a client |
621d0c682113
Clarified description of proxy_intercept_errors and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1796
diff
changeset
|
942 or be intercepted and redirected to nginx for processing |
966 | 943 with the <link doc="ngx_http_core_module.xml" id="error_page"/> directive. |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
944 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
945 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
946 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
947 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
948 |
316
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
949 <directive name="fastcgi_keep_conn"> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
950 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
951 <default>off</default> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
952 <context>http</context> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
953 <context>server</context> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
954 <context>location</context> |
498
65843513cff5
Documented that "fastcgi_keep_conn" appeared in 1.1.4.
Ruslan Ermilov <ru@nginx.com>
parents:
411
diff
changeset
|
955 <appeared-in>1.1.4</appeared-in> |
316
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
956 |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
957 <para> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
958 By default, a FastCGI server will close a connection right after |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
959 sending the response. |
966 | 960 However, when this directive is set to the value <literal>on</literal>, |
961 nginx will instruct a FastCGI server to keep connections open. | |
962 This is necessary, in particular, for | |
316
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
963 <link doc="ngx_http_upstream_module.xml" id="keepalive"/> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
964 connections to FastCGI servers to function. |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
965 </para> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
966 |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
967 </directive> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
968 |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
969 |
1343
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
970 <directive name="fastcgi_limit_rate"> |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
971 <syntax><value>rate</value></syntax> |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
972 <default>0</default> |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
973 <context>http</context> |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
974 <context>server</context> |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
975 <context>location</context> |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
976 <appeared-in>1.7.7</appeared-in> |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
977 |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
978 <para> |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
979 Limits the speed of reading the response from the FastCGI server. |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
980 The <value>rate</value> is specified in bytes per second. |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
981 The zero value disables rate limiting. |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
982 The limit is set per a request, and so if nginx simultaneously opens |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
983 two connections to the FastCFI server, |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
984 the overall rate will be twice as much as the specified limit. |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
985 The limitation works only if |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
986 <link id="fastcgi_buffering">buffering</link> of responses from the FastCGI |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
987 server is enabled. |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
988 </para> |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
989 |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
990 </directive> |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
991 |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
992 |
411
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
993 <directive name="fastcgi_max_temp_file_size"> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
994 <syntax><value>size</value></syntax> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
995 <default>1024m</default> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
996 <context>http</context> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
997 <context>server</context> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
998 <context>location</context> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
999 |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1000 <para> |
995
c5ccf511346a
Documented the "fastcgi_buffering" directive.
Ruslan Ermilov <ru@nginx.com>
parents:
966
diff
changeset
|
1001 When <link id="fastcgi_buffering">buffering</link> of responses from the FastCGI |
1153
4e20e4f8f49b
Finished truncation of "memory buffers" to just "buffers".
Ruslan Ermilov <ru@nginx.com>
parents:
1151
diff
changeset
|
1002 server is enabled, and the whole response does not fit into the buffers |
411
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1003 set by the <link id="fastcgi_buffer_size"/> and <link id="fastcgi_buffers"/> |
966 | 1004 directives, a part of the response can be saved to a temporary file. |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
1005 This directive sets the maximum <value>size</value> of the temporary file. |
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
1006 The size of data written to the temporary file at a time is set |
411
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1007 by the <link id="fastcgi_temp_file_write_size"/> directive. |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1008 </para> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1009 |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1010 <para> |
966 | 1011 The zero value disables buffering of responses to temporary files. |
411
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1012 </para> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1013 |
1352
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1014 <para> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1015 <note> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1016 This restriction does not apply to responses |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1017 that will be <link id="fastcgi_cache">cached</link> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1018 or <link id="fastcgi_store">stored</link> on disk. |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1019 </note> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1020 </para> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1021 |
411
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1022 </directive> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1023 |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1024 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1025 <directive name="fastcgi_next_upstream"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1026 <syntax> |
364 | 1027 <literal>error</literal> | |
1028 <literal>timeout</literal> | | |
1029 <literal>invalid_header</literal> | | |
1030 <literal>http_500</literal> | | |
1031 <literal>http_503</literal> | | |
917
e26a18eb5ccd
Documented http_403 in proxy_next_upstream and friends.
Maxim Dounin <mdounin@mdounin.ru>
parents:
907
diff
changeset
|
1032 <literal>http_403</literal> | |
364 | 1033 <literal>http_404</literal> | |
1669
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1034 <literal>non_idempotent</literal> | |
364 | 1035 <literal>off</literal> |
1036 ...</syntax> | |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1037 <default>error timeout</default> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1038 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1039 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1040 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1041 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1042 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1043 Specifies in which cases a request should be passed to the next server: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1044 <list type="tag"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1045 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1046 <tag-name><literal>error</literal></tag-name> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1047 <tag-desc>an error occurred while establishing a connection with the |
966 | 1048 server, passing a request to it, or reading the response header;</tag-desc> |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1049 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1050 <tag-name><literal>timeout</literal></tag-name> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1051 <tag-desc>a timeout has occurred while establishing a connection with the |
966 | 1052 server, passing a request to it, or reading the response header;</tag-desc> |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1053 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1054 <tag-name><literal>invalid_header</literal></tag-name> |
966 | 1055 <tag-desc>a server returned an empty or invalid response;</tag-desc> |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1056 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1057 <tag-name><literal>http_500</literal></tag-name> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1058 <tag-desc>a server returned a response with the code 500;</tag-desc> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1059 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1060 <tag-name><literal>http_503</literal></tag-name> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1061 <tag-desc>a server returned a response with the code 503;</tag-desc> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1062 |
917
e26a18eb5ccd
Documented http_403 in proxy_next_upstream and friends.
Maxim Dounin <mdounin@mdounin.ru>
parents:
907
diff
changeset
|
1063 <tag-name><literal>http_403</literal></tag-name> |
e26a18eb5ccd
Documented http_403 in proxy_next_upstream and friends.
Maxim Dounin <mdounin@mdounin.ru>
parents:
907
diff
changeset
|
1064 <tag-desc>a server returned a response with the code 403;</tag-desc> |
e26a18eb5ccd
Documented http_403 in proxy_next_upstream and friends.
Maxim Dounin <mdounin@mdounin.ru>
parents:
907
diff
changeset
|
1065 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1066 <tag-name><literal>http_404</literal></tag-name> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1067 <tag-desc>a server returned a response with the code 404;</tag-desc> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1068 |
1669
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1069 <tag-name id="non_idempotent"><literal>non_idempotent</literal></tag-name> |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1070 <tag-desc>normally, requests with a |
1923
66a30a380fba
Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents:
1912
diff
changeset
|
1071 <link url="https://tools.ietf.org/html/rfc7231#section-4.2.2">non-idempotent</link> |
1669
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1072 method |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1073 (<literal>POST</literal>, <literal>LOCK</literal>, <literal>PATCH</literal>) |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1074 are not passed to the next server |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1075 if a request has been sent to an upstream server (1.9.13); |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1076 enabling this option explicitly allows retrying such requests; |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1077 </tag-desc> |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1078 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1079 <tag-name><literal>off</literal></tag-name> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1080 <tag-desc>disables passing a request to the next server.</tag-desc> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1081 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1082 </list> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1083 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1084 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1085 <para> |
966 | 1086 One should bear in mind that passing a request to the next server is |
1087 only possible if nothing has been sent to a client yet. | |
1088 That is, if an error or timeout occurs in the middle of the | |
1089 transferring of a response, fixing this is impossible. | |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1090 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1091 |
942
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1092 <para> |
1289
57fc39924d42
Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1246
diff
changeset
|
1093 The directive also defines what is considered an |
57fc39924d42
Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1246
diff
changeset
|
1094 <link doc="ngx_http_upstream_module.xml" id="max_fails">unsuccessful |
57fc39924d42
Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1246
diff
changeset
|
1095 attempt</link> of communication with a server. |
942
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1096 The cases of <literal>error</literal>, <literal>timeout</literal> and |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1097 <literal>invalid_header</literal> are always considered unsuccessful attempts, |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1098 even if they are not specified in the directive. |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1099 The cases of <literal>http_500</literal> and <literal>http_503</literal> are |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1100 considered unsuccessful attempts only if they are specified in the directive. |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1101 The cases of <literal>http_403</literal> and <literal>http_404</literal> |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1102 are never considered unsuccessful attempts. |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1103 </para> |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1104 |
1290
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1105 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1106 Passing a request to the next server can be limited by |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1107 <link id="fastcgi_next_upstream_tries">the number of tries</link> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1108 and by <link id="fastcgi_next_upstream_timeout">time</link>. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1109 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1110 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1111 </directive> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1112 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1113 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1114 <directive name="fastcgi_next_upstream_timeout"> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1115 <syntax><value>time</value></syntax> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1116 <default>0</default> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1117 <context>http</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1118 <context>server</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1119 <context>location</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1120 <appeared-in>1.7.5</appeared-in> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1121 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1122 <para> |
1672
9c98c4498f08
Rephrased the "proxy_next_upstream_timeout" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1669
diff
changeset
|
1123 Limits the time during which a request can be passed to the |
1290
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1124 <link id="fastcgi_next_upstream">next server</link>. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1125 The <literal>0</literal> value turns off this limitation. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1126 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1127 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1128 </directive> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1129 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1130 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1131 <directive name="fastcgi_next_upstream_tries"> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1132 <syntax><value>number</value></syntax> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1133 <default>0</default> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1134 <context>http</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1135 <context>server</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1136 <context>location</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1137 <appeared-in>1.7.5</appeared-in> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1138 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1139 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1140 Limits the number of possible tries for passing a request to the |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1141 <link id="fastcgi_next_upstream">next server</link>. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1142 The <literal>0</literal> value turns off this limitation. |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1143 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1144 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1145 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1146 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1147 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1148 <directive name="fastcgi_no_cache"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1149 <syntax><value>string</value> ...</syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1150 <default/> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1151 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1152 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1153 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1154 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1155 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1156 Defines conditions under which the response will not be saved to a cache. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1157 If at least one value of the string parameters is not empty and is not |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1158 equal to “0” then the response will not be saved: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1159 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1160 fastcgi_no_cache $cookie_nocache $arg_nocache$arg_comment; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1161 fastcgi_no_cache $http_pragma $http_authorization; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1162 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1163 Can be used along with the <link id="fastcgi_cache_bypass"/> directive. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1164 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1165 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1166 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1167 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1168 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1169 <directive name="fastcgi_param"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1170 <syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1171 <value>parameter</value> <value>value</value> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1172 [<literal>if_not_empty</literal>]</syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1173 <default/> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1174 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1175 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1176 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1177 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1178 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1179 Sets a <value>parameter</value> that should be passed to the FastCGI server. |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
1180 The <value>value</value> can contain text, variables, and their combination. |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1181 These directives are inherited from the previous level if and |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1182 only if there are no |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1183 <literal>fastcgi_param</literal> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1184 directives defined on the current level. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1185 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1186 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1187 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1188 The following example shows the minimum required settings for PHP: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1189 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1190 fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1191 fastcgi_param QUERY_STRING $query_string; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1192 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1193 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1194 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1195 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1196 The <literal>SCRIPT_FILENAME</literal> parameter is used in PHP for |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1197 determining the script name, and the <literal>QUERY_STRING</literal> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1198 parameter is used to pass request parameters. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1199 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1200 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1201 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1202 For scripts that process <literal>POST</literal> requests, the |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1203 following three parameters are also required: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1204 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1205 fastcgi_param REQUEST_METHOD $request_method; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1206 fastcgi_param CONTENT_TYPE $content_type; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1207 fastcgi_param CONTENT_LENGTH $content_length; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1208 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1209 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1210 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1211 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1212 If PHP was built with the <literal>--enable-force-cgi-redirect</literal> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1213 configuration parameter, the <literal>REDIRECT_STATUS</literal> parameter |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1214 should also be passed with the value “200”: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1215 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1216 fastcgi_param REDIRECT_STATUS 200; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1217 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1218 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1219 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1220 <para> |
1731
ae6bdb65ca7f
Corrected article in fastcgi_param and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1696
diff
changeset
|
1221 If the directive is specified with <literal>if_not_empty</literal> (1.1.11) then |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1222 such a parameter will not be passed to the server until its value is not empty: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1223 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1224 fastcgi_param HTTPS $https if_not_empty; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1225 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1226 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1227 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1228 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1229 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1230 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1231 <directive name="fastcgi_pass"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1232 <syntax><value>address</value></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1233 <default/> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1234 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1235 <context>if in location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1236 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1237 <para> |
966 | 1238 Sets the address of a FastCGI server. |
1239 The address can be specified as a domain name or IP address, | |
1620
a225fa77389a
Port in fastcgi_pass, scgi_pass, and uwsgi_pass is not optional.
Ruslan Ermilov <ru@nginx.com>
parents:
1582
diff
changeset
|
1240 and a port: |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1241 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1242 fastcgi_pass localhost:9000; |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1243 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1244 or as a UNIX-domain socket path: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1245 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1246 fastcgi_pass unix:/tmp/fastcgi.socket; |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1247 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1248 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1249 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1250 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1251 If a domain name resolves to several addresses, all of them will be |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1252 used in a round-robin fashion. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1253 In addition, an address can be specified as a |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1254 <link doc="ngx_http_upstream_module.xml">server group</link>. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1255 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1256 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1257 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1258 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1259 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1260 <directive name="fastcgi_pass_header"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1261 <syntax><value>field</value></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1262 <default/> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1263 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1264 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1265 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1266 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1267 <para> |
966 | 1268 Permits passing <link id="fastcgi_hide_header">otherwise disabled</link> header |
1269 fields from a FastCGI server to a client. | |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1270 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1271 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1272 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1273 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1274 |
793
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1275 <directive name="fastcgi_pass_request_body"> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1276 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1277 <default>on</default> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1278 <context>http</context> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1279 <context>server</context> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1280 <context>location</context> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1281 |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1282 <para> |
966 | 1283 Indicates whether the original request body is passed |
793
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1284 to the FastCGI server. |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1285 See also the <link id="fastcgi_pass_request_headers"/> directive. |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1286 </para> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1287 |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1288 </directive> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1289 |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1290 |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1291 <directive name="fastcgi_pass_request_headers"> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1292 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1293 <default>on</default> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1294 <context>http</context> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1295 <context>server</context> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1296 <context>location</context> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1297 |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1298 <para> |
966 | 1299 Indicates whether the header fields of the original request are passed |
1300 to the FastCGI server. | |
793
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1301 See also the <link id="fastcgi_pass_request_body"/> directive. |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1302 </para> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1303 |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1304 </directive> |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1305 |
9104a921d940
Documented "fastcgi_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1306 |
1524
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1307 <directive name="fastcgi_read_timeout"> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1308 <syntax><value>time</value></syntax> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1309 <default>60s</default> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1310 <context>http</context> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1311 <context>server</context> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1312 <context>location</context> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1313 |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1314 <para> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1315 Defines a timeout for reading a response from the FastCGI server. |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1316 The timeout is set only between two successive read operations, |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1317 not for the transmission of the whole response. |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1318 If the FastCGI server does not transmit anything within this time, |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1319 the connection is closed. |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1320 </para> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1321 |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1322 </directive> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1323 |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1324 |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1325 <directive name="fastcgi_request_buffering"> |
1659
680cbf783efe
Fixed some misuses of "value".
Ruslan Ermilov <ru@nginx.com>
parents:
1620
diff
changeset
|
1326 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1327 <default>on</default> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1328 <context>http</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1329 <context>server</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1330 <context>location</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1331 <appeared-in>1.7.11</appeared-in> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1332 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1333 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1334 Enables or disables buffering of a client request body. |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1335 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1336 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1337 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1338 When buffering is enabled, the entire request body is |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1339 <link doc="ngx_http_core_module.xml" id="client_body_buffer_size">read</link> |
1440
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1340 from the client before sending the request to a FastCGI server. |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1341 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1342 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1343 <para> |
1440
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1344 When buffering is disabled, the request body is sent to the FastCGI server |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1345 immediately as it is received. |
1440
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1346 In this case, the request cannot be passed to the |
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1347 <link id="fastcgi_next_upstream">next server</link> |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1348 if nginx already started sending the request body. |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1349 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1350 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1351 </directive> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1352 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1384
diff
changeset
|
1353 |
773
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1354 <directive name="fastcgi_send_lowat"> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1355 <syntax><value>size</value></syntax> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1356 <default>0</default> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1357 <context>http</context> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1358 <context>server</context> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1359 <context>location</context> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1360 |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1361 <para> |
966 | 1362 If the directive is set to a non-zero value, nginx will try to |
1363 minimize the number | |
773
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1364 of send operations on outgoing connections to a FastCGI server by using either |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1365 <c-def>NOTE_LOWAT</c-def> flag of the |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1366 <link doc="../events.xml" id="kqueue"/> method, |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1367 or the <c-def>SO_SNDLOWAT</c-def> socket option, |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1368 with the specified <value>size</value>. |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1369 </para> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1370 |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1371 <para> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1372 This directive is ignored on Linux, Solaris, and Windows. |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1373 </para> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1374 |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1375 </directive> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1376 |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1377 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1378 <directive name="fastcgi_send_timeout"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1379 <syntax><value>time</value></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1380 <default>60s</default> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1381 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1382 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1383 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1384 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1385 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1386 Sets a timeout for transmitting a request to the FastCGI server. |
1149
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1146
diff
changeset
|
1387 The timeout is set only between two successive write operations, |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1388 not for the transmission of the whole request. |
1149
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1146
diff
changeset
|
1389 If the FastCGI server does not receive anything within this time, |
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1146
diff
changeset
|
1390 the connection is closed. |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1391 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1392 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1393 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1394 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1395 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1396 <directive name="fastcgi_split_path_info"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1397 <syntax><value>regex</value></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1398 <default/> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1399 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1400 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1401 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1402 Defines a regular expression that captures a value for the |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1403 <var>$fastcgi_path_info</var> variable. |
1149
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1146
diff
changeset
|
1404 The regular expression should have two captures: the first becomes |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1405 a value of the <var>$fastcgi_script_name</var> variable, the second |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1406 becomes a value of the <var>$fastcgi_path_info</var> variable. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1407 For example, with these settings |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1408 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1409 location ~ ^(.+\.php)(.*)$ { |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1410 fastcgi_split_path_info ^(.+\.php)(.*)$; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1411 fastcgi_param SCRIPT_FILENAME /path/to/php$fastcgi_script_name; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1412 fastcgi_param PATH_INFO $fastcgi_path_info; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1413 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1414 and the “<literal>/show.php/article/0001</literal>” request, |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1415 the <literal>SCRIPT_FILENAME</literal> parameter will be equal to |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1416 “<literal>/path/to/php/show.php</literal>”, and the |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1417 <literal>PATH_INFO</literal> parameter will be equal to |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1418 “<literal>/article/0001</literal>”. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1419 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1420 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1421 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1422 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1423 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1424 <directive name="fastcgi_store"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1425 <syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1426 <literal>on</literal> | |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1427 <literal>off</literal> | |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1428 <value>string</value></syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1429 <default>off</default> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1430 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1431 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1432 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1433 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1434 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1435 Enables saving of files to a disk. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1436 The <literal>on</literal> parameter saves files with paths |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1437 corresponding to the directives |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1438 <link doc="ngx_http_core_module.xml" id="alias"/> or |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1439 <link doc="ngx_http_core_module.xml" id="root"/>. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1440 The <literal>off</literal> parameter disables saving of files. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1441 In addition, the file name can be set explicitly using the |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1442 <value>string</value> with variables: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1443 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1444 fastcgi_store /data/www$original_uri; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1445 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1446 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1447 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1448 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1449 The modification time of files is set according to the received |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1450 <header>Last-Modified</header> response header field. |
1149
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1146
diff
changeset
|
1451 The response is first written to a temporary file, |
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1146
diff
changeset
|
1452 and then the file is renamed. |
966 | 1453 Starting from version 0.8.9, temporary files and the persistent store |
1454 can be put on different file systems. | |
1455 However, be aware that in this case a file is copied | |
1456 across two file systems instead of the cheap renaming operation. | |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1457 It is thus recommended that for any given location both saved files and a |
966 | 1458 directory holding temporary files, set by the <link id="fastcgi_temp_path"/> |
1459 directive, are put on the same file system. | |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1460 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1461 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1462 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1463 This directive can be used to create local copies of static unchangeable |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1464 files, e.g.: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1465 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1466 location /images/ { |
1005
2275611970dd
Removed open_file_cache_errors from proxy_store examples.
Maxim Dounin <mdounin@mdounin.ru>
parents:
995
diff
changeset
|
1467 root /data/www; |
2275611970dd
Removed open_file_cache_errors from proxy_store examples.
Maxim Dounin <mdounin@mdounin.ru>
parents:
995
diff
changeset
|
1468 error_page 404 = /fetch$uri; |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1469 } |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1470 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1471 location /fetch/ { |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1472 internal; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1473 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1474 fastcgi_pass backend:9000; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1475 ... |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1476 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1477 fastcgi_store on; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1478 fastcgi_store_access user:rw group:rw all:r; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1479 fastcgi_temp_path /data/temp; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1480 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1481 alias /data/www/; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1482 } |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1483 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1484 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1485 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1486 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1487 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1488 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1489 <directive name="fastcgi_store_access"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1490 <syntax><value>users</value>:<value>permissions</value> ...</syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1491 <default>user:rw</default> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1492 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1493 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1494 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1495 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1496 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1497 Sets access permissions for newly created files and directories, e.g.: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1498 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1499 fastcgi_store_access user:rw group:rw all:r; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1500 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1501 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1502 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1503 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1504 If any <literal>group</literal> or <literal>all</literal> access permissions |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1505 are specified then <literal>user</literal> permissions may be omitted: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1506 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1507 fastcgi_store_access group:rw all:r; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1508 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1509 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1510 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1511 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1512 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1513 |
411
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1514 <directive name="fastcgi_temp_file_write_size"> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1515 <syntax><value>size</value></syntax> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1516 <default>8k|16k</default> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1517 <context>http</context> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1518 <context>server</context> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1519 <context>location</context> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1520 |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1521 <para> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1522 Limits the <value>size</value> of data written to a temporary file |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1523 at a time, when buffering of responses from the FastCGI server |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1524 to temporary files is enabled. |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1525 By default, <value>size</value> is limited by two buffers set by the |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1526 <link id="fastcgi_buffer_size"/> and <link id="fastcgi_buffers"/> directives. |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1527 The maximum size of a temporary file is set by the |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1528 <link id="fastcgi_max_temp_file_size"/> directive. |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1529 </para> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1530 |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1531 </directive> |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1532 |
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1533 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1534 <directive name="fastcgi_temp_path"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1535 <syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1536 <value>path</value> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1537 [<value>level1</value> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1538 [<value>level2</value> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1539 [<value>level3</value>]]]</syntax> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1540 <default>fastcgi_temp</default> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1541 <context>http</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1542 <context>server</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1543 <context>location</context> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1544 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1545 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1546 Defines a directory for storing temporary files |
411
f8248d0e3c8f
Documented the following directives: fastcgi_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1547 with data received from FastCGI servers. |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1548 Up to three-level subdirectory hierarchy can be used underneath the specified |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1549 directory. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1550 For example, in the following configuration |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1551 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1552 fastcgi_temp_path /spool/nginx/fastcgi_temp 1 2; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1553 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1554 a temporary file might look like this: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1555 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1556 /spool/nginx/fastcgi_temp/<emphasis>7</emphasis>/<emphasis>45</emphasis>/00000123<emphasis>457</emphasis> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1557 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1558 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1559 |
1384
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1560 <para> |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1561 See also the <literal>use_temp_path</literal> parameter of the |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1562 <link id="fastcgi_cache_path"/> directive. |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1563 </para> |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
1564 |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1565 </directive> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1566 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1567 </section> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1568 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1569 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1570 <section id="parameters" name="Parameters Passed to a FastCGI Server"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1571 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1572 <para> |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
1573 HTTP request header fields are passed to a FastCGI server as parameters. |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1574 In applications and scripts running as FastCGI servers, |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1575 these parameters are usually made available as environment variables. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1576 For example, the <header>User-Agent</header> header field is passed as the |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1577 <literal>HTTP_USER_AGENT</literal> parameter. |
966 | 1578 In addition to HTTP request header fields, it is possible to pass arbitrary |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1579 parameters using the <link id="fastcgi_param"/> directive. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1580 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1581 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1582 </section> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1583 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1584 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1585 <section id="variables" name="Embedded Variables"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1586 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1587 <para> |
364 | 1588 The <literal>ngx_http_fastcgi_module</literal> module supports embedded |
1589 variables that can be used to set parameters using the | |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1590 <link id="fastcgi_param"/> directive: |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1591 <list type="tag"> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1592 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1153
diff
changeset
|
1593 <tag-name id="var_fastcgi_script_name"><var>$fastcgi_script_name</var> |
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1153
diff
changeset
|
1594 </tag-name> |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1595 <tag-desc> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1596 request URI or, if a URI ends with a slash, request URI with an index file |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1597 name configured by the <link id="fastcgi_index"/> directive appended to it. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1598 This variable can be used to set the |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1599 <literal>SCRIPT_FILENAME</literal> and <literal>PATH_TRANSLATED</literal> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1600 parameters that determine the script name in PHP. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1601 For example, for the “<literal>/info/</literal>” request with the |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1602 following directives |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1603 <example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1604 fastcgi_index index.php; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1605 fastcgi_param SCRIPT_FILENAME /home/www/scripts/php$fastcgi_script_name; |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1606 </example> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1607 the <literal>SCRIPT_FILENAME</literal> parameter will be equal to |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1608 “<literal>/home/www/scripts/php/info/index.php</literal>”. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1609 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1610 <para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1611 When using the <link id="fastcgi_split_path_info"/> directive, |
966 | 1612 the <var>$fastcgi_script_name</var> variable equals the value of |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1613 the first capture set by the directive. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1614 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1615 </tag-desc> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1616 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1153
diff
changeset
|
1617 <tag-name id="var_fastcgi_path_info"><var>$fastcgi_path_info</var></tag-name> |
298
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1618 <tag-desc>the value of the second capture set by the |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1619 <link id="fastcgi_split_path_info"/> directive. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1620 This variable can be used to set the |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1621 <literal>PATH_INFO</literal> parameter. |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1622 </tag-desc> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1623 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1624 </list> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1625 </para> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1626 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1627 </section> |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1628 |
0dcf07c393b6
English translation of the ngx_http_fastcgi_module module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1629 </module> |