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