Mercurial > hg > nginx-site
annotate xml/en/docs/http/ngx_http_mirror_module.xml @ 2282:35fd70c12f98
Resynchronized the http and stream upstream module versions.
author | Sergey Kandaurov <pluknet@nginx.com> |
---|---|
date | Tue, 27 Nov 2018 15:33:31 +0300 |
parents | 5cacd6fffade |
children | eeed494bba51 |
rev | line source |
---|---|
2016
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
1 <?xml version="1.0"?> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
2 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
3 <!-- |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
4 Copyright (C) Nginx, Inc. |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
5 --> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
6 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
8 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
9 <module name="Module ngx_http_mirror_module" |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
10 link="/en/docs/http/ngx_http_mirror_module.html" |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
11 lang="en" |
2206
5cacd6fffade
Eliminated some examples of unsafe prefix locations.
Ruslan Ermilov <ru@nginx.com>
parents:
2025
diff
changeset
|
12 rev="3"> |
2016
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
13 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
14 <section id="summary"> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
15 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
16 <para> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
17 The <literal>ngx_http_mirror_module</literal> module (1.13.4) implements |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
18 mirroring of an original request |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
19 by creating background mirror subrequests. |
2025
1fe9f481d8ce
A slight revision of the mirror module.
Ruslan Ermilov <ru@nginx.com>
parents:
2022
diff
changeset
|
20 Responses to mirror subrequests are ignored. |
2016
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
21 </para> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
22 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
23 </section> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
24 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
25 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
26 <section id="example" name="Example Configuration"> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
27 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
28 <para> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
29 <example> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
30 location / { |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
31 mirror /mirror; |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
32 proxy_pass http://backend; |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
33 } |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
34 |
2206
5cacd6fffade
Eliminated some examples of unsafe prefix locations.
Ruslan Ermilov <ru@nginx.com>
parents:
2025
diff
changeset
|
35 location = /mirror { |
2016
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
36 internal; |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
37 proxy_pass http://test_backend$request_uri; |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
38 } |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
39 </example> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
40 </para> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
41 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
42 </section> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
43 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
44 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
45 <section id="directives" name="Directives"> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
46 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
47 <directive name="mirror"> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
48 <syntax><value>uri</value> | <literal>off</literal></syntax> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
49 <default>off</default> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
50 <context>http</context> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
51 <context>server</context> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
52 <context>location</context> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
53 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
54 <para> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
55 Sets the URI to which an original request will be mirrored. |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
56 Several mirrors can be specified on the same level. |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
57 </para> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
58 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
59 </directive> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
60 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
61 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
62 <directive name="mirror_request_body"> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
63 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
64 <default>on</default> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
65 <context>http</context> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
66 <context>server</context> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
67 <context>location</context> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
68 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
69 <para> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
70 Indicates whether the client request body is mirrored. |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
71 When enabled, the client request body will be read |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
72 prior to creating mirror subrequests. |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
73 In this case, unbuffered client request body proxying |
2025
1fe9f481d8ce
A slight revision of the mirror module.
Ruslan Ermilov <ru@nginx.com>
parents:
2022
diff
changeset
|
74 set by the |
2022
632f7f467e12
Removed redundant text from links.
Ruslan Ermilov <ru@nginx.com>
parents:
2021
diff
changeset
|
75 <link doc="ngx_http_proxy_module.xml" id="proxy_request_buffering"/>, |
632f7f467e12
Removed redundant text from links.
Ruslan Ermilov <ru@nginx.com>
parents:
2021
diff
changeset
|
76 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_request_buffering"/>, |
632f7f467e12
Removed redundant text from links.
Ruslan Ermilov <ru@nginx.com>
parents:
2021
diff
changeset
|
77 <link doc="ngx_http_scgi_module.xml" id="scgi_request_buffering"/>, |
2016
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
78 and |
2022
632f7f467e12
Removed redundant text from links.
Ruslan Ermilov <ru@nginx.com>
parents:
2021
diff
changeset
|
79 <link doc="ngx_http_uwsgi_module.xml" id="uwsgi_request_buffering"/> |
2016
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
80 directives will be disabled. |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
81 <example> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
82 location / { |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
83 mirror /mirror; |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
84 mirror_request_body off; |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
85 proxy_pass http://backend; |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
86 } |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
87 |
2206
5cacd6fffade
Eliminated some examples of unsafe prefix locations.
Ruslan Ermilov <ru@nginx.com>
parents:
2025
diff
changeset
|
88 location = /mirror { |
2016
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
89 internal; |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
90 proxy_pass http://log_backend; |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
91 proxy_pass_request_body off; |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
92 proxy_set_header Content-Length ""; |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
93 proxy_set_header X-Original-URI $request_uri; |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
94 } |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
95 </example> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
96 </para> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
97 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
98 </directive> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
99 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
100 </section> |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
101 |
e6de97d14f81
Documented the mirror module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
diff
changeset
|
102 </module> |