Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_proxy_module.xml @ 2611:454af1d39021
Development guide: Debugging memory issues section.
author | Roman Arutyunyan <arut@nginx.com> |
---|---|
date | Fri, 16 Oct 2020 17:55:16 +0100 |
parents | 5c5a36560f97 |
children | 6684517c9d19 |
rev | line source |
---|---|
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
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 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
9 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
10 <module name="Module ngx_http_proxy_module" |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 link="/en/docs/http/ngx_http_proxy_module.html" |
589 | 12 lang="en" |
2599
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
13 rev="69"> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
14 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
15 <section id="summary"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
16 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
17 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
18 The <literal>ngx_http_proxy_module</literal> module allows passing |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
19 requests to another server. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
20 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
21 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
22 </section> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
23 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
24 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
25 <section id="example" name="Example Configuration"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
26 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
27 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
28 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
29 location / { |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
30 proxy_pass http://localhost:8000; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
31 proxy_set_header Host $host; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
32 proxy_set_header X-Real-IP $remote_addr; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
33 } |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
34 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
35 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
36 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
37 </section> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
38 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
39 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
40 <section id="directives" name="Directives"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
41 |
772
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
42 <directive name="proxy_bind"> |
1885
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
43 <syntax> |
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
44 <value>address</value> |
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
45 [<literal>transparent</literal>] | |
6839c258c473
Added <literal> tag to proxy bind transparent.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1838
diff
changeset
|
46 <literal>off</literal></syntax> |
772
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
47 <default/> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
48 <context>http</context> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
49 <context>server</context> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
50 <context>location</context> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
51 <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
|
52 |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
53 <para> |
966 | 54 Makes outgoing connections to a proxied server originate |
1748
be371be7a5c8
Documented optional port for proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1717
diff
changeset
|
55 from the specified local IP address with an optional port (1.11.2). |
966 | 56 Parameter value can contain variables (1.3.12). |
815
ed29fd8be462
*_bind: variables support and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
799
diff
changeset
|
57 The special value <literal>off</literal> (1.3.12) cancels the effect |
ed29fd8be462
*_bind: variables support and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
799
diff
changeset
|
58 of the <literal>proxy_bind</literal> directive |
966 | 59 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:
1717
diff
changeset
|
60 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
|
61 </para> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
62 |
1696
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
63 <para id="proxy_bind_transparent"> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
64 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
|
65 outgoing connections to a proxied server originate |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
66 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
|
67 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
|
68 <example> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
69 proxy_bind $remote_addr transparent; |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
70 </example> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
71 In order for this parameter to work, |
2090
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2069
diff
changeset
|
72 it is usually necessary to run nginx worker processes with the |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2069
diff
changeset
|
73 <link doc="../ngx_core_module.xml" id="user">superuser</link> privileges. |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2069
diff
changeset
|
74 On Linux it is not required (1.13.8) as if |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2069
diff
changeset
|
75 the <literal>transparent</literal> parameter is specified, worker processes |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2069
diff
changeset
|
76 inherit the <literal>CAP_NET_RAW</literal> capability from the master process. |
a9a9a052b5bd
Documented the "CAP_NET_RAW" capability for transparent proxying.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2069
diff
changeset
|
77 It is also necessary to configure kernel routing table |
1696
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
78 to intercept network traffic from the proxied server. |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
79 </para> |
d855e7cc3b2f
Added the "transparent" parameter of proxy_bind and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1672
diff
changeset
|
80 |
772
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
81 </directive> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
82 |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
83 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
84 <directive name="proxy_buffer_size"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
85 <syntax><value>size</value></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
86 <default>4k|8k</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
87 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
88 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
89 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
90 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
91 <para> |
1547
c340ebfeeed6
Deleted duplicate word in proxy_buffer_size for http.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1542
diff
changeset
|
92 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
|
93 of the response received from the proxied server. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
94 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:
1547
diff
changeset
|
95 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:
1547
diff
changeset
|
96 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
|
97 It can be made smaller, however. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
98 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
99 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
100 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
101 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
102 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
103 <directive name="proxy_buffering"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
104 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
105 <default>on</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
106 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
107 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
108 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
109 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
110 <para> |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
111 Enables or disables buffering of responses from the proxied server. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
112 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
113 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
114 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
115 When buffering is enabled, nginx receives a response from the proxied server |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
116 as soon as possible, saving it into the buffers set by the |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
117 <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> directives. |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
118 If the whole response does not fit into memory, a part of it can be saved |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
119 to a <link id="proxy_temp_path">temporary file</link> on the disk. |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
120 Writing to temporary files is controlled by the |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
121 <link id="proxy_max_temp_file_size"/> and |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
122 <link id="proxy_temp_file_write_size"/> directives. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
123 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
124 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
125 <para> |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
126 When buffering is disabled, the response is passed to a client synchronously, |
362 | 127 immediately as it is received. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
128 nginx will not try to read the whole response from the proxied server. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
129 The maximum size of the data that nginx can receive from the server |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
130 at a time is set by the <link id="proxy_buffer_size"/> directive. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
131 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
132 |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
133 <para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
134 Buffering can also be enabled or disabled by passing |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
135 “<literal>yes</literal>” or “<literal>no</literal>” in the |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
136 <header>X-Accel-Buffering</header> response header field. |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
137 This capability can be disabled using the |
992 | 138 <link id="proxy_ignore_headers"/> directive. |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
139 </para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
140 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
141 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
142 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
143 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
144 <directive name="proxy_buffers"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
145 <syntax><value>number</value> <value>size</value></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
146 <default>8 4k|8k</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
147 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
148 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
149 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
150 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
151 <para> |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
152 Sets the <value>number</value> and <value>size</value> of the |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 buffers used for reading a response from the proxied server, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
154 for a single connection. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
155 By default, the buffer size is equal to one memory page. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
156 This is either 4K or 8K, depending on a platform. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
157 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
159 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
160 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
161 |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
162 <directive name="proxy_busy_buffers_size"> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
163 <syntax><value>size</value></syntax> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
164 <default>8k|16k</default> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
165 <context>http</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
166 <context>server</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
167 <context>location</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
168 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
169 <para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
170 When <link id="proxy_buffering">buffering</link> of responses from the proxied |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
171 server is enabled, limits the total <value>size</value> of buffers that |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
172 can be busy sending a response to the client while the response is not |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
173 yet fully read. |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
174 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
|
175 and, if needed, buffering part of the response to a temporary file. |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
176 By default, <value>size</value> is limited by the size of two buffers set by the |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
177 <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> directives. |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
178 </para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
179 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
180 </directive> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
181 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
182 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
183 <directive name="proxy_cache"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
184 <syntax><value>zone</value> | <literal>off</literal></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
185 <default>off</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
186 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
187 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
188 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
189 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
190 <para> |
575
ebcb351d9eb3
Consistently using the term "shared memory zone".
Ruslan Ermilov <ru@nginx.com>
parents:
535
diff
changeset
|
191 Defines a shared memory zone used for caching. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
192 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:
1376
diff
changeset
|
193 Parameter value can contain variables (1.7.9). |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
194 The <literal>off</literal> parameter disables caching inherited |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
195 from the previous configuration level. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
196 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
197 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
198 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
199 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
200 |
1909
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
201 <directive name="proxy_cache_background_update"> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
202 <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
|
203 <default>off</default> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
204 <context>http</context> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
205 <context>server</context> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
206 <context>location</context> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
207 <appeared-in>1.11.10</appeared-in> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
208 |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
209 <para> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
210 Allows starting a background subrequest |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
211 to update an expired cache item, |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
212 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
|
213 Note that it is necessary to |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
214 <link id="proxy_cache_use_stale_updating">allow</link> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
215 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
|
216 </para> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
217 |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
218 </directive> |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
219 |
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
220 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
221 <directive name="proxy_cache_bypass"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
222 <syntax><value>string</value> ...</syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
223 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
224 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
226 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
227 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
228 <para> |
294 | 229 Defines conditions under which the response will not be taken from a cache. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
230 If at least one value of the string parameters is not empty and is not |
294 | 231 equal to “0” then the response will not be taken from the cache: |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
232 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
233 proxy_cache_bypass $cookie_nocache $arg_nocache$arg_comment; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
234 proxy_cache_bypass $http_pragma $http_authorization; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
235 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
236 Can be used along with the <link id="proxy_no_cache"/> directive. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
237 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
238 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
239 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
240 |
1599
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
241 <directive name="proxy_cache_convert_head"> |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
242 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
243 <default>on</default> |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
244 <context>http</context> |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
245 <context>server</context> |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
246 <context>location</context> |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
247 <appeared-in>1.9.7</appeared-in> |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
248 |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
249 <para> |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
250 Enables or disables the conversion of the “<literal>HEAD</literal>” method |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
251 to “<literal>GET</literal>” for caching. |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
252 When the conversion is disabled, the |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
253 <link id="proxy_cache_key">cache key</link> should be configured |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
254 to include the <var>$request_method</var>. |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
255 </para> |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
256 |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
257 </directive> |
12714bbf9230
Documented the "proxy_cache_convert_head" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1587
diff
changeset
|
258 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
259 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
260 <directive name="proxy_cache_key"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
261 <syntax><value>string</value></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
262 <default>$scheme$proxy_host$request_uri</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
263 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
264 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
265 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
266 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
267 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
268 Defines a key for caching, for example |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
269 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
270 proxy_cache_key "$host$request_uri $cookie_user"; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
271 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
272 By default, the directive’s value is close to the string |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
273 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
274 proxy_cache_key $scheme$proxy_host$uri$is_args$args; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
275 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
276 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
277 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
278 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
279 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
280 |
302
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
281 <directive name="proxy_cache_lock"> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
282 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
283 <default>off</default> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
284 <context>http</context> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
285 <context>server</context> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
286 <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
|
287 <appeared-in>1.1.12</appeared-in> |
302
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
288 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
289 <para> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
290 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:
297
diff
changeset
|
291 a new cache element identified according to the <link id="proxy_cache_key"/> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
292 directive by passing a request to a proxied server. |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
293 Other requests of the same cache element will either wait |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
294 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:
297
diff
changeset
|
295 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:
297
diff
changeset
|
296 <link id="proxy_cache_lock_timeout"/> directive. |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
297 </para> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
298 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
299 </directive> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
300 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
301 |
1376
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
302 <directive name="proxy_cache_lock_age"> |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
303 <syntax><value>time</value></syntax> |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
304 <default>5s</default> |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
305 <context>http</context> |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
306 <context>server</context> |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
307 <context>location</context> |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
308 <appeared-in>1.7.8</appeared-in> |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
309 |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
310 <para> |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
311 If the last request passed to the proxied server |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
312 for populating a new cache element |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
313 has not completed for the specified <value>time</value>, |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
314 one more request may be passed to the proxied server. |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
315 </para> |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
316 |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
317 </directive> |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
318 |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
319 |
302
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
320 <directive name="proxy_cache_lock_timeout"> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
321 <syntax><value>time</value></syntax> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
322 <default>5s</default> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
323 <context>http</context> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
324 <context>server</context> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
325 <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
|
326 <appeared-in>1.1.12</appeared-in> |
302
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
327 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
328 <para> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
329 Sets a timeout for <link id="proxy_cache_lock"/>. |
1376
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
330 When the <value>time</value> expires, |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
331 the request will be passed to the proxied server, |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
332 however, the response will not be cached. |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
333 <note> |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
334 Before 1.7.8, the response could be cached. |
6e54b85dfb86
Documented the "proxy_cache_lock_age" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1372
diff
changeset
|
335 </note> |
302
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
336 </para> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
337 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
338 </directive> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
339 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
340 |
1838
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
341 <directive name="proxy_cache_max_range_offset"> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
342 <syntax><value>number</value></syntax> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
343 <default/> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
344 <context>http</context> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
345 <context>server</context> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
346 <context>location</context> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
347 <appeared-in>1.11.6</appeared-in> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
348 |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
349 <para> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
350 Sets an offset in bytes for byte-range requests. |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
351 If the range is beyond the offset, |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
352 the range request will be passed to the proxied server |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
353 and the response will not be cached. |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
354 </para> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
355 |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
356 </directive> |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
357 |
0d6ac4838921
Documented proxy_cache_max_range_offset and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1833
diff
changeset
|
358 |
790
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
359 <directive name="proxy_cache_methods"> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
360 <syntax> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
361 <literal>GET</literal> | |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
362 <literal>HEAD</literal> | |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
363 <literal>POST</literal> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
364 ...</syntax> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
365 <default>GET HEAD</default> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
366 <context>http</context> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
367 <context>server</context> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
368 <context>location</context> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
369 <appeared-in>0.7.59</appeared-in> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
370 |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
371 <para> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
372 If the client request method is listed in this directive then |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
373 the response will be cached. |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
374 “<literal>GET</literal>” and “<literal>HEAD</literal>” methods are always |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
375 added to the list, though it is recommended to specify them explicitly. |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
376 See also the <link id="proxy_no_cache"/> directive. |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
377 </para> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
378 |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
379 </directive> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
380 |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
381 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
382 <directive name="proxy_cache_min_uses"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
383 <syntax><value>number</value></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
384 <default>1</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
385 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
386 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
387 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
388 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
389 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
390 Sets the <value>number</value> of requests after which the response |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
391 will be cached. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
392 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
393 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
394 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
395 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
396 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
397 <directive name="proxy_cache_path"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
398 <syntax> |
364 | 399 <value>path</value> |
400 [<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
|
401 [<literal>use_temp_path</literal>=<literal>on</literal>|<literal>off</literal>] |
364 | 402 <literal>keys_zone</literal>=<value>name</value>:<value>size</value> |
403 [<literal>inactive</literal>=<value>time</value>] | |
508
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
404 [<literal>max_size</literal>=<value>size</value>] |
2560
a5bbfdf88bbd
Documented the "min_free" parameter of proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2254
diff
changeset
|
405 [<literal>min_free</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
|
406 [<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
|
407 [<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
|
408 [<literal>manager_threshold</literal>=<value>time</value>] |
508
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
409 [<literal>loader_files</literal>=<value>number</value>] |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
410 [<literal>loader_sleep</literal>=<value>time</value>] |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
411 [<literal>loader_threshold</literal>=<value>time</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
412 [<literal>purger</literal>=<literal>on</literal>|<literal>off</literal>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
413 [<literal>purger_files</literal>=<value>number</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
414 [<literal>purger_sleep</literal>=<value>time</value>] |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
415 [<literal>purger_threshold</literal>=<value>time</value>]</syntax> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
416 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
417 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
418 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
419 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
420 Sets the path and other parameters of a cache. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
421 Cache data are stored in files. |
1190
dd4cfc6ce770
Corrected description of *_cache_path file names.
Ruslan Ermilov <ru@nginx.com>
parents:
1189
diff
changeset
|
422 The file name in a cache is a result of |
dd4cfc6ce770
Corrected description of *_cache_path file names.
Ruslan Ermilov <ru@nginx.com>
parents:
1189
diff
changeset
|
423 applying the MD5 function to the |
dd4cfc6ce770
Corrected description of *_cache_path file names.
Ruslan Ermilov <ru@nginx.com>
parents:
1189
diff
changeset
|
424 <link id="proxy_cache_key">cache key</link>. |
1796
1d576e8d6ead
Clarified the "levels" parameter of proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1748
diff
changeset
|
425 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
|
426 from 1 to 3, each level accepts values 1 or 2. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
427 For example, in the following configuration |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
428 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
429 proxy_cache_path /data/nginx/cache levels=1:2 keys_zone=one:10m; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
430 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
431 file names in a cache will look like this: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
432 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
433 /data/nginx/cache/<emphasis>c</emphasis>/<emphasis>29</emphasis>/b7f54b2df7773722d382f4809d650<emphasis>29c</emphasis> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
434 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
435 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
436 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
437 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
438 A cached response is first written to a temporary file, |
966 | 439 and then the file is renamed. |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
440 Starting from version 0.8.9, temporary files and the cache can be put on |
966 | 441 different file systems. |
442 However, be aware that in this case a file is copied | |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
443 across two file systems instead of the cheap renaming operation. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
444 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
|
445 holding temporary files |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
446 are put on the same file system. |
1414 | 447 The directory for temporary files is set based on |
1384
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
448 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
|
449 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
|
450 the directory set by the <link id="proxy_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
|
451 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
|
452 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
|
453 temporary files will be put directly in the cache directory. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
454 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
455 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
456 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
457 In addition, all active keys and information about data are stored |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
458 in a shared memory zone, whose <value>name</value> and <value>size</value> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
459 are configured by the <literal>keys_zone</literal> parameter. |
1189
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1166
diff
changeset
|
460 One megabyte zone can store about 8 thousand keys. |
2069
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1990
diff
changeset
|
461 <note> |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1990
diff
changeset
|
462 As part of |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1990
diff
changeset
|
463 <commercial_version>commercial subscription</commercial_version>, |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1990
diff
changeset
|
464 the shared memory zone also stores extended |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1990
diff
changeset
|
465 cache <link doc="ngx_http_api_module.xml" id="http_caches_">information</link>, |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1990
diff
changeset
|
466 thus, it is required to specify a larger zone size for the same number of keys. |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1990
diff
changeset
|
467 For example, |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1990
diff
changeset
|
468 one megabyte zone can store about 4 thousand keys. |
fc3ba2e76974
Documented size of keys_zone for commercial version (trac #1286).
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1990
diff
changeset
|
469 </note> |
1189
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1166
diff
changeset
|
470 </para> |
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1166
diff
changeset
|
471 |
f25d00109de0
Documented cache keys_zone memory estimates.
Maxim Dounin <mdounin@mdounin.ru>
parents:
1166
diff
changeset
|
472 <para> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
473 Cached data that are not accessed during the time specified by the |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
474 <literal>inactive</literal> parameter get removed from the cache |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
475 regardless of their freshness. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
476 By default, <literal>inactive</literal> is set to 10 minutes. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
477 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
478 |
2560
a5bbfdf88bbd
Documented the "min_free" parameter of proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2254
diff
changeset
|
479 <para id="proxy_cache_path_max_size"> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
480 The special “cache manager” process monitors the maximum cache size set |
2560
a5bbfdf88bbd
Documented the "min_free" parameter of proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2254
diff
changeset
|
481 by the <literal>max_size</literal> parameter, |
a5bbfdf88bbd
Documented the "min_free" parameter of proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2254
diff
changeset
|
482 and the minimum amount of free space set |
a5bbfdf88bbd
Documented the "min_free" parameter of proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2254
diff
changeset
|
483 by the <literal>min_free</literal> (1.19.1) parameter |
a5bbfdf88bbd
Documented the "min_free" parameter of proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2254
diff
changeset
|
484 on the file system with cache. |
a5bbfdf88bbd
Documented the "min_free" parameter of proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2254
diff
changeset
|
485 When the size is exceeded or there is not enough free space, |
a5bbfdf88bbd
Documented the "min_free" parameter of proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2254
diff
changeset
|
486 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
|
487 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
|
488 <literal>manager_files</literal>, |
bc6341aaa832
Added cache manager parameters to proxy_cache path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1803
diff
changeset
|
489 <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
|
490 <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
|
491 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
|
492 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
|
493 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
|
494 <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
|
495 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
|
496 parameter (by default, 50 milliseconds) is made. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
497 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
498 |
508
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
499 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
500 A minute after the start the special “cache loader” process is activated. |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
501 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
|
502 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
|
503 The loading is also done in iterations. |
508
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
504 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
|
505 are loaded (by default, 100). |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
506 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
|
507 <literal>loader_threshold</literal> parameter (by default, 200 milliseconds). |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
508 Between iterations, a pause configured by the <literal>loader_sleep</literal> |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
509 parameter (by default, 50 milliseconds) is made. |
508
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
510 </para> |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
511 |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
512 <para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
513 Additionally, |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
514 the following parameters are available as part of our |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
515 <commercial_version>commercial subscription</commercial_version>: |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
516 </para> |
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 <para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
519 <list type="tag"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
520 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
521 <tag-name id="purger"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
522 <literal>purger</literal>=<literal>on</literal>|<literal>off</literal> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
523 </tag-name> |
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 Instructs whether cache entries that match a |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
526 <link id="proxy_cache_purge">wildcard key</link> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
527 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
|
528 Setting the parameter to <literal>on</literal> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
529 (default is <literal>off</literal>) |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
530 will activate the “cache purger” process that |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
531 permanently iterates through all cache entries |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
532 and deletes the entries that match the wildcard key. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
533 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
534 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
535 <tag-name id="purger_files"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
536 <literal>purger_files</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
537 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
538 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
539 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
|
540 By default, <literal>purger_files</literal> is set to 10. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
541 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
542 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
543 <tag-name id="purger_threshold"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
544 <literal>purger_threshold</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
545 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
546 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
547 Sets the duration of one iteration (1.7.12). |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
548 By default, <literal>purger_threshold</literal> is set to 50 milliseconds. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
549 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
550 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
551 <tag-name id="purger_sleep"> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
552 <literal>purger_sleep</literal>=<value>number</value> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
553 </tag-name> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
554 <tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
555 Sets a pause between iterations (1.7.12). |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
556 By default, <literal>purger_sleep</literal> is set to 50 milliseconds. |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
557 </tag-desc> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
558 |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
559 </list> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
560 </para> |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
561 |
1973
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
562 <para> |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
563 <note> |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
564 In versions 1.7.3, 1.7.7, and 1.11.10 cache header format has been changed. |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
565 Previously cached responses will be considered invalid |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
566 after upgrading to a newer nginx version. |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
567 </note> |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
568 </para> |
3460bd328287
Documented cache version change in proxy_cache_path and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1956
diff
changeset
|
569 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
570 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
571 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
572 |
1028
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
573 <directive name="proxy_cache_purge"> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
574 <syntax>string ...</syntax> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
575 <default/> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
576 <context>http</context> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
577 <context>server</context> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
578 <context>location</context> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
579 <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
|
580 |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
581 <para> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
582 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
|
583 purge request. |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
584 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
|
585 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
|
586 <link id="proxy_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
|
587 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
|
588 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
|
589 </para> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
590 |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
591 <para> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
592 If the <link id="proxy_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
|
593 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
|
594 wildcard key will be removed from the cache. |
1582
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
595 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
|
596 for either <link id="proxy_cache_path">inactivity</link>, |
8973c7b37854
Updated commercial docs.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1550
diff
changeset
|
597 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
|
598 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
|
599 </para> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
600 |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
601 <para> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
602 Example configuration: |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
603 <example> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
604 proxy_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
|
605 |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
606 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
|
607 PURGE 1; |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
608 default 0; |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
609 } |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
610 |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
611 server { |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
612 ... |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
613 location / { |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
614 proxy_pass http://backend; |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
615 proxy_cache cache_zone; |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
616 proxy_cache_key $uri; |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
617 proxy_cache_purge $purge_method; |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
618 } |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
619 } |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
620 </example> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
621 <note> |
1128
1594ed379f1f
De-i18n'ed <commercial_version/>.
Ruslan Ermilov <ru@nginx.com>
parents:
1088
diff
changeset
|
622 This functionality is available as part of our |
1594ed379f1f
De-i18n'ed <commercial_version/>.
Ruslan Ermilov <ru@nginx.com>
parents:
1088
diff
changeset
|
623 <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
|
624 </note> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
625 </para> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
626 |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
627 </directive> |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
628 |
e582a10b1917
Documented the "proxy_cache_purge" and "fastcgi_cache_purge" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1015
diff
changeset
|
629 |
1011
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
630 <directive name="proxy_cache_revalidate"> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
631 <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
|
632 <default>off</default> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
633 <context>http</context> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
634 <context>server</context> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
635 <context>location</context> |
1015
af77dd40abeb
Documented the appearance of "fastcgi_" and "proxy_cache_revalidate".
Vladimir Homutov <vl@nginx.com>
parents:
1011
diff
changeset
|
636 <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
|
637 |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
638 <para> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
639 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:
1190
diff
changeset
|
640 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:
1190
diff
changeset
|
641 header fields. |
1011
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
642 </para> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
643 |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
644 </directive> |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
645 |
2ad2f30efdf2
Documented the "fastcgi_" and "proxy_cache_revalidate" directives.
Vladimir Homutov <vl@nginx.com>
parents:
1005
diff
changeset
|
646 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
647 <directive name="proxy_cache_use_stale"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
648 <syntax> |
364 | 649 <literal>error</literal> | |
650 <literal>timeout</literal> | | |
651 <literal>invalid_header</literal> | | |
652 <literal>updating</literal> | | |
653 <literal>http_500</literal> | | |
654 <literal>http_502</literal> | | |
655 <literal>http_503</literal> | | |
656 <literal>http_504</literal> | | |
917
e26a18eb5ccd
Documented http_403 in proxy_next_upstream and friends.
Maxim Dounin <mdounin@mdounin.ru>
parents:
907
diff
changeset
|
657 <literal>http_403</literal> | |
364 | 658 <literal>http_404</literal> | |
1956
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
659 <literal>http_429</literal> | |
364 | 660 <literal>off</literal> |
661 ...</syntax> | |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
662 <default>off</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
663 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
664 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
665 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
666 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
667 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
668 Determines in which cases a stale cached response can be used |
1910
41cf2c2d8c5c
Cache: support for stale-while-revalidate and stale-if-error.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1909
diff
changeset
|
669 during communication with the proxied server. |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
670 The directive’s parameters match the parameters of the |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
671 <link id="proxy_next_upstream"/> directive. |
504
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
672 </para> |
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
673 |
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
674 <para> |
1542
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
675 The <literal>error</literal> parameter also permits |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
676 using a stale cached response if a proxied server to process a request |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
677 cannot be selected. |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
678 </para> |
a13a99cf46ea
Better documented "*_cache_use_stale error".
Ruslan Ermilov <ru@nginx.com>
parents:
1524
diff
changeset
|
679 |
1909
399d0e188195
Documented proxy_cache_background_update and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1885
diff
changeset
|
680 <para id="proxy_cache_use_stale_updating"> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
681 Additionally, the <literal>updating</literal> parameter permits |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
682 using a stale cached response if it is currently being updated. |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
683 This allows minimizing the number of accesses to proxied servers |
504
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
684 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
|
685 </para> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
686 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
687 <para> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
688 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
|
689 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
|
690 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
|
691 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
|
692 <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
|
693 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
694 <listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
695 The |
1910
41cf2c2d8c5c
Cache: support for stale-while-revalidate and stale-if-error.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1909
diff
changeset
|
696 “<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
|
697 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
|
698 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
|
699 </listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
700 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
701 <listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
702 The |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
703 “<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
|
704 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
|
705 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
|
706 </listitem> |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
707 |
ec4af97e4403
Split off header options from parameters in proxy_cache_use_stale and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1910
diff
changeset
|
708 </list> |
504
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
709 </para> |
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
710 |
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
711 <para> |
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
712 To minimize the number of accesses to proxied servers when |
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
713 populating a new cache element, the <link id="proxy_cache_lock"/> |
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
714 directive can be used. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
715 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
716 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
717 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
718 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
719 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
720 <directive name="proxy_cache_valid"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
721 <syntax>[<value>code</value> ...] <value>time</value></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
722 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
723 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
724 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
725 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
726 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
727 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
728 Sets caching time for different response codes. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
729 For example, the following directives |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
730 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
731 proxy_cache_valid 200 302 10m; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
732 proxy_cache_valid 404 1m; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
733 </example> |
966 | 734 set 10 minutes of caching for responses with codes 200 and 302 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
735 and 1 minute for responses with code 404. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
736 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
737 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
738 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
739 If only caching <value>time</value> is specified |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
740 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
741 proxy_cache_valid 5m; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
742 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
743 then only 200, 301, and 302 responses are cached. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
744 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
745 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
746 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
747 In addition, the <literal>any</literal> parameter can be specified |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
748 to cache any responses: |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
749 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
750 proxy_cache_valid 200 302 10m; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
751 proxy_cache_valid 301 1h; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
752 proxy_cache_valid any 1m; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
753 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
754 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
755 |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
756 <para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
757 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:
504
diff
changeset
|
758 in the response header. |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
759 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
|
760 <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
|
761 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
762 <listitem> |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
763 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:
504
diff
changeset
|
764 response in seconds. |
966 | 765 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
|
766 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:
504
diff
changeset
|
767 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
|
768 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
769 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
770 <listitem> |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
771 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:
504
diff
changeset
|
772 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:
504
diff
changeset
|
773 <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
|
774 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
775 |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
776 <listitem> |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
777 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:
504
diff
changeset
|
778 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
|
779 </listitem> |
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
780 |
1353
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
781 <listitem> |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
782 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
|
783 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
|
784 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
|
785 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
|
786 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
|
787 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
|
788 </listitem> |
25db29c8875e
Documented how the "Vary" response header field affects caching.
Ruslan Ermilov <ru@nginx.com>
parents:
1352
diff
changeset
|
789 |
1349
97c8b146cb0e
Split the long paragraph about caching parameters into the list.
Ruslan Ermilov <ru@nginx.com>
parents:
1345
diff
changeset
|
790 </list> |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
791 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:
504
diff
changeset
|
792 using the <link id="proxy_ignore_headers"/> directive. |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
793 </para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
794 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
795 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
796 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
797 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
798 <directive name="proxy_connect_timeout"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
799 <syntax><value>time</value></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
800 <default>60s</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
801 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
802 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
803 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
804 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
805 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
806 Defines a timeout for establishing a connection with a proxied server. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
807 It should be noted that this timeout cannot usually exceed 75 seconds. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
808 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
809 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
810 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
811 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
812 |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
813 <directive name="proxy_cookie_domain"> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
814 <syntax><literal>off</literal></syntax> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
815 <syntax><value>domain</value> <value>replacement</value></syntax> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
816 <default>off</default> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
817 <context>http</context> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
818 <context>server</context> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
819 <context>location</context> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
820 <appeared-in>1.1.15</appeared-in> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
821 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
822 <para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
823 Sets a text that should be changed in the <literal>domain</literal> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
824 attribute of the <header>Set-Cookie</header> header fields of a |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
825 proxied server response. |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
826 Suppose a proxied server returned the <header>Set-Cookie</header> |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
827 header field with the attribute |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
828 “<literal>domain=localhost</literal>”. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
829 The directive |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
830 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
831 proxy_cookie_domain localhost example.org; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
832 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
833 will rewrite this attribute to |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
834 “<literal>domain=example.org</literal>”. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
835 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
836 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
837 <para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
838 A dot at the beginning of the <value>domain</value> and |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
839 <value>replacement</value> strings and the <literal>domain</literal> |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
840 attribute is ignored. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
841 Matching is case-insensitive. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
842 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
843 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
844 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
845 The <value>domain</value> and <value>replacement</value> strings |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
846 can contain variables: |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
847 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
848 proxy_cookie_domain www.$host $host; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
849 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
850 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
851 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
852 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
853 The directive can also be specified using regular expressions. |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
854 In this case, <value>domain</value> should start from |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
855 the “<literal>~</literal>” symbol. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
856 A regular expression can contain named and positional captures, |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
857 and <value>replacement</value> can reference them: |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
858 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
859 proxy_cookie_domain ~\.(?P<sl_domain>[-0-9a-z]+\.[a-z]+)$ $sl_domain; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
860 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
861 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
862 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
863 <para> |
2598
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
864 Several <literal>proxy_cookie_domain</literal> directives |
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
865 can be specified on the same level: |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
866 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
867 proxy_cookie_domain localhost example.org; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
868 proxy_cookie_domain ~\.([a-z]+\.[a-z]+)$ $1; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
869 </example> |
2598
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
870 The <literal>off</literal> parameter cancels the effect |
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
871 of the <literal>proxy_cookie_domain</literal> directives |
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
872 inherited from the previous configuration level. |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
873 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
874 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
875 </directive> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
876 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
877 |
2599
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
878 <directive name="proxy_cookie_flags"> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
879 <syntax> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
880 <literal>off</literal> | |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
881 <value>cookie</value> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
882 [<value>flag</value> ...]</syntax> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
883 <default>off</default> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
884 <context>http</context> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
885 <context>server</context> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
886 <context>location</context> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
887 <appeared-in>1.19.3</appeared-in> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
888 |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
889 <para> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
890 Sets one or more flags for the cookie. |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
891 The <value>cookie</value> can contain text, variables, and their combinations. |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
892 The |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
893 <literal>secure</literal>, |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
894 <literal>httponly</literal>, |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
895 <literal>samesite=strict</literal>, |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
896 <literal>samesite=lax</literal>, |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
897 <literal>samesite=none</literal> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
898 parameters add the corresponding flags. |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
899 The |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
900 <literal>nosecure</literal>, |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
901 <literal>nohttponly</literal>, |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
902 <literal>nosamesite</literal> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
903 parameters remove the corresponding flags. |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
904 </para> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
905 |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
906 <para> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
907 The cookie can also be specified using regular expressions. |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
908 In this case, <value>cookie</value> should start from |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
909 the “<literal>~</literal>” symbol. |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
910 </para> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
911 |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
912 <para> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
913 Several <literal>proxy_cookie_flags</literal> directives |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
914 can be specified on the same configuration level: |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
915 <example> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
916 proxy_cookie_flags one httponly; |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
917 proxy_cookie_flags ~ nosecure samesite=strict; |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
918 </example> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
919 In the example, the <literal>httponly</literal> flag |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
920 is added to the cookie <literal>one</literal>, |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
921 for all other cookies |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
922 the <literal>samesite=strict</literal> flag is added and |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
923 the <literal>secure</literal> flag is deleted. |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
924 </para> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
925 |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
926 <para> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
927 The <literal>off</literal> parameter cancels the effect |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
928 of the <literal>proxy_cookie_flags</literal> directives |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
929 inherited from the previous configuration level. |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
930 </para> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
931 |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
932 </directive> |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
933 |
5c5a36560f97
Added the proxy_cookie_flags directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2598
diff
changeset
|
934 |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
935 <directive name="proxy_cookie_path"> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
936 <syntax><literal>off</literal></syntax> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
937 <syntax><value>path</value> <value>replacement</value></syntax> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
938 <default>off</default> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
939 <context>http</context> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
940 <context>server</context> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
941 <context>location</context> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
942 <appeared-in>1.1.15</appeared-in> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
943 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
944 <para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
945 Sets a text that should be changed in the <literal>path</literal> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
946 attribute of the <header>Set-Cookie</header> header fields of a |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
947 proxied server response. |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
948 Suppose a proxied server returned the <header>Set-Cookie</header> |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
949 header field with the attribute |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
950 “<literal>path=/two/some/uri/</literal>”. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
951 The directive |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
952 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
953 proxy_cookie_path /two/ /; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
954 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
955 will rewrite this attribute to |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
956 “<literal>path=/some/uri/</literal>”. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
957 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
958 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
959 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
960 The <value>path</value> and <value>replacement</value> strings |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
961 can contain variables: |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
962 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
963 proxy_cookie_path $uri /some$uri; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
964 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
965 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
966 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
967 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
968 The directive can also be specified using regular expressions. |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
969 In this case, <value>path</value> should either start from |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
970 the “<literal>~</literal>” symbol for a case-sensitive matching, |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
971 or from the “<literal>~*</literal>” symbols for case-insensitive |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
972 matching. |
1149
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1146
diff
changeset
|
973 The regular expression can contain named and positional captures, |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
974 and <value>replacement</value> can reference them: |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
975 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
976 proxy_cookie_path ~*^/user/([^/]+) /u/$1; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
977 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
978 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
979 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
980 <para> |
2598
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
981 Several <literal>proxy_cookie_path</literal> directives |
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
982 can be specified on the same level: |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
983 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
984 proxy_cookie_path /one/ /; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
985 proxy_cookie_path / /two/; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
986 </example> |
2598
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
987 The <literal>off</literal> parameter cancels the effect |
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
988 of the <literal>proxy_cookie_path</literal> directives |
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
989 inherited from the previous configuration level. |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
990 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
991 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
992 </directive> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
993 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
994 |
1337
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
995 <directive name="proxy_force_ranges"> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
996 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
997 <default>off</default> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
998 <context>http</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
999 <context>server</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
1000 <context>location</context> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
1001 <appeared-in>1.7.7</appeared-in> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
1002 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
1003 <para> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
1004 Enables byte-range support |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
1005 for both cached and uncached responses from the proxied server |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
1006 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:
1298
diff
changeset
|
1007 </para> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
1008 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
1009 </directive> |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
1010 |
91a064bdb4f9
Documented the "proxy_force_ranges" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1298
diff
changeset
|
1011 |
799
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1012 <directive name="proxy_headers_hash_bucket_size"> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1013 <syntax><value>size</value></syntax> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1014 <default>64</default> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1015 <context>http</context> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1016 <context>server</context> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1017 <context>location</context> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1018 |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1019 <para> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1020 Sets the bucket <value>size</value> for hash tables |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1021 used by the <link id="proxy_hide_header"/> and <link id="proxy_set_header"/> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1022 directives. |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1023 The details of setting up hash tables are provided in a separate |
799
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1024 <link doc="../hash.xml">document</link>. |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1025 </para> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1026 |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1027 </directive> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1028 |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1029 |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1030 <directive name="proxy_headers_hash_max_size"> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1031 <syntax><value>size</value></syntax> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1032 <default>512</default> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1033 <context>http</context> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1034 <context>server</context> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1035 <context>location</context> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1036 |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1037 <para> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1038 Sets the maximum <value>size</value> of hash tables |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1039 used by the <link id="proxy_hide_header"/> and <link id="proxy_set_header"/> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1040 directives. |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1041 The details of setting up hash tables are provided in a separate |
799
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1042 <link doc="../hash.xml">document</link>. |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1043 </para> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1044 |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1045 </directive> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1046 |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
1047 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1048 <directive name="proxy_hide_header"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1049 <syntax><value>field</value></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1050 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1051 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1052 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1053 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1054 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1055 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1056 By default, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1057 nginx does not pass the header fields <header>Date</header>, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1058 <header>Server</header>, <header>X-Pad</header>, and |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1059 <header>X-Accel-...</header> from the response of a proxied |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1060 server to a client. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1061 The <literal>proxy_hide_header</literal> directive sets additional fields |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1062 that will not be passed. |
294 | 1063 If, on the contrary, the passing of fields needs to be permitted, |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1064 the <link id="proxy_pass_header"/> directive can be used. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1065 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1066 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1067 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1068 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1069 |
316
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1070 <directive name="proxy_http_version"> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1071 <syntax><literal>1.0</literal> | <literal>1.1</literal></syntax> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1072 <default>1.0</default> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1073 <context>http</context> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1074 <context>server</context> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1075 <context>location</context> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1076 <appeared-in>1.1.4</appeared-in> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1077 |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1078 <para> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1079 Sets the HTTP protocol version for proxying. |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1080 By default, version 1.0 is used. |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1081 Version 1.1 is recommended for use with |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1082 <link doc="ngx_http_upstream_module.xml" id="keepalive"/> |
1587
c2a0a18e65ba
Added keepalive info for ntlm.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1582
diff
changeset
|
1083 connections and |
c2a0a18e65ba
Added keepalive info for ntlm.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1582
diff
changeset
|
1084 <link doc="ngx_http_upstream_module.xml" id="ntlm">NTLM authentication</link>. |
316
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1085 </para> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1086 |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1087 </directive> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1088 |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
1089 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1090 <directive name="proxy_ignore_client_abort"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1091 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1092 <default>off</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1093 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1094 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1095 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1096 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1097 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1098 Determines whether the connection with a proxied server should be |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
1099 closed when a client closes the connection without waiting |
294 | 1100 for a response. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1101 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1102 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1103 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1104 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1105 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1106 <directive name="proxy_ignore_headers"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1107 <syntax><value>field</value> ...</syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1108 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1109 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1110 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1111 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1112 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1113 <para> |
294 | 1114 Disables processing of certain response header fields from the proxied server. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1115 The following fields can be ignored: <header>X-Accel-Redirect</header>, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1116 <header>X-Accel-Expires</header>, <header>X-Accel-Limit-Rate</header> (1.1.6), |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1117 <header>X-Accel-Buffering</header> (1.1.6), |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1118 <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
|
1119 <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
|
1120 and <header>Vary</header> (1.7.7). |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1121 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1122 |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1123 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1124 If not disabled, processing of these header fields has the following |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1125 effect: |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1126 <list type="bullet" compact="no"> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1127 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1128 <listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1129 <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
|
1130 <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
|
1131 and <header>Vary</header> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1132 set the parameters of response <link id="proxy_cache_valid">caching</link>; |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1133 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1134 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1135 <listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1136 <header>X-Accel-Redirect</header> performs an |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1137 <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:
504
diff
changeset
|
1138 redirect</link> to the specified URI; |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1139 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1140 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1141 <listitem> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1142 <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:
504
diff
changeset
|
1143 <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:
504
diff
changeset
|
1144 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:
504
diff
changeset
|
1145 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1146 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1147 <listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1148 <header>X-Accel-Buffering</header> enables or disables |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1149 <link id="proxy_buffering">buffering</link> of a response; |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1150 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1151 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1152 <listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1153 <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:
504
diff
changeset
|
1154 <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:
504
diff
changeset
|
1155 of a response. |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1156 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1157 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1158 </list> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1159 </para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
1160 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1161 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1162 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1163 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1164 <directive name="proxy_intercept_errors"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1165 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1166 <default>off</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1167 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1168 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1169 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1170 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1171 <para> |
297 | 1172 Determines whether proxied 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
|
1173 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
|
1174 or be intercepted and redirected to nginx for processing |
966 | 1175 with the <link doc="ngx_http_core_module.xml" id="error_page"/> directive. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1176 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1177 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1178 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1179 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1180 |
1342
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1181 <directive name="proxy_limit_rate"> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1182 <syntax><value>rate</value></syntax> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1183 <default>0</default> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1184 <context>http</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1185 <context>server</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1186 <context>location</context> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1187 <appeared-in>1.7.7</appeared-in> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1188 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1189 <para> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1190 Limits the speed of reading the response from the proxied server. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1191 The <value>rate</value> is specified in bytes per second. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1192 The zero value disables rate limiting. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1193 The limit is set per a request, and so if nginx simultaneously opens |
1343
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
1194 two connections to the proxied server, |
1bdde28e359b
Fixed fallouts from the previous change.
Ruslan Ermilov <ru@nginx.com>
parents:
1342
diff
changeset
|
1195 the overall rate will be twice as much as the specified limit. |
1342
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1196 The limitation works only if |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1197 <link id="proxy_buffering">buffering</link> of responses from the proxied |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1198 server is enabled. |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1199 </para> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1200 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1201 </directive> |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1202 |
758fc0b02651
Documented the "proxy_limit_rate" directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1337
diff
changeset
|
1203 |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1204 <directive name="proxy_max_temp_file_size"> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1205 <syntax><value>size</value></syntax> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1206 <default>1024m</default> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1207 <context>http</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1208 <context>server</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1209 <context>location</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1210 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1211 <para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1212 When <link id="proxy_buffering">buffering</link> of responses from the proxied |
1153
4e20e4f8f49b
Finished truncation of "memory buffers" to just "buffers".
Ruslan Ermilov <ru@nginx.com>
parents:
1151
diff
changeset
|
1213 server is enabled, and the whole response does not fit into the buffers |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1214 set by the <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> |
966 | 1215 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
|
1216 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
|
1217 The size of data written to the temporary file at a time is set |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1218 by the <link id="proxy_temp_file_write_size"/> directive. |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1219 </para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1220 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1221 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1222 The zero value disables buffering of responses to temporary files. |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1223 </para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1224 |
1352
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1225 <para> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1226 <note> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1227 This restriction does not apply to responses |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1228 that will be <link id="proxy_cache">cached</link> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1229 or <link id="proxy_store">stored</link> on disk. |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1230 </note> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1231 </para> |
dbb618f60a54
Elaborate on writing proxied responses to files.
Ruslan Ermilov <ru@nginx.com>
parents:
1349
diff
changeset
|
1232 |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1233 </directive> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1234 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1235 |
787
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1236 <directive name="proxy_method"> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1237 <syntax><value>method</value></syntax> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1238 <default/> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1239 <context>http</context> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1240 <context>server</context> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1241 <context>location</context> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1242 |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1243 <para> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1244 Specifies the HTTP <value>method</value> to use in requests forwarded |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1245 to the proxied server instead of the method from the client request. |
1833
0c4b43e26cea
Documented variables support in proxy_method.
Ruslan Ermilov <ru@nginx.com>
parents:
1812
diff
changeset
|
1246 Parameter value can contain variables (1.11.6). |
787
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1247 </para> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1248 |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1249 </directive> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1250 |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1251 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1252 <directive name="proxy_next_upstream"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1253 <syntax> |
364 | 1254 <literal>error</literal> | |
1255 <literal>timeout</literal> | | |
1256 <literal>invalid_header</literal> | | |
1257 <literal>http_500</literal> | | |
1258 <literal>http_502</literal> | | |
1259 <literal>http_503</literal> | | |
1260 <literal>http_504</literal> | | |
917
e26a18eb5ccd
Documented http_403 in proxy_next_upstream and friends.
Maxim Dounin <mdounin@mdounin.ru>
parents:
907
diff
changeset
|
1261 <literal>http_403</literal> | |
364 | 1262 <literal>http_404</literal> | |
1956
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1263 <literal>http_429</literal> | |
1669
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1264 <literal>non_idempotent</literal> | |
364 | 1265 <literal>off</literal> |
1266 ...</syntax> | |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1267 <default>error timeout</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1268 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1269 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1270 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1271 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1272 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1273 Specifies in which cases a request should be passed to the next server: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1274 <list type="tag"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1275 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1276 <tag-name><literal>error</literal></tag-name> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1277 <tag-desc>an error occurred while establishing a connection with the |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1278 server, passing a request to it, or reading the response header;</tag-desc> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1279 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1280 <tag-name><literal>timeout</literal></tag-name> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1281 <tag-desc>a timeout has occurred while establishing a connection with the |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1282 server, passing a request to it, or reading the response header;</tag-desc> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1283 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1284 <tag-name><literal>invalid_header</literal></tag-name> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1285 <tag-desc>a server returned an empty or invalid response;</tag-desc> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1286 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1287 <tag-name><literal>http_500</literal></tag-name> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1288 <tag-desc>a server returned a response with the code 500;</tag-desc> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1289 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1290 <tag-name><literal>http_502</literal></tag-name> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1291 <tag-desc>a server returned a response with the code 502;</tag-desc> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1292 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1293 <tag-name><literal>http_503</literal></tag-name> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1294 <tag-desc>a server returned a response with the code 503;</tag-desc> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1295 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1296 <tag-name><literal>http_504</literal></tag-name> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1297 <tag-desc>a server returned a response with the code 504;</tag-desc> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1298 |
917
e26a18eb5ccd
Documented http_403 in proxy_next_upstream and friends.
Maxim Dounin <mdounin@mdounin.ru>
parents:
907
diff
changeset
|
1299 <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
|
1300 <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
|
1301 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1302 <tag-name><literal>http_404</literal></tag-name> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1303 <tag-desc>a server returned a response with the code 404;</tag-desc> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1304 |
1956
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1305 <tag-name><literal>http_429</literal></tag-name> |
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1306 <tag-desc>a server returned a response with the code 429 (1.11.13);</tag-desc> |
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1307 |
1669
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1308 <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
|
1309 <tag-desc>normally, requests with a |
1923
66a30a380fba
Fixed links to tools.ietf.org.
Ruslan Ermilov <ru@nginx.com>
parents:
1912
diff
changeset
|
1310 <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
|
1311 method |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1312 (<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
|
1313 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
|
1314 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
|
1315 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
|
1316 </tag-desc> |
c872b93682f4
Added "non_idempotent" for proxy_next_upstream and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1659
diff
changeset
|
1317 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1318 <tag-name><literal>off</literal></tag-name> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1319 <tag-desc>disables passing a request to the next server.</tag-desc> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1320 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1321 </list> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1322 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1323 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1324 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1325 One should bear in mind that passing a request to the next server is |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1326 only possible if nothing has been sent to a client yet. |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1327 That is, if an error or timeout occurs in the middle of the |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1328 transferring of a response, fixing this is impossible. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1329 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1330 |
942
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1331 <para> |
1289
57fc39924d42
Proxy/memcached/fastcgi/scgi/uwsgi: updated link in _next_upstream directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1246
diff
changeset
|
1332 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
|
1333 <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
|
1334 attempt</link> of communication with a server. |
942
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1335 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
|
1336 <literal>invalid_header</literal> are always considered unsuccessful attempts, |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1337 even if they are not specified in the directive. |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1338 The cases of <literal>http_500</literal>, <literal>http_502</literal>, |
1956
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1339 <literal>http_503</literal>, <literal>http_504</literal>, |
dd96a09dd4f7
Documented support for "429 Too Many Requests" response.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1923
diff
changeset
|
1340 and <literal>http_429</literal> are |
942
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1341 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
|
1342 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
|
1343 are never considered unsuccessful attempts. |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1344 </para> |
ba3d6ade3513
Elaborate on upstream server failures.
Ruslan Ermilov <ru@nginx.com>
parents:
917
diff
changeset
|
1345 |
1290
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1346 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1347 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
|
1348 <link id="proxy_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
|
1349 and by <link id="proxy_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
|
1350 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1351 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1352 </directive> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1353 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1354 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1355 <directive name="proxy_next_upstream_timeout"> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1356 <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
|
1357 <default>0</default> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1358 <context>http</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1359 <context>server</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1360 <context>location</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1361 <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
|
1362 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1363 <para> |
1672
9c98c4498f08
Rephrased the "proxy_next_upstream_timeout" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1669
diff
changeset
|
1364 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
|
1365 <link id="proxy_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
|
1366 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
|
1367 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1368 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1369 </directive> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1370 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1371 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1372 <directive name="proxy_next_upstream_tries"> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1373 <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
|
1374 <default>0</default> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1375 <context>http</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1376 <context>server</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1377 <context>location</context> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1378 <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
|
1379 |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1380 <para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1381 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
|
1382 <link id="proxy_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
|
1383 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
|
1384 </para> |
f5cc9f2aef9a
Proxy/memcached/fastcgi/scgi/uwsgi: _next_upstream_timeout,_next_upstream_tries.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1289
diff
changeset
|
1385 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1386 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1387 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1388 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1389 <directive name="proxy_no_cache"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1390 <syntax><value>string</value> ...</syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1391 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1392 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1393 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1394 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1395 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1396 <para> |
294 | 1397 Defines conditions under which the response will not be saved to a cache. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1398 If at least one value of the string parameters is not empty and is not |
294 | 1399 equal to “0” then the response will not be saved: |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1400 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1401 proxy_no_cache $cookie_nocache $arg_nocache$arg_comment; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1402 proxy_no_cache $http_pragma $http_authorization; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1403 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1404 Can be used along with the <link id="proxy_cache_bypass"/> directive. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1405 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1406 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1407 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1408 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1409 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1410 <directive name="proxy_pass"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1411 <syntax><value>URL</value></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1412 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1413 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1414 <context>if in location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1415 <context>limit_except</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1416 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1417 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1418 Sets the protocol and address of a proxied server and an optional URI |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1419 to which a location should be mapped. |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1420 As a protocol, “<literal>http</literal>” or “<literal>https</literal>” |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1421 can be specified. |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1422 The address can be specified as a domain name or IP address, |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1423 and an optional port: |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1424 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1425 proxy_pass http://localhost:8000/uri/; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1426 </example> |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1427 or as a UNIX-domain socket path specified after the word |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1428 “<literal>unix</literal>” and enclosed in colons: |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1429 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1430 proxy_pass http://unix:/tmp/backend.socket:/uri/; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1431 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1432 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1433 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1434 <para> |
294 | 1435 If a domain name resolves to several addresses, all of them will be |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1436 used in a round-robin fashion. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1437 In addition, an address can be specified as a |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1438 <link doc="ngx_http_upstream_module.xml">server group</link>. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1439 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1440 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1441 <para> |
1990
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1442 Parameter value can contain variables. |
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1443 In this case, if an address is specified as a domain name, |
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1444 the name is searched among the described server groups, |
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1445 and, if not found, is determined using a |
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1446 <link doc="ngx_http_core_module.xml" id="resolver"/>. |
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1447 </para> |
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1448 |
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1449 <para> |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1450 A request URI is passed to the server as follows: |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1451 <list type="bullet" compact="no"> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1452 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1453 <listitem> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1454 If the <literal>proxy_pass</literal> directive is specified with a URI, |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1455 then when a request is passed to the server, the part of a |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1456 <link doc="ngx_http_core_module.xml" id="location">normalized</link> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1457 request URI matching the location is replaced by a URI |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1458 specified in the directive: |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1459 <example> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1460 location /name/ { |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1461 proxy_pass http://127.0.0.1/remote/; |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1462 } |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1463 </example> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1464 </listitem> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1465 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1466 <listitem> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1467 If <literal>proxy_pass</literal> is specified without a URI, |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1468 the request URI is passed to the server in the same form |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1469 as sent by a client when the original request is processed, |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1470 or the full normalized request URI is passed |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1471 when processing the changed URI: |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1472 <example> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1473 location /some/path/ { |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1474 proxy_pass http://127.0.0.1; |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1475 } |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1476 </example> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1477 <note> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1478 Before version 1.1.12, |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1479 if <literal>proxy_pass</literal> is specified without a URI, |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1480 the original request URI might be passed |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1481 instead of the changed URI in some cases. |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1482 </note> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1483 </listitem> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1484 </list> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1485 </para> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1486 |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1487 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1488 In some cases, the part of a request URI to be replaced cannot be determined: |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1489 <list type="bullet" compact="no"> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1490 |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1491 <listitem> |
1989
7bf1a73248f5
Documented that proxy_pass doesn't allow URI in named locations.
Ruslan Ermilov <ru@nginx.com>
parents:
1978
diff
changeset
|
1492 When location is specified using a regular expression, |
7bf1a73248f5
Documented that proxy_pass doesn't allow URI in named locations.
Ruslan Ermilov <ru@nginx.com>
parents:
1978
diff
changeset
|
1493 and also inside named locations. |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1494 <para> |
1989
7bf1a73248f5
Documented that proxy_pass doesn't allow URI in named locations.
Ruslan Ermilov <ru@nginx.com>
parents:
1978
diff
changeset
|
1495 In these cases, |
7bf1a73248f5
Documented that proxy_pass doesn't allow URI in named locations.
Ruslan Ermilov <ru@nginx.com>
parents:
1978
diff
changeset
|
1496 <literal>proxy_pass</literal> should be specified without a URI. |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1497 </para> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1498 </listitem> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1499 |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1500 <listitem> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1501 When the URI is changed inside a proxied location using the |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1502 <link doc="ngx_http_rewrite_module.xml" id="rewrite"/> directive, |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1503 and this same configuration will be used to process a request |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1504 (<literal>break</literal>): |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1505 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1506 location /name/ { |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1507 rewrite /name/([^/]+) /users?name=$1 break; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1508 proxy_pass http://127.0.0.1; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1509 } |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1510 </example> |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1511 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1512 In this case, the URI specified in the directive is ignored and |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1513 the full changed request URI is passed to the server. |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1514 </para> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1515 </listitem> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1516 |
1990
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1517 <listitem> |
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1518 When variables are used in <literal>proxy_pass</literal>: |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1519 <example> |
1990
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1520 location /name/ { |
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1521 proxy_pass http://127.0.0.1$request_uri; |
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1522 } |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1523 </example> |
1990
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1524 In this case, if URI is specified in the directive, |
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1525 it is passed to the server as is, |
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1526 replacing the original request URI. |
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1527 </listitem> |
a108f1ff1690
Better documented proxy_pass with variables (ticket #803).
Ruslan Ermilov <ru@nginx.com>
parents:
1989
diff
changeset
|
1528 </list> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1529 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1530 |
849 | 1531 <para> |
1532 <link doc="websocket.xml">WebSocket</link> proxying requires special | |
1533 configuration and is supported since version 1.3.13. | |
1534 </para> | |
1535 | |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1536 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1537 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1538 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1539 <directive name="proxy_pass_header"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1540 <syntax><value>field</value></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1541 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1542 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1543 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1544 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1545 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1546 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1547 Permits passing <link id="proxy_hide_header">otherwise disabled</link> header |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1548 fields from a proxied server to a client. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1549 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1550 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1551 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1552 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1553 |
789
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1554 <directive name="proxy_pass_request_body"> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1555 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1556 <default>on</default> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1557 <context>http</context> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1558 <context>server</context> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1559 <context>location</context> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1560 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1561 <para> |
966 | 1562 Indicates whether the original request body is passed |
789
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1563 to the proxied server. |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1564 <example> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1565 location /x-accel-redirect-here/ { |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1566 proxy_method GET; |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1567 proxy_pass_request_body off; |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1568 proxy_set_header Content-Length ""; |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1569 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1570 proxy_pass ... |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1571 } |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1572 </example> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1573 See also the <link id="proxy_set_header"/> and |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1574 <link id="proxy_pass_request_headers"/> directives. |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1575 </para> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1576 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1577 </directive> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1578 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1579 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1580 <directive name="proxy_pass_request_headers"> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1581 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1582 <default>on</default> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1583 <context>http</context> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1584 <context>server</context> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1585 <context>location</context> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1586 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1587 <para> |
966 | 1588 Indicates whether the header fields of the original request are passed |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1589 to the proxied server. |
789
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1590 <example> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1591 location /x-accel-redirect-here/ { |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1592 proxy_method GET; |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1593 proxy_pass_request_headers off; |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1594 proxy_pass_request_body off; |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1595 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1596 proxy_pass ... |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1597 } |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1598 </example> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1599 See also the <link id="proxy_set_header"/> and |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1600 <link id="proxy_pass_request_body"/> directives. |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1601 </para> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1602 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1603 </directive> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1604 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1605 |
1524
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1606 <directive name="proxy_read_timeout"> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1607 <syntax><value>time</value></syntax> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1608 <default>60s</default> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1609 <context>http</context> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1610 <context>server</context> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1611 <context>location</context> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1612 |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1613 <para> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1614 Defines a timeout for reading a response from the proxied server. |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1615 The timeout is set only between two successive read operations, |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1616 not for the transmission of the whole response. |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1617 If the proxied server does not transmit anything within this time, |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1618 the connection is closed. |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1619 </para> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1620 |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1621 </directive> |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1622 |
323b0d071166
Relocated proxy_read_timeout and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1499
diff
changeset
|
1623 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1624 <directive name="proxy_redirect"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1625 <syntax><literal>default</literal></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1626 <syntax><literal>off</literal></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1627 <syntax><value>redirect</value> <value>replacement</value></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1628 <default>default</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1629 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1630 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1631 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1632 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1633 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1634 Sets the text that should be changed in the <header>Location</header> |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1635 and <header>Refresh</header> header fields of a proxied server response. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1636 Suppose a proxied server returned the header field |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1637 “<literal>Location: http://localhost:8000/two/some/uri/</literal>”. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1638 The directive |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1639 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1640 proxy_redirect http://localhost:8000/two/ http://frontend/one/; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1641 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1642 will rewrite this string to |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1643 “<literal>Location: http://frontend/one/some/uri/</literal>”. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1644 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1645 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1646 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1647 A server name may be omitted in the <value>replacement</value> string: |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1648 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1649 proxy_redirect http://localhost:8000/two/ /; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1650 </example> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1651 then the primary server’s name and port, if different from 80, |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1652 will be inserted. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1653 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1654 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1655 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1656 The default replacement specified by the <literal>default</literal> parameter |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1657 uses the parameters of the |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1658 <link doc="ngx_http_core_module.xml" id="location"/> and |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1659 <link id="proxy_pass"/> directives. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1660 Hence, the two configurations below are equivalent: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1661 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1662 location /one/ { |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1663 proxy_pass http://upstream:port/two/; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1664 proxy_redirect default; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1665 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1666 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1667 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1668 location /one/ { |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1669 proxy_pass http://upstream:port/two/; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1670 proxy_redirect http://upstream:port/two/ /one/; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1671 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1672 The <literal>default</literal> parameter is not permitted if |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1673 <link id="proxy_pass"/> is specified using variables. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1674 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1675 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1676 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1677 A <value>replacement</value> string can contain variables: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1678 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1679 proxy_redirect http://localhost:8000/ http://$host:$server_port/; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1680 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1681 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1682 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1683 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1684 A <value>redirect</value> can also contain (1.1.11) variables: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1685 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1686 proxy_redirect http://$proxy_host:8000/ /; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1687 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1688 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1689 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1690 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1691 The directive can be specified (1.1.11) using regular expressions. |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1692 In this case, <value>redirect</value> should either start with |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1693 the “<literal>~</literal>” symbol for a case-sensitive matching, |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1694 or with the “<literal>~*</literal>” symbols for case-insensitive |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1695 matching. |
1149
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1146
diff
changeset
|
1696 The regular expression can contain named and positional captures, |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1697 and <value>replacement</value> can reference them: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1698 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1699 proxy_redirect ~^(http://[^:]+):\d+(/.+)$ $1$2; |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1700 proxy_redirect ~*/user/([^/]+)/(.+)$ http://$1.example.com/$2; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1701 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1702 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1703 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1704 <para> |
2598
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
1705 Several <literal>proxy_redirect</literal> directives |
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
1706 can be specified on the same level: |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1707 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1708 proxy_redirect default; |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1709 proxy_redirect http://localhost:8000/ /; |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1710 proxy_redirect http://www.example.com/ /; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1711 </example> |
2598
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
1712 The <literal>off</literal> parameter cancels the effect |
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
1713 of the <literal>proxy_redirect</literal> directives |
361a28cca097
Rephrased "off" parameter of proxy_cookie_domain/path/redirect.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2593
diff
changeset
|
1714 inherited from the previous configuration level. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1715 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1716 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1717 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1718 Using this directive, it is also possible to add host names to relative |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1719 redirects issued by a proxied server: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1720 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1721 proxy_redirect / /; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1722 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1723 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1724 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1725 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1726 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1727 |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1728 <directive name="proxy_request_buffering"> |
1659
680cbf783efe
Fixed some misuses of "value".
Ruslan Ermilov <ru@nginx.com>
parents:
1610
diff
changeset
|
1729 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1730 <default>on</default> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1731 <context>http</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1732 <context>server</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1733 <context>location</context> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1734 <appeared-in>1.7.11</appeared-in> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1735 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1736 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1737 Enables or disables buffering of a client request body. |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1738 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1739 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1740 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1741 When buffering is enabled, the entire request body is |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1742 <link doc="ngx_http_core_module.xml" id="client_body_buffer_size">read</link> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1743 from the client before sending the request to a proxied server. |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1744 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1745 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1746 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1747 When buffering is disabled, the request body is sent to the proxied server |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1748 immediately as it is received. |
1440
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1749 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
|
1750 <link id="proxy_next_upstream">next server</link> |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1751 if nginx already started sending the request body. |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1752 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1753 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1754 <para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1755 When HTTP/1.1 chunked transfer encoding is used |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1756 to send the original request body, |
1440
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1757 the request body will be buffered regardless of the directive value unless |
657885fd2b96
Corrected description of proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1437
diff
changeset
|
1758 HTTP/1.1 is <link id="proxy_http_version">enabled</link> for proxying. |
1437
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1759 </para> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1760 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1761 </directive> |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1762 |
8e7995bb8c6b
Documented proxy_request_buffering and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1414
diff
changeset
|
1763 |
773
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1764 <directive name="proxy_send_lowat"> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1765 <syntax><value>size</value></syntax> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1766 <default>0</default> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1767 <context>http</context> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1768 <context>server</context> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1769 <context>location</context> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1770 |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1771 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1772 If the directive is set to a non-zero value, nginx will try to |
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1773 minimize the number |
773
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1774 of send operations on outgoing connections to a proxied server by using either |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1775 <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
|
1776 <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
|
1777 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
|
1778 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
|
1779 </para> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1780 |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1781 <para> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1782 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
|
1783 </para> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1784 |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1785 </directive> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1786 |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1787 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1788 <directive name="proxy_send_timeout"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1789 <syntax><value>time</value></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1790 <default>60s</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1791 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1792 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1793 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1794 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1795 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1796 Sets a timeout for transmitting a request to the proxied server. |
1149
1501e5848052
Corrected the usage of the definite article.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1146
diff
changeset
|
1797 The timeout is set only between two successive write operations, |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1798 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
|
1799 If the proxied 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
|
1800 the connection is closed. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1801 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1802 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1803 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1804 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1805 |
787
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1806 <directive name="proxy_set_body"> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1807 <syntax><value>value</value></syntax> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1808 <default/> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1809 <context>http</context> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1810 <context>server</context> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1811 <context>location</context> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1812 |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1813 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1814 Allows redefining the request body passed to the proxied server. |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
1815 The <value>value</value> can contain text, variables, and their combination. |
787
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1816 </para> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1817 |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1818 </directive> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1819 |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1820 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1821 <directive name="proxy_set_header"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1822 <syntax><value>field</value> <value>value</value></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1823 <default>Host $proxy_host</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1824 <default>Connection close</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1825 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1826 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1827 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1828 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1829 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1830 Allows redefining or appending fields to the request header |
789
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1831 <link id="proxy_pass_request_headers">passed</link> to the proxied server. |
1151
4c2324a7eeea
Corrected the usage of articles and a comma.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1149
diff
changeset
|
1832 The <value>value</value> can contain text, variables, and their combinations. |
2593
eeed494bba51
Unified phrases about configuration levels and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
2560
diff
changeset
|
1833 These directives are inherited from the previous configuration level |
eeed494bba51
Unified phrases about configuration levels and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
2560
diff
changeset
|
1834 if and only if there are no <literal>proxy_set_header</literal> directives |
eeed494bba51
Unified phrases about configuration levels and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
2560
diff
changeset
|
1835 defined on the current level. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1836 By default, only two fields are redefined: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1837 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1838 proxy_set_header Host $proxy_host; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1839 proxy_set_header Connection close; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1840 </example> |
1610
2d60caa1c1dd
Documented headers that are stripped when caching is enabled.
Ruslan Ermilov <ru@nginx.com>
parents:
1599
diff
changeset
|
1841 If caching is enabled, the header fields |
2d60caa1c1dd
Documented headers that are stripped when caching is enabled.
Ruslan Ermilov <ru@nginx.com>
parents:
1599
diff
changeset
|
1842 <header>If-Modified-Since</header>, |
2d60caa1c1dd
Documented headers that are stripped when caching is enabled.
Ruslan Ermilov <ru@nginx.com>
parents:
1599
diff
changeset
|
1843 <header>If-Unmodified-Since</header>, |
2d60caa1c1dd
Documented headers that are stripped when caching is enabled.
Ruslan Ermilov <ru@nginx.com>
parents:
1599
diff
changeset
|
1844 <header>If-None-Match</header>, |
2d60caa1c1dd
Documented headers that are stripped when caching is enabled.
Ruslan Ermilov <ru@nginx.com>
parents:
1599
diff
changeset
|
1845 <header>If-Match</header>, |
2d60caa1c1dd
Documented headers that are stripped when caching is enabled.
Ruslan Ermilov <ru@nginx.com>
parents:
1599
diff
changeset
|
1846 <header>Range</header>, |
2d60caa1c1dd
Documented headers that are stripped when caching is enabled.
Ruslan Ermilov <ru@nginx.com>
parents:
1599
diff
changeset
|
1847 and |
2d60caa1c1dd
Documented headers that are stripped when caching is enabled.
Ruslan Ermilov <ru@nginx.com>
parents:
1599
diff
changeset
|
1848 <header>If-Range</header> |
2d60caa1c1dd
Documented headers that are stripped when caching is enabled.
Ruslan Ermilov <ru@nginx.com>
parents:
1599
diff
changeset
|
1849 from the original request are not passed to the proxied server. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1850 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1851 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1852 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1853 An unchanged <header>Host</header> request header field can be passed like this: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1854 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1855 proxy_set_header Host $http_host; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1856 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1857 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1858 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1859 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1860 However, if this field is not present in a client request header then |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1861 nothing will be passed. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1862 In such a case it is better to use the <var>$host</var> variable—its |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1863 value equals the server name in the <header>Host</header> request header |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1864 field or the primary server name if this field is not present: |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1865 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1866 proxy_set_header Host $host; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1867 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1868 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1869 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1870 <para> |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
1871 In addition, the server name can be passed together with the port of the |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1872 proxied server: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1873 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1874 proxy_set_header Host $host:$proxy_port; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1875 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1876 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1877 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1878 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1879 If the value of a header field is an empty string then this |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1880 field will not be passed to a proxied server: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1881 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1882 proxy_set_header Accept-Encoding ""; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1883 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1884 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1885 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1886 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1887 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1888 |
2254
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1889 <directive name="proxy_socket_keepalive"> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1890 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1891 <default>off</default> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1892 <context>http</context> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1893 <context>server</context> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1894 <context>location</context> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1895 <appeared-in>1.15.6</appeared-in> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1896 |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1897 <para> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1898 Configures the “TCP keepalive” behavior |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1899 for outgoing connections to a proxied server. |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1900 By default, the operating system’s settings are in effect for the socket. |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1901 If the directive is set to the value “<literal>on</literal>”, the |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1902 <c-def>SO_KEEPALIVE</c-def> socket option is turned on for the socket. |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1903 </para> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1904 |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1905 </directive> |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1906 |
d765ffffd08c
Documented proxy_socket_keepalive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2142
diff
changeset
|
1907 |
1372
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1908 <directive name="proxy_ssl_certificate"> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1909 <syntax><value>file</value></syntax> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1910 <default/> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1911 <context>http</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1912 <context>server</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1913 <context>location</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1914 <appeared-in>1.7.8</appeared-in> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1915 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1916 <para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1917 Specifies a <value>file</value> with the certificate in the PEM format |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1918 used for authentication to a proxied HTTPS server. |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1919 </para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1920 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1921 </directive> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1922 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1923 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1924 <directive name="proxy_ssl_certificate_key"> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1925 <syntax><value>file</value></syntax> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1926 <default/> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1927 <context>http</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1928 <context>server</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1929 <context>location</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1930 <appeared-in>1.7.8</appeared-in> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1931 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1932 <para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1933 Specifies a <value>file</value> with the secret key in the PEM format |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1934 used for authentication to a proxied HTTPS server. |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1935 </para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1936 |
1456
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1937 <para> |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1938 The value |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1939 <literal>engine</literal>:<value>name</value>:<value>id</value> |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1940 can be specified instead of the <value>file</value> (1.7.9), |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1941 which loads a secret key with a specified <value>id</value> |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1942 from the OpenSSL engine <value>name</value>. |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1943 </para> |
acba294382d6
Documented engine support in ssl_certificate_key and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1440
diff
changeset
|
1944 |
1372
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1945 </directive> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1946 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
1947 |
993
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1948 <directive name="proxy_ssl_ciphers"> |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1949 <syntax><value>ciphers</value></syntax> |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1950 <default>DEFAULT</default> |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1951 <context>http</context> |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1952 <context>server</context> |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1953 <context>location</context> |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1954 <appeared-in>1.5.6</appeared-in> |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1955 |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1956 <para> |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1957 Specifies the enabled ciphers for requests to a proxied HTTPS server. |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1958 The ciphers are specified in the format understood by the OpenSSL library. |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1959 </para> |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1960 |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1961 <para> |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1962 The full list can be viewed using the |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1963 “<command>openssl ciphers</command>” command. |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1964 </para> |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1965 |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1966 </directive> |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1967 |
a59aba3d4b67
Proxy: documented the "proxy_ssl_ciphers" directive.
Andrei Belov <defan@nginx.com>
parents:
992
diff
changeset
|
1968 |
1166
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1969 <directive name="proxy_ssl_crl"> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1970 <syntax><value>file</value></syntax> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1971 <default/> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1972 <context>http</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1973 <context>server</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1974 <context>location</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1975 <appeared-in>1.7.0</appeared-in> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1976 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1977 <para> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1978 Specifies a <value>file</value> with revoked certificates (CRL) |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1979 in the PEM format used to <link id="proxy_ssl_verify">verify</link> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1980 the certificate of the proxied HTTPS server. |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1981 </para> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1982 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1983 </directive> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1984 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1985 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1986 <directive name="proxy_ssl_name"> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1987 <syntax><value>name</value></syntax> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1988 <default>$proxy_host</default> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1989 <context>http</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1990 <context>server</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1991 <context>location</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1992 <appeared-in>1.7.0</appeared-in> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1993 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1994 <para> |
1717
e07ce4ed4dcc
Corrected usage of "allow".
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1696
diff
changeset
|
1995 Allows overriding the server name used to |
1166
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1996 <link id="proxy_ssl_verify">verify</link> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1997 the certificate of the proxied HTTPS server and to be |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1998 <link id="proxy_ssl_server_name">passed through SNI</link> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
1999 when establishing a connection with the proxied HTTPS server. |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2000 </para> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2001 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2002 <para> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2003 By default, the host part of the <link id="proxy_pass"/> URL is used. |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2004 </para> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2005 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2006 </directive> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2007 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2008 |
1372
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2009 <directive name="proxy_ssl_password_file"> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2010 <syntax><value>file</value></syntax> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2011 <default/> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2012 <context>http</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2013 <context>server</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2014 <context>location</context> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2015 <appeared-in>1.7.8</appeared-in> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2016 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2017 <para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2018 Specifies a <value>file</value> with passphrases for |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2019 <link id="proxy_ssl_certificate_key">secret keys</link> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2020 where each passphrase is specified on a separate line. |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2021 Passphrases are tried in turn when loading the key. |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2022 </para> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2023 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2024 </directive> |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2025 |
e0e1e5db06bb
Documented the proxy_ssl_certificate directive and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1353
diff
changeset
|
2026 |
2142
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2027 <directive name="proxy_ssl_protocols"> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2028 <syntax> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2029 [<literal>SSLv2</literal>] |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2030 [<literal>SSLv3</literal>] |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2031 [<literal>TLSv1</literal>] |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2032 [<literal>TLSv1.1</literal>] |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2033 [<literal>TLSv1.2</literal>] |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2034 [<literal>TLSv1.3</literal>]</syntax> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2035 <default>TLSv1 TLSv1.1 TLSv1.2</default> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2036 <context>http</context> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2037 <context>server</context> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2038 <context>location</context> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2039 <appeared-in>1.5.6</appeared-in> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2040 |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2041 <para> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2042 Enables the specified protocols for requests to a proxied HTTPS server. |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2043 </para> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2044 |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2045 </directive> |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2046 |
ca7568f67dee
Sorted directives alphabetically.
Ruslan Ermilov <ru@nginx.com>
parents:
2090
diff
changeset
|
2047 |
1166
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2048 <directive name="proxy_ssl_server_name"> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2049 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2050 <default>off</default> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2051 <context>http</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2052 <context>server</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2053 <context>location</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2054 <appeared-in>1.7.0</appeared-in> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2055 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2056 <para> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2057 Enables or disables passing of the server name through |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2058 <link url="http://en.wikipedia.org/wiki/Server_Name_Indication">TLS |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2059 Server Name Indication extension</link> (SNI, RFC 6066) |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2060 when establishing a connection with the proxied HTTPS server. |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2061 </para> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2062 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2063 </directive> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2064 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2065 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2066 <directive name="proxy_ssl_session_reuse"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2067 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2068 <default>on</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2069 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2070 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2071 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2072 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2073 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2074 Determines whether SSL sessions can be reused when working with |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2075 the proxied server. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2076 If the errors |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2077 “<literal>SSL3_GET_FINISHED:digest check failed</literal>” |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
2078 appear in the logs, try disabling session reuse. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2079 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2080 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2081 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2082 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2083 |
1166
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2084 <directive name="proxy_ssl_trusted_certificate"> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2085 <syntax><value>file</value></syntax> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2086 <default/> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2087 <context>http</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2088 <context>server</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2089 <context>location</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2090 <appeared-in>1.7.0</appeared-in> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2091 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2092 <para> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2093 Specifies a <value>file</value> with trusted CA certificates in the PEM format |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2094 used to <link id="proxy_ssl_verify">verify</link> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2095 the certificate of the proxied HTTPS server. |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2096 </para> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2097 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2098 </directive> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2099 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2100 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2101 <directive name="proxy_ssl_verify"> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2102 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2103 <default>off</default> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2104 <context>http</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2105 <context>server</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2106 <context>location</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2107 <appeared-in>1.7.0</appeared-in> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2108 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2109 <para> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2110 Enables or disables verification of the proxied HTTPS server certificate. |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2111 </para> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2112 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2113 </directive> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2114 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2115 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2116 <directive name="proxy_ssl_verify_depth"> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2117 <syntax><value>number</value></syntax> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2118 <default>1</default> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2119 <context>http</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2120 <context>server</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2121 <context>location</context> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2122 <appeared-in>1.7.0</appeared-in> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2123 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2124 <para> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2125 Sets the verification depth in the proxied HTTPS server certificates chain. |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2126 </para> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2127 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2128 </directive> |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2129 |
1d299c6f7c49
The new directives "proxy_ssl_verify" and "proxy_ssl_server_name".
Ruslan Ermilov <ru@nginx.com>
parents:
1155
diff
changeset
|
2130 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2131 <directive name="proxy_store"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2132 <syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2133 <literal>on</literal> | |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2134 <literal>off</literal> | |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2135 <value>string</value></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2136 <default>off</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2137 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2138 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2139 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2140 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2141 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2142 Enables saving of files to a disk. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2143 The <literal>on</literal> parameter saves files with paths |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2144 corresponding to the directives |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2145 <link doc="ngx_http_core_module.xml" id="alias"/> or |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2146 <link doc="ngx_http_core_module.xml" id="root"/>. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2147 The <literal>off</literal> parameter disables saving of files. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2148 In addition, the file name can be set explicitly using the |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2149 <value>string</value> with variables: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2150 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2151 proxy_store /data/www$original_uri; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2152 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2153 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2154 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2155 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2156 The modification time of files is set according to the received |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2157 <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
|
2158 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
|
2159 and then the file is renamed. |
959
fbb4cc6f8c3d
Text review of ngx_http_proxy_module.
Egor Nikitin <yegor.nikitin@gmail.com>
parents:
942
diff
changeset
|
2160 Starting from version 0.8.9, temporary files and the persistent store |
966 | 2161 can be put on different file systems. |
2162 However, be aware that in this case a file is copied | |
2163 across two file systems instead of the cheap renaming operation. | |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2164 It is thus recommended that for any given location both saved files and a |
966 | 2165 directory holding temporary files, set by the <link id="proxy_temp_path"/> |
2166 directive, are put on the same file system. | |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2167 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2168 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2169 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2170 This directive can be used to create local copies of static unchangeable |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2171 files, e.g.: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2172 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2173 location /images/ { |
1005
2275611970dd
Removed open_file_cache_errors from proxy_store examples.
Maxim Dounin <mdounin@mdounin.ru>
parents:
993
diff
changeset
|
2174 root /data/www; |
2275611970dd
Removed open_file_cache_errors from proxy_store examples.
Maxim Dounin <mdounin@mdounin.ru>
parents:
993
diff
changeset
|
2175 error_page 404 = /fetch$uri; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2176 } |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2177 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2178 location /fetch/ { |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2179 internal; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2180 |
1005
2275611970dd
Removed open_file_cache_errors from proxy_store examples.
Maxim Dounin <mdounin@mdounin.ru>
parents:
993
diff
changeset
|
2181 proxy_pass http://backend/; |
2275611970dd
Removed open_file_cache_errors from proxy_store examples.
Maxim Dounin <mdounin@mdounin.ru>
parents:
993
diff
changeset
|
2182 proxy_store on; |
2275611970dd
Removed open_file_cache_errors from proxy_store examples.
Maxim Dounin <mdounin@mdounin.ru>
parents:
993
diff
changeset
|
2183 proxy_store_access user:rw group:rw all:r; |
2275611970dd
Removed open_file_cache_errors from proxy_store examples.
Maxim Dounin <mdounin@mdounin.ru>
parents:
993
diff
changeset
|
2184 proxy_temp_path /data/temp; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2185 |
1005
2275611970dd
Removed open_file_cache_errors from proxy_store examples.
Maxim Dounin <mdounin@mdounin.ru>
parents:
993
diff
changeset
|
2186 alias /data/www/; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2187 } |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2188 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2189 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2190 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2191 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2192 or like this: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2193 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2194 location /images/ { |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2195 root /data/www; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2196 error_page 404 = @fetch; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2197 } |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2198 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2199 location @fetch { |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2200 internal; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2201 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2202 proxy_pass http://backend; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2203 proxy_store on; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2204 proxy_store_access user:rw group:rw all:r; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2205 proxy_temp_path /data/temp; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2206 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2207 root /data/www; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2208 } |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2209 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2210 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2211 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2212 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2213 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2214 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2215 <directive name="proxy_store_access"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2216 <syntax><value>users</value>:<value>permissions</value> ...</syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2217 <default>user:rw</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2218 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2219 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2220 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2221 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2222 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2223 Sets access permissions for newly created files and directories, e.g.: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2224 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2225 proxy_store_access user:rw group:rw all:r; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2226 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2227 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2228 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2229 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2230 If any <literal>group</literal> or <literal>all</literal> access permissions |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2231 are specified then <literal>user</literal> permissions may be omitted: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2232 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2233 proxy_store_access group:rw all:r; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2234 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2235 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2236 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2237 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2238 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2239 |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2240 <directive name="proxy_temp_file_write_size"> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2241 <syntax><value>size</value></syntax> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2242 <default>8k|16k</default> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2243 <context>http</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2244 <context>server</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2245 <context>location</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2246 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2247 <para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2248 Limits the <value>size</value> of data written to a temporary file |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2249 at a time, when buffering of responses from the proxied server |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2250 to temporary files is enabled. |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2251 By default, <value>size</value> is limited by two buffers set by the |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2252 <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> directives. |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2253 The maximum size of a temporary file is set by the |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2254 <link id="proxy_max_temp_file_size"/> directive. |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2255 </para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2256 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2257 </directive> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2258 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2259 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2260 <directive name="proxy_temp_path"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2261 <syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2262 <value>path</value> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2263 [<value>level1</value> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2264 [<value>level2</value> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2265 [<value>level3</value>]]]</syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2266 <default>proxy_temp</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2267 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2268 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2269 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2270 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2271 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2272 Defines a directory for storing temporary files |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
2273 with data received from proxied servers. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2274 Up to three-level subdirectory hierarchy can be used underneath the specified |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2275 directory. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2276 For example, in the following configuration |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2277 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2278 proxy_temp_path /spool/nginx/proxy_temp 1 2; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2279 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2280 a temporary file might look like this: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2281 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2282 /spool/nginx/proxy_temp/<emphasis>7</emphasis>/<emphasis>45</emphasis>/00000123<emphasis>457</emphasis> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2283 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2284 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2285 |
1384
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
2286 <para> |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
2287 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
|
2288 <link id="proxy_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
|
2289 </para> |
66ee77849563
Documented the use_temp_path parameter of the proxy_cache_path directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1382
diff
changeset
|
2290 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2291 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2292 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2293 </section> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2294 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2295 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2296 <section id="variables" name="Embedded Variables"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2297 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2298 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2299 The <literal>ngx_http_proxy_module</literal> module supports embedded variables |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2300 that can be used to compose headers using the |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2301 <link id="proxy_set_header"/> directive: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2302 <list type="tag"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2303 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1153
diff
changeset
|
2304 <tag-name id="var_proxy_host"><var>$proxy_host</var></tag-name> |
1298
c459ca97c14d
Updated description of $proxy_host and $proxy_port variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
2305 <tag-desc>name and port of a proxied server as specified in the |
c459ca97c14d
Updated description of $proxy_host and $proxy_port variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
2306 <link id="proxy_pass"/> directive;</tag-desc> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2307 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1153
diff
changeset
|
2308 <tag-name id="var_proxy_port"><var>$proxy_port</var></tag-name> |
1298
c459ca97c14d
Updated description of $proxy_host and $proxy_port variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
2309 <tag-desc>port of a proxied server as specified in the |
c459ca97c14d
Updated description of $proxy_host and $proxy_port variables.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1290
diff
changeset
|
2310 <link id="proxy_pass"/> directive, or the protocol’s default port;</tag-desc> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2311 |
1155
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1153
diff
changeset
|
2312 <tag-name id="var_proxy_add_x_forwarded_for"> |
07402a11fd8d
Assigned IDs to tags describing variables.
Vladimir Homutov <vl@nginx.com>
parents:
1153
diff
changeset
|
2313 <var>$proxy_add_x_forwarded_for</var></tag-name> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2314 <tag-desc>the <header>X-Forwarded-For</header> client request header field |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2315 with the <var>$remote_addr</var> variable appended to it, separated by a comma. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2316 If the <header>X-Forwarded-For</header> field is not present in the client |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2317 request header, the <var>$proxy_add_x_forwarded_for</var> variable is equal |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2318 to the <var>$remote_addr</var> variable.</tag-desc> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2319 </list> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2320 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2321 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2322 </section> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2323 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
2324 </module> |