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