Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_proxy_module.xml @ 816:c711c50bdcf4
limit_req: clarified the description of the burst= parameter.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Wed, 16 Jan 2013 14:31:09 +0400 |
parents | ed29fd8be462 |
children | 0ed4c093c026 |
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" |
815
ed29fd8be462
*_bind: variables support and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
799
diff
changeset
|
13 rev="8"> |
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> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
18 The <literal>ngx_http_proxy_module</literal> module allows to pass |
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"> |
815
ed29fd8be462
*_bind: variables support and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
799
diff
changeset
|
43 <syntax><value>address</value> | <literal>off</literal></syntax> |
772
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
44 <default/> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
45 <context>http</context> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
46 <context>server</context> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
47 <context>location</context> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
48 <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
|
49 |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
50 <para> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
51 Forces outgoing connections to a proxied server to originate |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
52 from the specified local IP <value>address</value>. |
815
ed29fd8be462
*_bind: variables support and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
799
diff
changeset
|
53 Value of the parameter can contain variables (1.3.12). |
ed29fd8be462
*_bind: variables support and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
799
diff
changeset
|
54 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
|
55 of the <literal>proxy_bind</literal> directive |
ed29fd8be462
*_bind: variables support and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
799
diff
changeset
|
56 inherited from the previous configuration level, allowing the |
ed29fd8be462
*_bind: variables support and inheritance.
Ruslan Ermilov <ru@nginx.com>
parents:
799
diff
changeset
|
57 system to auto-assign local address. |
772
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
58 </para> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
59 |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
60 </directive> |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
61 |
ce121bf644f5
Documented "bind" directive in memcached, fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
589
diff
changeset
|
62 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
63 <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
|
64 <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
|
65 <default>4k|8k</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
66 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
67 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
68 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
69 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
70 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
71 Sets <value>size</value> of the buffer used for reading the first part |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
72 of a response received from the proxied server. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
73 This part usually contains a small response header. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
74 By default, the buffer size is equal to the size of one |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
75 buffer set by the <link id="proxy_buffers"/> directive. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
76 It can be made smaller however. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
77 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
78 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
79 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
80 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
81 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
82 <directive name="proxy_buffering"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
83 <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
|
84 <default>on</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
85 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
86 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
87 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
88 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
89 <para> |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
90 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
|
91 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
92 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
93 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
94 When buffering is enabled, nginx receives 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
|
95 as soon as possible, saving it into buffers set by the |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> directives. |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
97 If the whole response does not fit into memory, part of it can be saved |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
98 to a <link id="proxy_temp_path">temporary file</link> on disk. |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
99 Writes to temporary files are controlled by the |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
100 <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
|
101 <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
|
102 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
103 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
104 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
105 When buffering is disabled, a response is passed to a client synchronously, |
362 | 106 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
|
107 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
|
108 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
|
109 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
|
110 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
111 |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
112 <para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
113 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
|
114 “<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
|
115 <header>X-Accel-Buffering</header> response header field. |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
116 This ability can be disabled using the |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
117 <link doc="ngx_http_proxy_module.xml" 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
|
118 </para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
119 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
120 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
121 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
122 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
123 <directive name="proxy_buffers"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
124 <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
|
125 <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
|
126 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
127 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
128 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
129 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
130 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
131 Sets the <value>number</value> and <value>size</value> of |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
132 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
|
133 for a single connection. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
134 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
|
135 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
|
136 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
137 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
138 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
139 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
140 |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
141 <directive name="proxy_busy_buffers_size"> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
142 <syntax><value>size</value></syntax> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
143 <default>8k|16k</default> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
144 <context>http</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
145 <context>server</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
146 <context>location</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
147 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
148 <para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
149 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
|
150 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
|
151 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
|
152 yet fully read. |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
153 In the mean time, the rest of the buffers can be used for reading a response |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
154 and, if needed, buffering part of a response to a temporary file. |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
155 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
|
156 <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
|
157 </para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
158 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
159 </directive> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
160 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
161 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
162 <directive name="proxy_cache"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
163 <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
|
164 <default>off</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
165 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
166 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
167 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
168 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
169 <para> |
575
ebcb351d9eb3
Consistently using the term "shared memory zone".
Ruslan Ermilov <ru@nginx.com>
parents:
535
diff
changeset
|
170 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
|
171 The same zone can be used in several places. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
172 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
|
173 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
|
174 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
175 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
176 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
177 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
178 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
179 <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
|
180 <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
|
181 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
182 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
183 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
184 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
185 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
186 <para> |
294 | 187 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
|
188 If at least one value of the string parameters is not empty and is not |
294 | 189 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
|
190 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
191 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
|
192 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
|
193 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
194 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
|
195 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
196 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
197 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
198 |
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 <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
|
201 <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
|
202 <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
|
203 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
204 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
205 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
206 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
207 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
208 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
|
209 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
210 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
|
211 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
212 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
|
213 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
214 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
|
215 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
216 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
217 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
218 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
219 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
220 |
302
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
221 <directive name="proxy_cache_lock"> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
222 <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
|
223 <default>off</default> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
224 <context>http</context> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
225 <context>server</context> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
226 <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
|
227 <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
|
228 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
229 <para> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
230 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
|
231 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
|
232 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
|
233 Other requests of the same cache element will either wait |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
234 for a response to appear in the cache, or the cache lock for |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
235 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
|
236 <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
|
237 </para> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
238 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
239 </directive> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
240 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
241 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
242 <directive name="proxy_cache_lock_timeout"> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
243 <syntax><value>time</value></syntax> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
244 <default>5s</default> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
245 <context>http</context> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
246 <context>server</context> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
247 <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
|
248 <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
|
249 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
250 <para> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
251 Sets a timeout for <link id="proxy_cache_lock"/>. |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
252 </para> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
253 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
254 </directive> |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
255 |
df728215db07
Documented "proxy_cache_lock", "proxy_cache_lock_timeout",
Ruslan Ermilov <ru@nginx.com>
parents:
297
diff
changeset
|
256 |
790
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
257 <directive name="proxy_cache_methods"> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
258 <syntax> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
259 <literal>GET</literal> | |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
260 <literal>HEAD</literal> | |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
261 <literal>POST</literal> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
262 ...</syntax> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
263 <default>GET HEAD</default> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
264 <context>http</context> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
265 <context>server</context> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
266 <context>location</context> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
267 <appeared-in>0.7.59</appeared-in> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
268 |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
269 <para> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
270 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
|
271 the response will be cached. |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
272 “<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
|
273 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
|
274 See also the <link id="proxy_no_cache"/> directive. |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
275 </para> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
276 |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
277 </directive> |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
278 |
ae776a353984
Documented "proxy_cache_methods" directive.
Vladimir Homutov <vl@nginx.com>
parents:
789
diff
changeset
|
279 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
280 <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
|
281 <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
|
282 <default>1</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
283 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
284 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
285 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
286 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
287 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
288 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
|
289 will be cached. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
290 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
291 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
292 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
293 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
294 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
295 <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
|
296 <syntax> |
364 | 297 <value>path</value> |
298 [<literal>levels</literal>=<value>levels</value>] | |
299 <literal>keys_zone</literal>=<value>name</value>:<value>size</value> | |
300 [<literal>inactive</literal>=<value>time</value>] | |
508
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
301 [<literal>max_size</literal>=<value>size</value>] |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
302 [<literal>loader_files</literal>=<value>number</value>] |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
303 [<literal>loader_sleep</literal>=<value>time</value>] |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
304 [<literal>loader_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
|
305 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
306 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
307 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
308 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
309 Sets path and other parameters of a cache. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
310 Cache data are stored in files. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
311 Both the key and file name in a cache are a result of |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
312 applying the MD5 function to the proxied URL. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
313 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
314 The <literal>levels</literal> parameter defines hierarchy levels of a cache. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
315 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
|
316 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
317 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
|
318 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
319 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
|
320 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
321 /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
|
322 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
323 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
324 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
325 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
326 A cached response is first written to a temporary file, then a file is renamed. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
327 Starting from version 0.8.9 temporary files and the cache can be put on |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
328 different file systems but be aware that in this case a file is copied |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
329 across two file systems instead of the cheap rename operation. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
330 It is thus recommended that for any given location both cache and a directory |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
331 holding temporary files set by the <link id="proxy_temp_path"/> directive |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
332 are put on the same file system. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
333 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
334 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
335 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
336 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
|
337 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
|
338 are configured by the <literal>keys_zone</literal> parameter. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
339 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
|
340 <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
|
341 regardless of their freshness. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
342 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
|
343 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
344 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
345 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
346 The special process “cache manager” monitors the maximum cache size set |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
347 by the <literal>max_size</literal> parameter; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
348 when this size is exceeded it removes the least recently used data. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
349 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
350 |
508
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
351 <para> |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
352 A minute after the start the special process “cache loader” is activated |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
353 that loads information about previously cached data stored on file system |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
354 into a cache zone. |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
355 A load is done in iterations. |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
356 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
|
357 are loaded (by default, 100). |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
358 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
|
359 <literal>loader_threshold</literal> parameter (by default, 200 milliseconds). |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
360 A pause is made between iterations, configured by the |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
361 <literal>loader_sleep</literal> parameter (by default, 50 milliseconds). |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
362 </para> |
5e332fafd228
Documented "cache loader" and its parameters.
Ruslan Ermilov <ru@nginx.com>
parents:
506
diff
changeset
|
363 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
364 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
365 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
366 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
367 <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
|
368 <syntax> |
364 | 369 <literal>error</literal> | |
370 <literal>timeout</literal> | | |
371 <literal>invalid_header</literal> | | |
372 <literal>updating</literal> | | |
373 <literal>http_500</literal> | | |
374 <literal>http_502</literal> | | |
375 <literal>http_503</literal> | | |
376 <literal>http_504</literal> | | |
377 <literal>http_404</literal> | | |
378 <literal>off</literal> | |
379 ...</syntax> | |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
380 <default>off</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
381 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
382 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
383 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
384 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
385 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
386 If an error occurs while working with the proxied server it is possible |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
387 to use a stale cached response. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
388 This directives determines in which cases it is permitted. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
389 The directive’s parameters match those of the |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
390 <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
|
391 </para> |
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
392 |
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
393 <para> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
394 Additionally, the <literal>updating</literal> parameter permits |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
395 to use a stale cached response if it is currently being updated. |
504
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
396 This allows to minimize the number of accesses to proxied servers |
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
397 when updating cached data. |
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
398 </para> |
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
399 |
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
400 <para> |
695f83494c19
Emphasized on what the "updating" parameter of the "proxy_cache_use_stale"
Ruslan Ermilov <ru@nginx.com>
parents:
417
diff
changeset
|
401 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
|
402 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
|
403 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
|
404 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
405 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
406 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
407 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
408 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
409 <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
|
410 <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
|
411 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
412 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
413 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
414 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
415 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
416 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
417 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
|
418 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
|
419 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
420 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
|
421 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
|
422 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
423 set 10 minutes of caching for responses with codes 200 and 302, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
424 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
|
425 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
426 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
427 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
428 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
|
429 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
430 proxy_cache_valid 5m; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
431 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
432 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
|
433 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
434 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
435 <para> |
294 | 436 In addition, it can be specified to cache any responses using the |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
437 <literal>any</literal> parameter: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
438 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
439 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
|
440 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
|
441 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
|
442 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
443 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
444 |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
445 <para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
446 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
|
447 in the response header. |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
448 This has a higher precedence than setting of caching time using the directive. |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
449 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
|
450 response in seconds. |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
451 The value 0 disables to cache a response. |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
452 If a value starts with the prefix <literal>@</literal>, it sets an absolute |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
453 time in seconds since Epoch, up to which the response may be cached. |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
454 If header does not include the <header>X-Accel-Expires</header> field, |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
455 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
|
456 <header>Expires</header> or <header>Cache-Control</header>. |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
457 If a header includes the <header>Set-Cookie</header> field, such a |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
458 response will not be cached. |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
459 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
|
460 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
|
461 </para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
462 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
463 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
464 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
465 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
466 <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
|
467 <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
|
468 <default>60s</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
469 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
470 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
471 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
472 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
473 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
474 Defines a timeout for establishing a connection with the proxied server. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
475 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
|
476 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
477 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
478 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
479 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
480 |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
481 <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
|
482 <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
|
483 <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
|
484 <default>off</default> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
485 <context>http</context> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
486 <context>server</context> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
487 <context>location</context> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
488 <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
|
489 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
490 <para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
491 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
|
492 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
|
493 proxied server response. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
494 Suppose a proxied server returned the header field |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
495 <header>Set-Cookie</header> with the attribute |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
496 “<literal>domain=localhost</literal>”. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
497 The directive |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
498 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
499 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
|
500 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
501 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
|
502 “<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
|
503 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
504 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
505 <para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
506 A dot at the beginning of the <value>domain</value> and |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
507 <value>replacement</value> strings, and the <literal>domain</literal> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
508 attribute is ignored. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
509 Matching is case-insensitive. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
510 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
511 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
512 <para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
513 The strings <value>domain</value> and <value>replacement</value> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
514 can contain variables: |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
515 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
516 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
|
517 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
518 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
519 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
520 <para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
521 A directive can also be specified using regular expressions. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
522 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
|
523 the “<literal>~</literal>” symbol. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
524 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
|
525 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
|
526 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
527 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
|
528 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
529 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
530 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
531 <para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
532 There could be several <literal>proxy_cookie_domain</literal> directives: |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
533 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
534 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
|
535 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
|
536 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
537 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
538 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
539 <para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
540 The <literal>off</literal> parameter cancels all |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
541 <literal>proxy_cookie_domain</literal> directives on the current level: |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
542 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
543 proxy_cookie_domain off; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
544 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
|
545 proxy_cookie_domain www.example.org example.org; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
546 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
547 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
548 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
549 </directive> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
550 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
551 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
552 <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
|
553 <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
|
554 <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
|
555 <default>off</default> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
556 <context>http</context> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
557 <context>server</context> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
558 <context>location</context> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
559 <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
|
560 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
561 <para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
562 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
|
563 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
|
564 proxied server response. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
565 Suppose a proxied server returned the header field |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
566 <header>Set-Cookie</header> with the attribute |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
567 “<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
|
568 The directive |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
569 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
570 proxy_cookie_path /two/ /; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
571 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
572 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
|
573 “<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
|
574 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
575 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
576 <para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
577 The strings <value>path</value> and <value>replacement</value> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
578 can contain variables: |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
579 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
580 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
|
581 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
582 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
583 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
584 <para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
585 A directive can also be specified using regular expressions. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
586 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
|
587 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
|
588 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
|
589 matching. |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
590 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
|
591 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
|
592 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
593 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
|
594 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
595 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
596 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
597 <para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
598 There could be several <literal>proxy_cookie_path</literal> directives: |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
599 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
600 proxy_cookie_path /one/ /; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
601 proxy_cookie_path / /two/; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
602 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
603 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
604 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
605 <para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
606 The <literal>off</literal> parameter cancels all |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
607 <literal>proxy_cookie_path</literal> directives on the current level: |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
608 <example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
609 proxy_cookie_path off; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
610 proxy_cookie_path /two/ /; |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
611 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
|
612 </example> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
613 </para> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
614 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
615 </directive> |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
616 |
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
617 |
799
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
618 <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
|
619 <syntax><value>size</value></syntax> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
620 <default>64</default> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
621 <context>http</context> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
622 <context>server</context> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
623 <context>location</context> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
624 |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
625 <para> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
626 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
|
627 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
|
628 directives. |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
629 Details of setting up hash tables are provided in a separate |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
630 <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
|
631 </para> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
632 |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
633 </directive> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
634 |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
635 |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
636 <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
|
637 <syntax><value>size</value></syntax> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
638 <default>512</default> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
639 <context>http</context> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
640 <context>server</context> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
641 <context>location</context> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
642 |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
643 <para> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
644 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
|
645 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
|
646 directives. |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
647 Details of setting up hash tables are provided in a separate |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
648 <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
|
649 </para> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
650 |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
651 </directive> |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
652 |
9e5847af3b2d
Documented the "proxy_headers_hash_bucket/max_size" directives.
Vladimir Homutov <vl@nginx.com>
parents:
790
diff
changeset
|
653 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
654 <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
|
655 <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
|
656 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
657 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
658 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
659 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
660 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
661 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
662 By default, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
663 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
|
664 <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
|
665 <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
|
666 server to a client. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
667 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
|
668 that will not be passed. |
294 | 669 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
|
670 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
|
671 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
672 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
673 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
674 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
675 |
316
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
676 <directive name="proxy_http_version"> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
677 <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
|
678 <default>1.0</default> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
679 <context>http</context> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
680 <context>server</context> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
681 <context>location</context> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
682 <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
|
683 |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
684 <para> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
685 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
|
686 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
|
687 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
|
688 <link doc="ngx_http_upstream_module.xml" id="keepalive"/> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
689 connections. |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
690 </para> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
691 |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
692 </directive> |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
693 |
1fb1c077658b
Documented the following directives: "keepalive", "proxy_http_version",
Ruslan Ermilov <ru@nginx.com>
parents:
310
diff
changeset
|
694 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
695 <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
|
696 <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
|
697 <default>off</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
698 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
699 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
700 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
701 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
702 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
703 Determines should the connection with a proxied server be |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
704 closed if a client closes a connection without waiting |
294 | 705 for a response. |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
706 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
707 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
708 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
709 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
710 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
711 <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
|
712 <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
|
713 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
714 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
715 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
716 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
717 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
718 <para> |
294 | 719 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
|
720 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
|
721 <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
|
722 <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
|
723 <header>X-Accel-Charset</header> (1.1.6), <header>Expires</header>, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
724 <header>Cache-Control</header>, and <header>Set-Cookie</header> (0.8.44). |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
725 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
726 |
506
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
727 <para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
728 If not disabled, processing of these header fields has the following effect: |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
729 <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
|
730 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
731 <listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
732 <header>X-Accel-Expires</header>, <header>Expires</header>, |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
733 <header>Cache-Control</header>, and <header>Set-Cookie</header> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
734 set parameters of response <link id="proxy_cache_valid">caching</link>; |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
735 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
736 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
737 <listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
738 <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
|
739 <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
|
740 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
|
741 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
742 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
743 <listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
744 <header>X-Accel-Limit-Rate</header> sets a |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
745 <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
|
746 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
|
747 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
748 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
749 <listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
750 <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
|
751 <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
|
752 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
753 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
754 <listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
755 <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
|
756 <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
|
757 of a response. |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
758 </listitem> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
759 |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
760 </list> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
761 </para> |
657848837328
Documented how nginx processes proxied server's response header fields
Ruslan Ermilov <ru@nginx.com>
parents:
504
diff
changeset
|
762 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
763 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
764 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
765 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
766 <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
|
767 <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
|
768 <default>off</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
769 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
770 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
771 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
772 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
773 <para> |
297 | 774 Determines whether proxied responses with codes greater than or equal |
775 to 400 should be passed to a client or be redirected to nginx for processing | |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
776 using the <link doc="ngx_http_core_module.xml" id="error_page"/> directive. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
777 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
778 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
779 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
780 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
781 |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
782 <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
|
783 <syntax><value>size</value></syntax> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
784 <default>1024m</default> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
785 <context>http</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
786 <context>server</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
787 <context>location</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
788 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
789 <para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
790 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
|
791 server is enabled, and the whole response does not fit into memory buffers |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
792 set by the <link id="proxy_buffer_size"/> and <link id="proxy_buffers"/> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
793 directives, part of a response can be saved to a temporary file. |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
794 This directive sets the maximum <value>size</value> of a temporary file. |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
795 The size of data written to a temporary file at a time is set |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
796 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
|
797 </para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
798 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
799 <para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
800 Value of zero disables buffering of responses to temporary files. |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
801 </para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
802 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
803 </directive> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
804 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
805 |
787
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
806 <directive name="proxy_method"> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
807 <syntax><value>method</value></syntax> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
808 <default/> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
809 <context>http</context> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
810 <context>server</context> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
811 <context>location</context> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
812 |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
813 <para> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
814 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
|
815 to the proxied server instead of the method from the client request. |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
816 </para> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
817 |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
818 </directive> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
819 |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
820 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
821 <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
|
822 <syntax> |
364 | 823 <literal>error</literal> | |
824 <literal>timeout</literal> | | |
825 <literal>invalid_header</literal> | | |
826 <literal>http_500</literal> | | |
827 <literal>http_502</literal> | | |
828 <literal>http_503</literal> | | |
829 <literal>http_504</literal> | | |
830 <literal>http_404</literal> | | |
831 <literal>off</literal> | |
832 ...</syntax> | |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
833 <default>error timeout</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
834 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
835 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
836 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
837 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
838 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
839 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
|
840 <list type="tag"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
841 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
842 <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
|
843 <tag-desc>an error occurred while establishing a connection with the |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
844 server, passing it a request, or reading the response header;</tag-desc> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
845 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
846 <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
|
847 <tag-desc>a timeout has occurred while establishing a connection with the |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
848 server, passing it a request, or reading the response header;</tag-desc> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
849 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
850 <tag-name><literal>invalid_header</literal></tag-name> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
851 <tag-desc>a server returned empty or invalid response;</tag-desc> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
852 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
853 <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
|
854 <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
|
855 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
856 <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
|
857 <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
|
858 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
859 <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
|
860 <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
|
861 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
862 <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
|
863 <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
|
864 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
865 <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
|
866 <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
|
867 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
868 <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
|
869 <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
|
870 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
871 </list> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
872 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
873 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
874 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
875 It should be understood that passing a request to the next server is |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
876 only possible if a client was not sent anything yet. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
877 That is, if an error or a timeout occurs in the middle of |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
878 transferring a response, fixing this is impossible. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
879 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
880 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
881 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
882 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
883 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
884 <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
|
885 <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
|
886 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
887 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
888 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
889 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
890 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
891 <para> |
294 | 892 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
|
893 If at least one value of the string parameters is not empty and is not |
294 | 894 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
|
895 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
896 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
|
897 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
|
898 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
899 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
|
900 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
901 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
902 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
903 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
904 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
905 <directive name="proxy_pass"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
906 <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
|
907 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
908 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
909 <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
|
910 <context>limit_except</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
911 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
912 <para> |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
913 Sets the protocol and address of a proxied server, and an optional URI |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
914 to which a location should be mapped. |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
915 A protocol can be specified as |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
916 “<literal>http</literal>” or “<literal>https</literal>”. |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
917 An address can be specified as a domain name or IP address, |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
918 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
|
919 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
920 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
|
921 </example> |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
922 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
|
923 “<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
|
924 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
925 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
|
926 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
927 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
928 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
929 <para> |
294 | 930 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
|
931 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
|
932 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
|
933 <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
|
934 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
935 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
936 <para> |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
937 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
|
938 <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
|
939 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
940 <listitem> |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
941 If <literal>proxy_pass</literal> is specified with URI, |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
942 when passing a request to the server, part of a |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
943 <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
|
944 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
|
945 specified in the directive: |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
946 <example> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
947 location /name/ { |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
948 proxy_pass http://127.0.0.1/remote/; |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
949 } |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
950 </example> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
951 </listitem> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
952 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
953 <listitem> |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
954 If <literal>proxy_pass</literal> is specified without URI, |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
955 a request URI is passed to the server in the same form |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
956 as sent by a client when processing an original request, |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
957 or the full normalized request URI is passed |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
958 when processing the changed URI: |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
959 <example> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
960 location /some/path/ { |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
961 proxy_pass http://127.0.0.1; |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
962 } |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
963 </example> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
964 <note> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
965 Before version 1.1.12, |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
966 if <literal>proxy_pass</literal> is specified without a URI, |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
967 an original request URI might be passed |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
968 instead of the changed URI in some cases. |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
969 </note> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
970 </listitem> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
971 </list> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
972 </para> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
973 |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
974 <para> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
975 In some cases, part of a request URI to be replaced cannot be determined: |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
976 <list type="bullet" compact="no"> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
977 |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
978 <listitem> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
979 When location is specified using a regular expression. |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
980 <para> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
981 In this case, the directive should be specified without URI. |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
982 </para> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
983 </listitem> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
984 |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
985 <listitem> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
986 When URI is changed inside a proxied location using the |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
987 <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
|
988 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
|
989 (<literal>break</literal>): |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
990 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
991 location /name/ { |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
992 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
|
993 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
|
994 } |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
995 </example> |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
996 <para> |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
997 In this case, a URI specified in the directive is ignored and |
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
998 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
|
999 </para> |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1000 </listitem> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1001 </list> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1002 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1003 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1004 <para> |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1005 A server name, its port and passed URI can also be specified using variables: |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1006 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1007 proxy_pass http://$host$uri; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1008 </example> |
535
f8652d663b62
Revised description of "proxy_pass".
Ruslan Ermilov <ru@nginx.com>
parents:
508
diff
changeset
|
1009 or even like this: |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1010 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1011 proxy_pass $request; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1012 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1013 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1014 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1015 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1016 In this case the server name is searched among the described |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1017 <link doc="ngx_http_upstream_module.xml">server groups</link>, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1018 and if not found is determined using a |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1019 <link doc="ngx_http_core_module.xml" id="resolver"/>. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1020 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1021 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1022 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1023 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1024 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1025 <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
|
1026 <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
|
1027 <default/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1028 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1029 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1030 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1031 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1032 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1033 Permits to pass <link id="proxy_hide_header">otherwise disabled</link> header |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1034 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
|
1035 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1036 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1037 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1038 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1039 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1040 <directive name="proxy_read_timeout"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1041 <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
|
1042 <default>60s</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1043 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1044 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1045 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1046 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1047 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1048 Defines a timeout 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
|
1049 A timeout is only set between two successive read operations, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1050 not for the transmission of the whole response. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1051 If a proxied server does not transmit anything within this time, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1052 a connection is closed. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1053 </para> |
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 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1056 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1057 |
789
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1058 <directive name="proxy_pass_request_body"> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1059 <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
|
1060 <default>on</default> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1061 <context>http</context> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1062 <context>server</context> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1063 <context>location</context> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1064 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1065 <para> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1066 If disabled, the original request body will not be passed |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1067 to the proxied server. |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1068 <example> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1069 location /x-accel-redirect-here/ { |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1070 proxy_method GET; |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1071 proxy_pass_request_body off; |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1072 proxy_set_header Content-Length ""; |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1073 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1074 proxy_pass ... |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1075 } |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1076 </example> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1077 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
|
1078 <link id="proxy_pass_request_headers"/> directives. |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1079 </para> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1080 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1081 </directive> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1082 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1083 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1084 <directive name="proxy_pass_request_headers"> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1085 <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
|
1086 <default>on</default> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1087 <context>http</context> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1088 <context>server</context> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1089 <context>location</context> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1090 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1091 <para> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1092 If disabled, header fields of the original request will not be passed to the |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1093 proxied server. |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1094 <example> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1095 location /x-accel-redirect-here/ { |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1096 proxy_method GET; |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1097 proxy_pass_request_headers off; |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1098 proxy_pass_request_body off; |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1099 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1100 proxy_pass ... |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1101 } |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1102 </example> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1103 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
|
1104 <link id="proxy_pass_request_body"/> directives. |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1105 </para> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1106 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1107 </directive> |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1108 |
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1109 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1110 <directive name="proxy_redirect"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1111 <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
|
1112 <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
|
1113 <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
|
1114 <default>default</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1115 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1116 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1117 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1118 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1119 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1120 Sets a text that should be changed in the header fields |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1121 <header>Location</header> and <header>Refresh</header> of a response |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1122 from the proxied server. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1123 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
|
1124 “<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
|
1125 The directive |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1126 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1127 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
|
1128 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1129 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
|
1130 “<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
|
1131 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1132 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1133 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1134 A server name may be omitted from the <value>replacement</value> string: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1135 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1136 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
|
1137 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1138 then the primary server’s name and a port, if different from 80, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1139 will be substituted. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1140 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1141 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1142 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1143 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
|
1144 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
|
1145 <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
|
1146 <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
|
1147 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
|
1148 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1149 location /one/ { |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1150 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
|
1151 proxy_redirect default; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1152 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1153 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1154 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1155 location /one/ { |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1156 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
|
1157 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
|
1158 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1159 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
|
1160 <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
|
1161 </para> |
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 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1164 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
|
1165 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1166 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
|
1167 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1168 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1169 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1170 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1171 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
|
1172 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1173 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
|
1174 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1175 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1176 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1177 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1178 A directive can be specified (1.1.11) using regular expressions. |
417
cbc2d1b51cb6
Documented the proxy_cookie_domain and proxy_cookie_path directives.
Ruslan Ermilov <ru@nginx.com>
parents:
405
diff
changeset
|
1179 In this case, <value>redirect</value> should either start from |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1180 the “<literal>~</literal>” symbol for a case-sensitive matching, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1181 or from the “<literal>~*</literal>” symbols for case-insensitive |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1182 matching. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1183 A regular expression can contain named and positional captures, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1184 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
|
1185 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1186 proxy_redirect ~^(http://[^:]+):\d+(/.+)$ $1$2; |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1187 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
|
1188 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1189 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1190 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1191 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1192 There could be several <literal>proxy_redirect</literal> directives: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1193 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1194 proxy_redirect default; |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1195 proxy_redirect http://localhost:8000/ /; |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1196 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
|
1197 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1198 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1199 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1200 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1201 The <literal>off</literal> parameter cancels all |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1202 <literal>proxy_redirect</literal> directives on the current level: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1203 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1204 proxy_redirect off; |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1205 proxy_redirect default; |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1206 proxy_redirect http://localhost:8000/ /; |
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1207 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
|
1208 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1209 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1210 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1211 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1212 Using this directive it is also possible to add host names to relative |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1213 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
|
1214 <example> |
351
a4fa80755eab
Consistently strip initial offset in examples.
Ruslan Ermilov <ru@nginx.com>
parents:
316
diff
changeset
|
1215 proxy_redirect / /; |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1216 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1217 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1218 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1219 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1220 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1221 |
773
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1222 <directive name="proxy_send_lowat"> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1223 <syntax><value>size</value></syntax> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1224 <default>0</default> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1225 <context>http</context> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1226 <context>server</context> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1227 <context>location</context> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1228 |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1229 <para> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1230 If set to a non-zero value, nginx will try to minimize the number |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1231 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
|
1232 <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
|
1233 <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
|
1234 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
|
1235 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
|
1236 </para> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1237 |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1238 <para> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1239 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
|
1240 </para> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1241 |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1242 </directive> |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1243 |
24b1b0101250
Documented "send_lowat" directive in fastcgi and proxy modules.
Vladimir Homutov <vl@nginx.com>
parents:
772
diff
changeset
|
1244 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1245 <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
|
1246 <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
|
1247 <default>60s</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1248 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1249 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1250 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1251 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1252 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1253 Sets a timeout for transmitting a request to the proxied server. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1254 A timeout is only set between two successive write operations, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1255 not for the transmission of the whole request. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1256 If a proxied server does not receive anything within this time, |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1257 a connection is closed. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1258 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1259 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1260 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1261 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1262 |
787
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1263 <directive name="proxy_set_body"> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1264 <syntax><value>value</value></syntax> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1265 <default/> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1266 <context>http</context> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1267 <context>server</context> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1268 <context>location</context> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1269 |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1270 <para> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1271 Allows to redefine request body passed to the proxied server. |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1272 A <value>value</value> can contain text, variables, and their combination. |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1273 </para> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1274 |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1275 </directive> |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1276 |
180a64c709d8
Documented "proxy_set_body" and "proxy_method" directives.
Vladimir Homutov <vl@nginx.com>
parents:
773
diff
changeset
|
1277 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1278 <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
|
1279 <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
|
1280 <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
|
1281 <default>Connection close</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1282 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1283 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1284 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1285 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1286 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1287 Allows to redefine or append fields to the request header |
789
1063836dacea
Documented "proxy_pass_request_body/headers" directives.
Vladimir Homutov <vl@nginx.com>
parents:
787
diff
changeset
|
1288 <link id="proxy_pass_request_headers">passed</link> 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
|
1289 A <value>value</value> can contain text, variables, and their combination. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1290 These directives are inherited from the previous level if and |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1291 only if there are no |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1292 <literal>proxy_set_header</literal> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1293 directives defined on the current level. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1294 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
|
1295 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1296 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
|
1297 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
|
1298 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1299 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1300 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1301 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1302 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
|
1303 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1304 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
|
1305 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1306 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1307 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1308 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1309 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
|
1310 nothing will be passed. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1311 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
|
1312 value equals the server name in the <header>Host</header> request header |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1313 field, or the primary server name if this field is not present: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1314 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1315 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
|
1316 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1317 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1318 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1319 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1320 In addition, a server name can be passed together with a port of the |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1321 proxied server: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1322 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1323 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
|
1324 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1325 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1326 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1327 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1328 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
|
1329 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
|
1330 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1331 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
|
1332 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1333 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1334 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1335 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1336 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1337 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1338 <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
|
1339 <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
|
1340 <default>on</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1341 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1342 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1343 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1344 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1345 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1346 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
|
1347 the proxied server. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1348 If the errors |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1349 “<literal>SSL3_GET_FINISHED:digest check failed</literal>” |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1350 appear in the logs, try to disable session reuse. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1351 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1352 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1353 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1354 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1355 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1356 <directive name="proxy_store"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1357 <syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1358 <literal>on</literal> | |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1359 <literal>off</literal> | |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1360 <value>string</value></syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1361 <default>off</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1362 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1363 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1364 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1365 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1366 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1367 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
|
1368 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
|
1369 corresponding to the directives |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1370 <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
|
1371 <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
|
1372 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
|
1373 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
|
1374 <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
|
1375 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1376 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
|
1377 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1378 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1379 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1380 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1381 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
|
1382 <header>Last-Modified</header> response header field. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1383 A response is first written to a temporary file, then a file is renamed. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1384 Starting from version 0.8.9 temporary files and the persistent store |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1385 can be put on different file systems but be aware that in this case |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1386 a file is copied across two file systems instead of the cheap rename operation. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1387 It is thus recommended that for any given location both saved files and a |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1388 directory holding temporary files set by the <link id="proxy_temp_path"/> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1389 directive are put on the same file system. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1390 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1391 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1392 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1393 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
|
1394 files, e.g.: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1395 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1396 location /images/ { |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1397 root /data/www; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1398 open_file_cache_errors off; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1399 error_page 404 = /fetch$uri; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1400 } |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1401 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1402 location /fetch/ { |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1403 internal; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1404 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1405 proxy_pass http://backend/; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1406 proxy_store on; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1407 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
|
1408 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
|
1409 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1410 alias /data/www/; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1411 } |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1412 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1413 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1414 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1415 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1416 or like this: |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1417 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1418 location /images/ { |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1419 root /data/www; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1420 error_page 404 = @fetch; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1421 } |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1422 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1423 location @fetch { |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1424 internal; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1425 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1426 proxy_pass http://backend; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1427 proxy_store on; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1428 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
|
1429 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
|
1430 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1431 root /data/www; |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1432 } |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1433 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1434 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1435 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1436 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1437 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1438 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1439 <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
|
1440 <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
|
1441 <default>user:rw</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1442 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1443 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1444 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1445 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1446 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1447 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
|
1448 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1449 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
|
1450 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1451 </para> |
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 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1454 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
|
1455 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
|
1456 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1457 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
|
1458 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1459 </para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1460 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1461 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1462 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1463 |
405
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1464 <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
|
1465 <syntax><value>size</value></syntax> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1466 <default>8k|16k</default> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1467 <context>http</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1468 <context>server</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1469 <context>location</context> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1470 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1471 <para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1472 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
|
1473 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
|
1474 to temporary files is enabled. |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1475 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
|
1476 <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
|
1477 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
|
1478 <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
|
1479 </para> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1480 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1481 </directive> |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1482 |
781b23ba3b0a
Documented the following directives: proxy_busy_buffers_size,
Ruslan Ermilov <ru@nginx.com>
parents:
364
diff
changeset
|
1483 |
281
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1484 <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
|
1485 <syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1486 <value>path</value> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1487 [<value>level1</value> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1488 [<value>level2</value> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1489 [<value>level3</value>]]]</syntax> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1490 <default>proxy_temp</default> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1491 <context>http</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1492 <context>server</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1493 <context>location</context> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1494 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1495 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1496 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
|
1497 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
|
1498 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
|
1499 directory. |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1500 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
|
1501 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1502 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
|
1503 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1504 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
|
1505 <example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1506 /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
|
1507 </example> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1508 </para> |
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 </directive> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1511 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1512 </section> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1513 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1514 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1515 <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
|
1516 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1517 <para> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1518 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
|
1519 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
|
1520 <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
|
1521 <list type="tag"> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1522 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1523 <tag-name><var>$proxy_host</var></tag-name> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1524 <tag-desc>name and port of a proxied server;</tag-desc> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1525 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1526 <tag-name><var>$proxy_port</var></tag-name> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1527 <tag-desc>port of a proxied server;</tag-desc> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1528 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1529 <tag-name><var>$proxy_add_x_forwarded_for</var></tag-name> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1530 <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
|
1531 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
|
1532 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
|
1533 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
|
1534 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
|
1535 </list> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1536 </para> |
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 </section> |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1539 |
7142ddd2764c
Translated current version of ngx_http_proxy_module documentation into English.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
1540 </module> |