Mercurial > hg > nginx-site

annotate xml/en/docs/stream/ngx_stream_proxy_module.xml @ 1622:c4c1dddfedac

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Unified *_pass address descriptions.
author Ruslan Ermilov <ru@nginx.com>
date Thu, 10 Dec 2015 17:42:48 +0300
parents 08498db38e58
children 48615cf80e20
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
1 <?xml version="1.0"?>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
2
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
3 <!--
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
4 Copyright (C) Nginx, Inc.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
5 -->
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
6
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
8
1405
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
9 <module name="Module ngx_stream_proxy_module"
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
10 link="/en/docs/stream/ngx_stream_proxy_module.html"
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
11 lang="en"
1622
c4c1dddfedac Unified *_pass address descriptions.
Ruslan Ermilov <ru@nginx.com>
parents: 1548
diff changeset
12 rev="12">
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
13
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
14 <section id="summary">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
15
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
16 <para>
1462
e69e4dbcc760 Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents: 1450
diff changeset
17 The <literal>ngx_stream_proxy_module</literal> module (1.9.0) allows passing
1405
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
18 connections to another server over TCP and UNIX-domain sockets.
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
19 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
20
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
21 </section>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
22
1394
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
23
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
24 <section id="example" name="Example Configuration">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
25
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
26 <para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
27 <example>
1405
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
28 server {
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
29 listen 127.0.0.1:12345;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
30 proxy_pass 127.0.0.1:8080;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
31 }
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
32
1405
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
33 server {
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
34 listen 12345;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
35 proxy_connect_timeout 1s;
1526
7b15698cbdb7 Updated the proxy_timeout directive for mail and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1518
diff changeset
36 proxy_timeout 1m;
1405
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
37 proxy_pass example.com:12345;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
38 }
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
39
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
40 server {
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
41 listen [::1]:12345;
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
42 proxy_pass unix:/tmp/stream.socket;
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
43 }
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
44 </example>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
45 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
46
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
47 </section>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
48
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
49
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
50 <section id="directives" name="Directives">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
51
1510
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
52 <directive name="proxy_bind">
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
53 <syntax><value>address</value> | <literal>off</literal></syntax>
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
54 <default/>
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
55 <context>stream</context>
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
56 <context>server</context>
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
57 <appeared-in>1.9.2</appeared-in>
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
58
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
59 <para>
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
60 Makes outgoing connections to a proxied server originate
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
61 from the specified local IP <value>address</value>.
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
62 The special value <literal>off</literal> cancels the effect
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
63 of the <literal>proxy_bind</literal> directive
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
64 inherited from the previous configuration level, which allows the
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
65 system to auto-assign the local IP address.
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
66 </para>
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
67
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
68 </directive>
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
69
f90c2ea1729e Documented the "proxy_bind" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1499
diff changeset
70
1548
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
71 <directive name="proxy_buffer_size">
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
72 <syntax><value>size</value></syntax>
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
73 <default>16k</default>
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
74 <context>stream</context>
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
75 <context>server</context>
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
76 <appeared-in>1.9.4</appeared-in>
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
77
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
78 <para>
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
79 Sets the <value>size</value> of the buffer used for reading data
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
80 from the proxied server.
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
81 Also sets the <value>size</value> of the buffer used for reading data
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
82 from the client.
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
83 </para>
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
84
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
85 </directive>
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
86
08498db38e58 Replaced proxy_downstream/upstream_buffer with proxy_buffer_size.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1535
diff changeset
87
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
88 <directive name="proxy_connect_timeout">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
89 <syntax><value>time</value></syntax>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
90 <default>60s</default>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
91 <context>stream</context>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
92 <context>server</context>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
93
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
94 <para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
95 Defines a timeout for establishing a connection with a proxied server.
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
96 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
97
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
98 </directive>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
99
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
100
1535
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
101 <directive name="proxy_download_rate">
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
102 <syntax><value>rate</value></syntax>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
103 <default>0</default>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
104 <context>stream</context>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
105 <context>server</context>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
106 <appeared-in>1.9.3</appeared-in>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
107
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
108 <para>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
109 Limits the speed of reading the data from the proxied server.
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
110 The <value>rate</value> is specified in bytes per second.
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
111 The zero value disables rate limiting.
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
112 The limit is set per a connection, so if nginx simultaneously opens
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
113 two connections to the proxied server,
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
114 the overall rate will be twice as much as the specified limit.
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
115 </para>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
116
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
117 </directive>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
118
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
119
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
120 <directive name="proxy_next_upstream">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
121 <syntax><literal>on</literal> | <literal>off</literal></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
122 <default>on</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
123 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
124 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
125
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
126 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
127 When a connection to the proxied server cannot be established, determines
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
128 whether a client connection will be passed to the next server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
129 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
130
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
131 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
132 Passing a connection to the next server can be limited by
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
133 <link id="proxy_next_upstream_tries">the number of tries</link>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
134 and by <link id="proxy_next_upstream_timeout">time</link>.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
135 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
136
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
137 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
138
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
139
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
140 <directive name="proxy_next_upstream_timeout">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
141 <syntax><value>time</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
142 <default>0</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
143 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
144 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
145
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
146 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
147 Limits the time allowed to pass a connection to the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
148 <link id="proxy_next_upstream">next server</link>.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
149 The <literal>0</literal> value turns off this limitation.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
150 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
151
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
152 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
153
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
154
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
155 <directive name="proxy_next_upstream_tries">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
156 <syntax><value>number</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
157 <default>0</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
158 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
159 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
160
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
161 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
162 Limits the number of possible tries for passing a connection to the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
163 <link id="proxy_next_upstream">next server</link>.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
164 The <literal>0</literal> value turns off this limitation.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
165 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
166
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
167 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
168
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
169
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
170 <directive name="proxy_pass">
1394
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
171 <syntax><value>address</value></syntax>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
172 <default/>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
173 <context>server</context>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
174
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
175 <para>
1394
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
176 Sets the address of a proxied server.
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
177 The address can be specified as a domain name or IP address,
1622
c4c1dddfedac Unified *_pass address descriptions.
Ruslan Ermilov <ru@nginx.com>
parents: 1548
diff changeset
178 and a port:
1394
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
179 <example>
1405
4569719f4247 Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1394
diff changeset
180 proxy_pass localhost:12345;
1394
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
181 </example>
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
182 or as a UNIX-domain socket path:
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
183 <example>
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
184 proxy_pass unix:/tmp/stream.socket;
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
185 </example>
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
186 </para>
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
187
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
188 <para>
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
189 If a domain name resolves to several addresses, all of them will be
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
190 used in a round-robin fashion.
1394
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
191 In addition, an address can be specified as a
66f227952864 Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents: 1367
diff changeset
192 <link doc="ngx_stream_upstream_module.xml">server group</link>.
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
193 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
194
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
195 </directive>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
196
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
197
1514
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
198 <directive name="proxy_protocol">
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
199 <syntax><literal>on</literal> | <literal>off</literal></syntax>
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
200 <default>off</default>
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
201 <context>stream</context>
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
202 <context>server</context>
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
203 <appeared-in>1.9.2</appeared-in>
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
204
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
205 <para>
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
206 Enables the
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
207 <link url="http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt">PROXY
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
208 protocol</link> for connections to a proxied server.
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
209 </para>
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
210
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
211 </directive>
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
212
eef30c3dc519 Documented the "proxy_protocol" directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1510
diff changeset
213
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
214 <directive name="proxy_ssl">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
215 <syntax><literal>on</literal> | <literal>off</literal></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
216 <default>off</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
217 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
218 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
219
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
220 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
221 Enables the SSL/TLS protocol for connections to a proxied server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
222 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
223
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
224 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
225
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
226
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
227 <directive name="proxy_ssl_certificate">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
228 <syntax><value>file</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
229 <default/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
230 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
231 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
232
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
233 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
234 Specifies a <value>file</value> with the certificate in the PEM format
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
235 used for authentication to a proxied server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
236 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
237
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
238 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
239
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
240
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
241 <directive name="proxy_ssl_certificate_key">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
242 <syntax><value>file</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
243 <default/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
244 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
245 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
246
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
247 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
248 Specifies a <value>file</value> with the secret key in the PEM format
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
249 used for authentication to a proxied server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
250 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
251
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
252 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
253
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
254
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
255 <directive name="proxy_ssl_ciphers">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
256 <syntax><value>ciphers</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
257 <default>DEFAULT</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
258 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
259 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
260
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
261 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
262 Specifies the enabled ciphers for connections to a proxied server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
263 The ciphers are specified in the format understood by the OpenSSL library.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
264 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
265
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
266 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
267 The full list can be viewed using the
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
268 “<command>openssl ciphers</command>” command.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
269 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
270
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
271 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
272
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
273
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
274 <directive name="proxy_ssl_crl">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
275 <syntax><value>file</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
276 <default/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
277 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
278 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
279
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
280 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
281 Specifies a <value>file</value> with revoked certificates (CRL)
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
282 in the PEM format used to <link id="proxy_ssl_verify">verify</link>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
283 the certificate of the proxied server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
284 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
285
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
286 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
287
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
288
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
289 <directive name="proxy_ssl_name">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
290 <syntax><value>name</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
291 <default>host from proxy_pass</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
292 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
293 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
294
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
295 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
296 Allows to override the server name used to
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
297 <link id="proxy_ssl_verify">verify</link>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
298 the certificate of the proxied server and to be
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
299 <link id="proxy_ssl_server_name">passed through SNI</link>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
300 when establishing a connection with the proxied server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
301 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
302
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
303 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
304 By default, the host part of the <link id="proxy_pass"/> address is used.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
305 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
306
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
307 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
308
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
309
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
310 <directive name="proxy_ssl_password_file">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
311 <syntax><value>file</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
312 <default/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
313 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
314 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
315
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
316 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
317 Specifies a <value>file</value> with passphrases for
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
318 <link id="proxy_ssl_certificate_key">secret keys</link>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
319 where each passphrase is specified on a separate line.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
320 Passphrases are tried in turn when loading the key.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
321 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
322
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
323 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
324
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
325
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
326 <directive name="proxy_ssl_server_name">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
327 <syntax><literal>on</literal> | <literal>off</literal></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
328 <default>off</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
329 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
330 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
331
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
332 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
333 Enables or disables passing of the server name through
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
334 <link url="http://en.wikipedia.org/wiki/Server_Name_Indication">TLS
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
335 Server Name Indication extension</link> (SNI, RFC 6066)
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
336 when establishing a connection with the proxied server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
337 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
338
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
339 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
340
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
341
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
342 <directive name="proxy_ssl_session_reuse">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
343 <syntax><literal>on</literal> | <literal>off</literal></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
344 <default>on</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
345 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
346 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
347
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
348 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
349 Determines whether SSL sessions can be reused when working with
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
350 the proxied server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
351 If the errors
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
352 “<literal>SSL3_GET_FINISHED:digest check failed</literal>”
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
353 appear in the logs, try disabling session reuse.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
354 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
355
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
356 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
357
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
358
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
359 <directive name="proxy_ssl_protocols">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
360 <syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
361 [<literal>SSLv2</literal>]
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
362 [<literal>SSLv3</literal>]
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
363 [<literal>TLSv1</literal>]
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
364 [<literal>TLSv1.1</literal>]
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
365 [<literal>TLSv1.2</literal>]</syntax>
1499
3687cc9a3592 Removed SSLv3 from the default value of ssl_protocols and friends.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1462
diff changeset
366 <default>TLSv1 TLSv1.1 TLSv1.2</default>
1450
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
367 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
368 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
369
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
370 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
371 Enables the specified protocols for connections to a proxied server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
372 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
373
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
374 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
375
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
376
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
377 <directive name="proxy_ssl_trusted_certificate">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
378 <syntax><value>file</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
379 <default/>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
380 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
381 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
382
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
383 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
384 Specifies a <value>file</value> with trusted CA certificates in the PEM format
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
385 used to <link id="proxy_ssl_verify">verify</link>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
386 the certificate of the proxied server.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
387 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
388
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
389 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
390
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
391
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
392 <directive name="proxy_ssl_verify">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
393 <syntax><literal>on</literal> | <literal>off</literal></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
394 <default>off</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
395 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
396 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
397
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
398 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
399 Enables or disables verification of the proxied server certificate.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
400 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
401
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
402 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
403
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
404
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
405 <directive name="proxy_ssl_verify_depth">
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
406 <syntax><value>number</value></syntax>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
407 <default>1</default>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
408 <context>stream</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
409 <context>server</context>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
410
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
411 <para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
412 Sets the verification depth in the proxied server certificates chain.
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
413 </para>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
414
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
415 </directive>
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
416
f5b5eefc43cb Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents: 1407
diff changeset
417
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
418 <directive name="proxy_timeout">
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
419 <syntax><value>timeout</value></syntax>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
420 <default>10m</default>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
421 <context>stream</context>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
422 <context>server</context>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
423
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
424 <para>
1526
7b15698cbdb7 Updated the proxy_timeout directive for mail and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1518
diff changeset
425 Sets the <value>timeout</value> between two successive
7b15698cbdb7 Updated the proxy_timeout directive for mail and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1518
diff changeset
426 read or write operations on client or proxied server connections.
7b15698cbdb7 Updated the proxy_timeout directive for mail and stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1518
diff changeset
427 If no data is transmitted within this time, the connection is closed.
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
428 </para>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
429
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
430 </directive>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
431
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
432
1535
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
433 <directive name="proxy_upload_rate">
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
434 <syntax><value>rate</value></syntax>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
435 <default>0</default>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
436 <context>stream</context>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
437 <context>server</context>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
438 <appeared-in>1.9.3</appeared-in>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
439
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
440 <para>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
441 Limits the speed of reading the data from the client.
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
442 The <value>rate</value> is specified in bytes per second.
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
443 The zero value disables rate limiting.
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
444 The limit is set per a connection, so if the client simultaneously opens
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
445 two connections,
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
446 the overall rate will be twice as much as the specified limit.
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
447 </para>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
448
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
449 </directive>
61b1ab5adbc9 Renamed proxy_downstream_limit_rate and proxy_upstream_limit_rate directives.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1526
diff changeset
450
1367
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
451 </section>
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
452
f1e14d87d833 Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff changeset
453 </module>