Mercurial > hg > nginx-site
annotate xml/en/docs/stream/ngx_stream_core_module.xml @ 1846:bfac366fa1e4
Added article about nginScript.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Thu, 01 Dec 2016 20:09:24 +0300 |
parents | 59d1f512c3a0 |
children | f024ac0ec5c7 |
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_core_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_core_module.html" |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
11 lang="en" |
1798
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
12 rev="21"> |
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_core_module</literal> module |
e69e4dbcc760
Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents:
1450
diff
changeset
|
18 is available since version 1.9.0. |
e69e4dbcc760
Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents:
1450
diff
changeset
|
19 This module is not built by default, it should be enabled with the |
e69e4dbcc760
Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents:
1450
diff
changeset
|
20 <literal>--with-stream</literal> |
e69e4dbcc760
Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents:
1450
diff
changeset
|
21 configuration parameter. |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
22 </para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
23 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
24 </section> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
25 |
1394
66f227952864
Somewhat revamped the stream module documentation.
Ruslan Ermilov <ru@nginx.com>
parents:
1367
diff
changeset
|
26 |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
27 <section id="example" name="Example Configuration"> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
28 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
29 <para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
30 <example> |
1405
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
31 worker_processes auto; |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
32 |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
33 error_log /var/log/nginx/error.log info; |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
34 |
1528
3ae5301ea37a
Added the "events" section to examples of stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1507
diff
changeset
|
35 events { |
3ae5301ea37a
Added the "events" section to examples of stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1507
diff
changeset
|
36 worker_connections 1024; |
3ae5301ea37a
Added the "events" section to examples of stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1507
diff
changeset
|
37 } |
3ae5301ea37a
Added the "events" section to examples of stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1507
diff
changeset
|
38 |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
39 stream { |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
40 upstream backend { |
1405
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
41 hash $remote_addr consistent; |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
42 |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
43 server backend1.example.com:12345 weight=5; |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
44 server 127.0.0.1:12345 max_fails=3 fail_timeout=30s; |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
45 server unix:/tmp/backend3; |
1367
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 |
1662
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
48 upstream dns { |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
49 server 192.168.0.1:53535; |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
50 server dns.example.com:53; |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
51 } |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
52 |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
53 server { |
1405
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
54 listen 12345; |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
55 proxy_connect_timeout 1s; |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
56 proxy_timeout 3s; |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
57 proxy_pass backend; |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
58 } |
1405
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
59 |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
60 server { |
1662
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
61 listen 127.0.0.1:53 udp; |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
62 proxy_responses 1; |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
63 proxy_timeout 20s; |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
64 proxy_pass dns; |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
65 } |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
66 |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
67 server { |
1405
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
68 listen [::1]:12345; |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
69 proxy_pass unix:/tmp/stream.socket; |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
70 } |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
71 } |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
72 </example> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
73 </para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
74 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
75 </section> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
76 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
77 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
78 <section id="directives" name="Directives"> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
79 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
80 <directive name="listen"> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
81 <syntax> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
82 <value>address</value>:<value>port</value> |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
83 [<literal>ssl</literal>] |
1662
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
84 [<literal>udp</literal>] |
1778
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
85 [<literal>proxy_protocol</literal>] |
1502
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
86 [<literal>backlog</literal>=<value>number</value>] |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
87 [<literal>bind</literal>] |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
88 [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>] |
1493
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
89 [<literal>reuseport</literal>] |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
90 [<literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>]]</syntax> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
91 <default/> |
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 Sets the <value>address</value> and <value>port</value> for the socket |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 on which the server will accept connections. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
97 It is possible to specify just the port. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
98 The address can also be a hostname, for example: |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
99 <example> |
1405
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
100 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
|
101 listen *:12345; |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
102 listen 12345; # same as *:12345 |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
103 listen localhost:12345; |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
104 </example> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
105 IPv6 addresses are specified in square brackets: |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
106 <example> |
1405
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
107 listen [::1]:12345; |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
108 listen [::]:12345; |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
109 </example> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
110 UNIX-domain sockets are specified with the “<literal>unix:</literal>” |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
111 prefix: |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
112 <example> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
113 listen unix:/var/run/nginx.sock; |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
114 </example> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
115 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
116 </para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
117 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
118 <para> |
1462
e69e4dbcc760
Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents:
1450
diff
changeset
|
119 The <literal>ssl</literal> parameter allows specifying that all |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
120 connections accepted on this port should work in SSL mode. |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
121 </para> |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
122 |
1686
93063516f6ff
Provided the anchor link for the "listen udp" parameter.
Ruslan Ermilov <ru@nginx.com>
parents:
1662
diff
changeset
|
123 <para id="udp"> |
1662
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
124 The <literal>udp</literal> parameter configures a listening socket |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
125 for working with datagrams (1.9.13). |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
126 </para> |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
127 |
1778
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
128 <para id="proxy_protocol"> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
129 The <literal>proxy_protocol</literal> parameter (1.11.4) |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
130 allows specifying that all connections accepted on this port should use the |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
131 <link url="http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt">PROXY |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
132 protocol</link>. |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
133 </para> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
134 |
1662
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
135 <para> |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
136 The <literal>listen</literal> directive |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
137 can have several additional parameters specific to socket-related system calls. |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
138 <list type="tag"> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
139 |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
140 <tag-name> |
1502
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
141 <literal>backlog</literal>=<value>number</value> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
142 </tag-name> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
143 <tag-desc> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
144 sets the <literal>backlog</literal> parameter in the |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
145 <c-func>listen</c-func> call that limits |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
146 the maximum length for the queue of pending connections (1.9.2). |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
147 By default, |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
148 <literal>backlog</literal> is set to -1 on FreeBSD, DragonFly BSD, and Mac OS X, |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
149 and to 511 on other platforms. |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
150 </tag-desc> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
151 |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
152 <tag-name> |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
153 <literal>bind</literal> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
154 </tag-name> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
155 <tag-desc> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
156 this parameter instructs to make a separate <c-func>bind</c-func> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
157 call for a given address:port pair. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
158 The fact is that if there are several <literal>listen</literal> directives with |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
159 the same port but different addresses, and one of the |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
160 <literal>listen</literal> directives listens on all addresses |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
161 for the given port (<literal>*:</literal><value>port</value>), nginx will |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
162 <c-func>bind</c-func> only to <literal>*:</literal><value>port</value>. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
163 It should be noted that the <c-func>getsockname</c-func> system call will be |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
164 made in this case to determine the address that accepted the connection. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
165 If the <literal>ipv6only</literal> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
166 or <literal>so_keepalive</literal> parameters |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
167 are used then for a given |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
168 <value>address</value>:<value>port</value> pair |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
169 a separate <c-func>bind</c-func> call will always be made. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
170 </tag-desc> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
171 |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
172 <tag-name> |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
173 <literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
174 </tag-name> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
175 <tag-desc> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
176 this parameter determines |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
177 (via the <c-def>IPV6_V6ONLY</c-def> socket option) |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
178 whether an IPv6 socket listening on a wildcard address <literal>[::]</literal> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
179 will accept only IPv6 connections or both IPv6 and IPv4 connections. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
180 This parameter is turned on by default. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
181 It can only be set once on start. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
182 </tag-desc> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
183 |
1507
14180fa9a518
Added ids for reuseport, mentioned reuseport in news.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1502
diff
changeset
|
184 <tag-name id="reuseport"> |
1493
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
185 <literal>reuseport</literal> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
186 </tag-name> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
187 <tag-desc> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
188 this parameter (1.9.1) instructs to create an individual listening socket |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
189 for each worker process |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
190 (using the <c-def>SO_REUSEPORT</c-def> socket option), allowing a kernel |
1496
99ce48c8cce3
Corrected the "reuseport" description of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1493
diff
changeset
|
191 to distribute incoming connections between worker processes. |
1500
cd534da03d02
Added Linux kernel version in reuseport.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1496
diff
changeset
|
192 This currently works only on Linux 3.9+ and DragonFly BSD. |
1493
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
193 <note> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
194 Inappropriate use of this option may have its security |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
195 <link url="http://man7.org/linux/man-pages/man7/socket.7.html">implications</link>. |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
196 </note> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
197 </tag-desc> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
198 |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
199 <tag-name> |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
200 <literal>so_keepalive</literal>=<literal>on</literal>|<literal>off</literal>|[<value>keepidle</value>]:[<value>keepintvl</value>]:[<value>keepcnt</value>] |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
201 </tag-name> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
202 <tag-desc> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
203 this parameter configures the “TCP keepalive” behavior |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
204 for the listening socket. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
205 If this parameter is omitted then the operating system’s settings will be |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
206 in effect for the socket. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
207 If it is set to the value “<literal>on</literal>”, the |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
208 <c-def>SO_KEEPALIVE</c-def> option is turned on for the socket. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
209 If it is set to the value “<literal>off</literal>”, the |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
210 <c-def>SO_KEEPALIVE</c-def> option is turned off for the socket. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
211 Some operating systems support setting of TCP keepalive parameters on |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
212 a per-socket basis using the <c-def>TCP_KEEPIDLE</c-def>, |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
213 <c-def>TCP_KEEPINTVL</c-def>, and <c-def>TCP_KEEPCNT</c-def> socket options. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
214 On such systems (currently, Linux 2.4+, NetBSD 5+, and |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
215 FreeBSD 9.0-STABLE), they can be configured |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
216 using the <value>keepidle</value>, <value>keepintvl</value>, and |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
217 <value>keepcnt</value> parameters. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
218 One or two parameters may be omitted, in which case the system default setting |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
219 for the corresponding socket option will be in effect. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
220 For example, |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
221 <example>so_keepalive=30m::10</example> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
222 will set the idle timeout (<c-def>TCP_KEEPIDLE</c-def>) to 30 minutes, |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
223 leave the probe interval (<c-def>TCP_KEEPINTVL</c-def>) at its system default, |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
224 and set the probes count (<c-def>TCP_KEEPCNT</c-def>) to 10 probes. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 </tag-desc> |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
226 |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
227 </list> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
228 </para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
229 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
230 <para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
231 Different servers must listen on different |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
232 <value>address</value>:<value>port</value> pairs. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
233 </para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
234 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
235 </directive> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
236 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
237 |
1798
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
238 <directive name="preread_buffer_size"> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
239 <syntax><value>size</value></syntax> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
240 <default>16k</default> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
241 <context>stream</context> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
242 <context>server</context> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
243 <appeared-in>1.11.5</appeared-in> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
244 |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
245 <para> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
246 Specifies a <value>size</value> of the |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
247 <link doc="stream_processing.xml" id="preread_phase">preread</link> buffer. |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
248 </para> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
249 |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
250 </directive> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
251 |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
252 |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
253 <directive name="preread_timeout"> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
254 <syntax><value>timeout</value></syntax> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
255 <default>30s</default> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
256 <context>stream</context> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
257 <context>server</context> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
258 <appeared-in>1.11.5</appeared-in> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
259 |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
260 <para> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
261 Specifies a <value>timeout</value> of the |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
262 <link doc="stream_processing.xml" id="preread_phase">preread</link> phase. |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
263 </para> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
264 |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
265 </directive> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
266 |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
267 |
1782
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
268 <directive name="proxy_protocol_timeout"> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
269 <syntax><value>timeout</value></syntax> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
270 <default>30s</default> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
271 <context>stream</context> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
272 <context>server</context> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
273 <appeared-in>1.11.4</appeared-in> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
274 |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
275 <para> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
276 Specifies a <value>timeout</value> for |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
277 reading the PROXY protocol header to complete. |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
278 If no entire header is transmitted within this time, |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
279 the connection is closed. |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
280 </para> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
281 |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
282 </directive> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
283 |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
284 |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
285 <directive name="resolver"> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
286 <syntax> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
287 <value>address</value> ... |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
288 [<literal>valid</literal>=<value>time</value>] |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
289 [<literal>ipv6</literal>=<literal>on</literal>|<literal>off</literal>]</syntax> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
290 <default/> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
291 <context>stream</context> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
292 <context>server</context> |
1753
256774f145ac
Documented stream resolver and resolver_timeout for opensource.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1742
diff
changeset
|
293 <appeared-in>1.11.3</appeared-in> |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
294 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
295 <para> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
296 Configures name servers used to resolve names of upstream servers |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
297 into addresses, for example: |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
298 <example> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
299 resolver 127.0.0.1 [::1]:5353; |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
300 </example> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
301 An address can be specified as a domain name or IP address, |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
302 and an optional port. |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
303 If port is not specified, the port 53 is used. |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
304 Name servers are queried in a round-robin fashion. |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
305 </para> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
306 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
307 <para> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
308 By default, nginx will look up both IPv4 and IPv6 addresses while resolving. |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
309 If looking up of IPv6 addresses is not desired, |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
310 the <literal>ipv6=off</literal> parameter can be specified. |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
311 </para> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
312 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
313 <para> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
314 By default, nginx caches answers using the TTL value of a response. |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
315 The optional <literal>valid</literal> parameter allows overriding it: |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
316 <example> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
317 resolver 127.0.0.1 [::1]:5353 valid=30s; |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
318 </example> |
1462
e69e4dbcc760
Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents:
1450
diff
changeset
|
319 <note> |
1753
256774f145ac
Documented stream resolver and resolver_timeout for opensource.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1742
diff
changeset
|
320 Before version 1.11.3, this directive was available as part of our |
1462
e69e4dbcc760
Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents:
1450
diff
changeset
|
321 <commercial_version>commercial subscription</commercial_version>. |
e69e4dbcc760
Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents:
1450
diff
changeset
|
322 </note> |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
323 </para> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
324 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
325 </directive> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
326 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
327 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
328 <directive name="resolver_timeout"> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
329 <syntax><value>time</value></syntax> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
330 <default>30s</default> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
331 <context>stream</context> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
332 <context>server</context> |
1753
256774f145ac
Documented stream resolver and resolver_timeout for opensource.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1742
diff
changeset
|
333 <appeared-in>1.11.3</appeared-in> |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
334 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
335 <para> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
336 Sets a timeout for name resolution, for example: |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
337 <example> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
338 resolver_timeout 5s; |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
339 </example> |
1462
e69e4dbcc760
Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents:
1450
diff
changeset
|
340 <note> |
1753
256774f145ac
Documented stream resolver and resolver_timeout for opensource.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1742
diff
changeset
|
341 Before version 1.11.3, this directive was available as part of our |
1462
e69e4dbcc760
Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents:
1450
diff
changeset
|
342 <commercial_version>commercial subscription</commercial_version>. |
e69e4dbcc760
Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents:
1450
diff
changeset
|
343 </note> |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
344 </para> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
345 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
346 </directive> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
347 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
348 |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
349 <directive name="server"> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
350 <syntax block="yes"/> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
351 <default/> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
352 <context>stream</context> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
353 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
354 <para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
355 Sets the configuration for a server. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
356 </para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
357 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
358 </directive> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
359 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
360 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
361 <directive name="stream"> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
362 <syntax block="yes"/> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
363 <default/> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
364 <context>main</context> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
365 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
366 <para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
367 Provides the configuration file context in which the stream server directives |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
368 are specified. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
369 </para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
370 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
371 </directive> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
372 |
1546
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
373 |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
374 <directive name="tcp_nodelay"> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
375 <syntax><literal>on</literal> | <literal>off</literal></syntax> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
376 <default>on</default> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
377 <context>stream</context> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
378 <context>server</context> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
379 <appeared-in>1.9.4</appeared-in> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
380 |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
381 <para> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
382 Enables or disables the use of the <c-def>TCP_NODELAY</c-def> option. |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
383 The option is enabled for both client and proxied server connections. |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
384 </para> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
385 |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
386 </directive> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
387 |
1741
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
388 |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
389 <directive name="variables_hash_bucket_size"> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
390 <syntax><value>size</value></syntax> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
391 <default>64</default> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
392 <context>stream</context> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
393 <appeared-in>1.11.2</appeared-in> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
394 |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
395 <para> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
396 Sets the bucket size for the variables hash table. |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
397 The details of setting up hash tables are provided in a separate |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
398 <link doc="../hash.xml">document</link>. |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
399 </para> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
400 |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
401 </directive> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
402 |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
403 |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
404 <directive name="variables_hash_max_size"> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
405 <syntax><value>size</value></syntax> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
406 <default>1024</default> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
407 <context>stream</context> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
408 <appeared-in>1.11.2</appeared-in> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
409 |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
410 <para> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
411 Sets the maximum <value>size</value> of the variables hash table. |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
412 The details of setting up hash tables are provided in a separate |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
413 <link doc="../hash.xml">document</link>. |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
414 </para> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
415 |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
416 </directive> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
417 |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
418 </section> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
419 |
1742
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
420 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
421 <section id="variables" name="Embedded Variables"> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
422 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
423 <para> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
424 The <literal>ngx_stream_core_module</literal> module supports variables |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
425 since 1.11.2. |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
426 <list type="tag"> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
427 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
428 <tag-name id="var_binary_remote_addr"><var>$binary_remote_addr</var></tag-name> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
429 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
430 client address in a binary form, value’s length is always 4 bytes |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
431 for IPv4 addresses or 16 bytes for IPv6 addresses |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
432 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
433 |
1768
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
434 <tag-name id="var_bytes_received"><var>$bytes_received</var></tag-name> |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
435 <tag-desc> |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
436 number of bytes received from a client (1.11.4) |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
437 </tag-desc> |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
438 |
1742
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
439 <tag-name id="var_bytes_sent"><var>$bytes_sent</var></tag-name> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
440 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
441 number of bytes sent to a client |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
442 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
443 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
444 <tag-name id="var_connection"><var>$connection</var></tag-name> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
445 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
446 connection serial number |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
447 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
448 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
449 <tag-name id="var_hostname"><var>$hostname</var></tag-name> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
450 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
451 host name |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
452 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
453 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
454 <tag-name id="var_msec"><var>$msec</var></tag-name> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
455 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
456 current time in seconds with the milliseconds resolution |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
457 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
458 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
459 <tag-name id="var_nginx_version"><var>$nginx_version</var></tag-name> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
460 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
461 nginx version |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
462 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
463 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
464 <tag-name id="var_pid"><var>$pid</var></tag-name> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
465 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
466 PID of the worker process |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
467 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
468 |
1768
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
469 <tag-name id="var_protocol"><var>$protocol</var></tag-name> |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
470 <tag-desc> |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
471 protocol used to communicate with the client: |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
472 <literal>TCP</literal> or <literal>UDP</literal> (1.11.4) |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
473 </tag-desc> |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
474 |
1778
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
475 <tag-name id="var_proxy_protocol_addr"><var>$proxy_protocol_addr</var></tag-name> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
476 <tag-desc> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
477 client address from the PROXY protocol header, or an empty string otherwise |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
478 (1.11.4) |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
479 <para> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
480 The PROXY protocol must be previously enabled by setting the |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
481 <literal>proxy_protocol</literal> parameter |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
482 in the <link id="listen"/> directive. |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
483 </para> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
484 </tag-desc> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
485 |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
486 <tag-name id="var_proxy_protocol_port"><var>$proxy_protocol_port</var></tag-name> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
487 <tag-desc> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
488 client port from the PROXY protocol header, or an empty string otherwise |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
489 (1.11.4) |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
490 <para> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
491 The PROXY protocol must be previously enabled by setting the |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
492 <literal>proxy_protocol</literal> parameter |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
493 in the <link id="listen"/> directive. |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
494 </para> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
495 </tag-desc> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
496 |
1742
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
497 <tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
498 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
499 client address |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
500 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
501 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
502 <tag-name id="var_remote_port"><var>$remote_port</var></tag-name> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
503 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
504 client port |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
505 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
506 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
507 <tag-name id="var_server_addr"><var>$server_addr</var></tag-name> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
508 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
509 an address of the server which accepted a connection |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
510 <para> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
511 Computing a value of this variable usually requires one system call. |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
512 To avoid a system call, the <link id="listen"/> directives |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
513 must specify addresses and use the <literal>bind</literal> parameter. |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
514 </para> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
515 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
516 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
517 <tag-name id="var_server_port"><var>$server_port</var></tag-name> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
518 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
519 port of the server which accepted a connection |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
520 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
521 |
1768
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
522 <tag-name id="var_session_time"><var>$session_time</var></tag-name> |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
523 <tag-desc> |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
524 session duration in seconds with a milliseconds resolution |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
525 (1.11.4); |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
526 </tag-desc> |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
527 |
1771
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
528 <tag-name id="var_status"><var>$status</var></tag-name> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
529 <tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
530 session status (1.11.4), can be one of the following: |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
531 <list type="tag"> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
532 |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
533 <tag-name><literal>200</literal></tag-name> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
534 <tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
535 session completed successfully |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
536 </tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
537 |
1780
8df9ba4e56c6
Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1778
diff
changeset
|
538 <tag-name><literal>400</literal></tag-name> |
8df9ba4e56c6
Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1778
diff
changeset
|
539 <tag-desc> |
8df9ba4e56c6
Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1778
diff
changeset
|
540 client data could not be parsed, for example, |
8df9ba4e56c6
Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1778
diff
changeset
|
541 the <link id="proxy_protocol">PROXY protocol</link> header |
8df9ba4e56c6
Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1778
diff
changeset
|
542 </tag-desc> |
8df9ba4e56c6
Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1778
diff
changeset
|
543 |
1771
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
544 <tag-name><literal>403</literal></tag-name> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
545 <tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
546 access forbidden, for example, when access is limited for |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
547 <link doc="ngx_stream_access_module.xml">certain client addresses</link> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
548 </tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
549 |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
550 <tag-name><literal>500</literal></tag-name> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
551 <tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
552 internal server error |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
553 </tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
554 |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
555 <tag-name><literal>502</literal></tag-name> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
556 <tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
557 bad gateway, for example, |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
558 if an upstream server could not be selected or reached. |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
559 </tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
560 |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
561 <tag-name><literal>503</literal></tag-name> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
562 <tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
563 service unavailable, for example, when access is limited by the |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
564 <link doc="ngx_stream_limit_conn_module.xml">number of connections</link> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
565 </tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
566 |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
567 </list> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
568 </tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
569 |
1742
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
570 <tag-name id="var_time_iso8601"><var>$time_iso8601</var></tag-name> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
571 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
572 local time in the ISO 8601 standard format |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
573 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
574 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
575 <tag-name id="var_time_local"><var>$time_local</var></tag-name> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
576 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
577 local time in the Common Log Format |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
578 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
579 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
580 </list> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
581 </para> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
582 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
583 </section> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
584 |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
585 </module> |