Mercurial > hg > nginx-site
annotate xml/en/docs/stream/ngx_stream_core_module.xml @ 3075:6fcdefd1df4e
Renamed download page.
author | Maxim Dounin <mdounin@mdounin.ru> |
---|---|
date | Tue, 09 Apr 2024 18:16:11 +0300 |
parents | 9eadb98ec770 |
children |
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" |
3043
9eadb98ec770
Free nginx: removed commercial version documentation.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2912
diff
changeset
|
12 rev="38"> |
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 { |
2179
962e1adfa032
Documented UDP streams.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2125
diff
changeset
|
61 listen 127.0.0.1:53 udp reuseport; |
1662
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
62 proxy_timeout 20s; |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
63 proxy_pass dns; |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
64 } |
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 server { |
1405
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
67 listen [::1]:12345; |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
68 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
|
69 } |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
70 } |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
71 </example> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
72 </para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
73 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
74 </section> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
75 |
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 <section id="directives" name="Directives"> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
78 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
79 <directive name="listen"> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
80 <syntax> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
81 <value>address</value>:<value>port</value> |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
82 [<literal>ssl</literal>] |
1662
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
83 [<literal>udp</literal>] |
1778
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
84 [<literal>proxy_protocol</literal>] |
2725
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
85 [<literal>fastopen</literal>=<value>number</value>] |
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>] |
1963
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
87 [<literal>rcvbuf</literal>=<value>size</value>] |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
88 [<literal>sndbuf</literal>=<value>size</value>] |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
89 [<literal>bind</literal>] |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
90 [<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
|
91 [<literal>reuseport</literal>] |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
92 [<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
|
93 <default/> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
94 <context>server</context> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
95 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
96 <para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
97 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
|
98 on which the server will accept connections. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
99 It is possible to specify just the port. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
100 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
|
101 <example> |
1405
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
102 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
|
103 listen *:12345; |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
104 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
|
105 listen localhost:12345; |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
106 </example> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
107 IPv6 addresses are specified in square brackets: |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
108 <example> |
1405
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
109 listen [::1]:12345; |
4569719f4247
Split stream module into stream_core and stream_proxy modules.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1394
diff
changeset
|
110 listen [::]:12345; |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
111 </example> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
112 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
|
113 prefix: |
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 listen unix:/var/run/nginx.sock; |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
116 </example> |
2349
0eabe2f4d365
Documented listen port ranges for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2199
diff
changeset
|
117 </para> |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
118 |
2349
0eabe2f4d365
Documented listen port ranges for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2199
diff
changeset
|
119 <para id="listen_port_range"> |
0eabe2f4d365
Documented listen port ranges for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2199
diff
changeset
|
120 Port ranges (1.15.10) are specified with the |
0eabe2f4d365
Documented listen port ranges for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2199
diff
changeset
|
121 first and last port separated by a hyphen: |
0eabe2f4d365
Documented listen port ranges for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2199
diff
changeset
|
122 <example> |
0eabe2f4d365
Documented listen port ranges for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2199
diff
changeset
|
123 listen 127.0.0.1:12345-12399; |
0eabe2f4d365
Documented listen port ranges for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2199
diff
changeset
|
124 listen 12345-12399; |
0eabe2f4d365
Documented listen port ranges for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2199
diff
changeset
|
125 </example> |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
126 </para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
127 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
128 <para> |
1462
e69e4dbcc760
Documented OSS stream modules.
Vladimir Homutov <vl@nginx.com>
parents:
1450
diff
changeset
|
129 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
|
130 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
|
131 </para> |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
132 |
1686
93063516f6ff
Provided the anchor link for the "listen udp" parameter.
Ruslan Ermilov <ru@nginx.com>
parents:
1662
diff
changeset
|
133 <para id="udp"> |
1662
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
134 The <literal>udp</literal> parameter configures a listening socket |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
135 for working with datagrams (1.9.13). |
2358
ee4eccd811cd
Added info about reuseport to stream listen udp.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2349
diff
changeset
|
136 In order to handle packets from the same address and port in the same session, |
ee4eccd811cd
Added info about reuseport to stream listen udp.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2349
diff
changeset
|
137 the <link id="reuseport"><literal>reuseport</literal></link> parameter |
ee4eccd811cd
Added info about reuseport to stream listen udp.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2349
diff
changeset
|
138 should also be specified. |
1662
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
139 </para> |
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
140 |
1778
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
141 <para id="proxy_protocol"> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
142 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
|
143 allows specifying that all connections accepted on this port should use the |
2912
7ebe15d6c68d
Updated link to the PROXY protocol specification.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2903
diff
changeset
|
144 <link url="http://www.haproxy.org/download/1.8/doc/proxy-protocol.txt">PROXY |
1778
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
145 protocol</link>. |
2125
b19d5d47c16c
Documented ver.2 of the PROXY protocol.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
146 <note> |
b19d5d47c16c
Documented ver.2 of the PROXY protocol.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
147 The PROXY protocol version 2 is supported since version 1.13.11. |
b19d5d47c16c
Documented ver.2 of the PROXY protocol.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1963
diff
changeset
|
148 </note> |
1778
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
149 </para> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
150 |
1662
48615cf80e20
Documented the UDP proxy functionality.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1546
diff
changeset
|
151 <para> |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
152 The <literal>listen</literal> directive |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
153 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
|
154 <list type="tag"> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
155 |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
156 <tag-name> |
2725
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
157 <literal>fastopen</literal>=<value>number</value> |
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
158 </tag-name> |
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
159 <tag-desc> |
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
160 enables |
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
161 “<link url="http://en.wikipedia.org/wiki/TCP_Fast_Open">TCP Fast Open</link>” |
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
162 for the listening socket (1.21.0) and |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2725
diff
changeset
|
163 <link url="https://datatracker.ietf.org/doc/html/rfc7413#section-5.1">limits</link> |
2725
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
164 the maximum length for the queue of connections that have not yet completed |
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
165 the three-way handshake. |
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
166 <note> |
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
167 Do not enable this feature unless the server can handle |
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
168 receiving the |
2831
4add6ae1296f
Updated links to datatracker.ietf.org.
Sergey Kandaurov <pluknet@nginx.com>
parents:
2725
diff
changeset
|
169 <link url="https://datatracker.ietf.org/doc/html/rfc7413#section-6.1"> |
2725
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
170 same SYN packet with data</link> more than once. |
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
171 </note> |
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
172 </tag-desc> |
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
173 |
6d082b470918
Documented "listen fastopen=" parameter in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2724
diff
changeset
|
174 <tag-name> |
1502
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
175 <literal>backlog</literal>=<value>number</value> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
176 </tag-name> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
177 <tag-desc> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
178 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
|
179 <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
|
180 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
|
181 By default, |
1911
f024ac0ec5c7
Apple rebranded Mac OS X to macOS.
Sergey Kandaurov <pluknet@nginx.com>
parents:
1798
diff
changeset
|
182 <literal>backlog</literal> is set to -1 on FreeBSD, DragonFly BSD, and macOS, |
1502
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
183 and to 511 on other platforms. |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
184 </tag-desc> |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
185 |
b628e042a15e
Documented "listen backlog=" in mail and stream.
Ruslan Ermilov <ru@nginx.com>
parents:
1500
diff
changeset
|
186 <tag-name> |
1963
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
187 <literal>rcvbuf</literal>=<value>size</value> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
188 </tag-name> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
189 <tag-desc> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
190 sets the receive buffer size |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
191 (the <c-def>SO_RCVBUF</c-def> option) for the listening socket (1.11.13). |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
192 </tag-desc> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
193 |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
194 <tag-name> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
195 <literal>sndbuf</literal>=<value>size</value> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
196 </tag-name> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
197 <tag-desc> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
198 sets the send buffer size |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
199 (the <c-def>SO_SNDBUF</c-def> option) for the listening socket (1.11.13). |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
200 </tag-desc> |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
201 |
351cefd5ff9c
Documented rcvbuf and sndbuf for mail and stream listen directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1911
diff
changeset
|
202 <tag-name> |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
203 <literal>bind</literal> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
204 </tag-name> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
205 <tag-desc> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
206 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
|
207 call for a given address:port pair. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
208 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
|
209 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
|
210 <literal>listen</literal> directives listens on all addresses |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
211 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
|
212 <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
|
213 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
|
214 made in this case to determine the address that accepted the connection. |
2724
00afc7c4d4df
Documented listen options that imply "bind".
Ruslan Ermilov <ru@nginx.com>
parents:
2471
diff
changeset
|
215 If the <literal>backlog</literal>, |
00afc7c4d4df
Documented listen options that imply "bind".
Ruslan Ermilov <ru@nginx.com>
parents:
2471
diff
changeset
|
216 <literal>rcvbuf</literal>, <literal>sndbuf</literal>, |
00afc7c4d4df
Documented listen options that imply "bind".
Ruslan Ermilov <ru@nginx.com>
parents:
2471
diff
changeset
|
217 <literal>ipv6only</literal>, <literal>reuseport</literal>, |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
218 or <literal>so_keepalive</literal> parameters |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
219 are used then for a given |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
220 <value>address</value>:<value>port</value> pair |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
221 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
|
222 </tag-desc> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
223 |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
224 <tag-name> |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
225 <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
|
226 </tag-name> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
227 <tag-desc> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
228 this parameter determines |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
229 (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
|
230 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
|
231 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
|
232 This parameter is turned on by default. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
233 It can only be set once on start. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
234 </tag-desc> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
235 |
1507
14180fa9a518
Added ids for reuseport, mentioned reuseport in news.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1502
diff
changeset
|
236 <tag-name id="reuseport"> |
1493
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
237 <literal>reuseport</literal> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
238 </tag-name> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
239 <tag-desc> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
240 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
|
241 for each worker process |
2199
1d60e4b4ed64
Documented SO_REUSEPORT_LB for listen reuseport.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2179
diff
changeset
|
242 (using the |
1d60e4b4ed64
Documented SO_REUSEPORT_LB for listen reuseport.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2179
diff
changeset
|
243 <c-def>SO_REUSEPORT</c-def> socket option on Linux 3.9+ and DragonFly BSD, |
1d60e4b4ed64
Documented SO_REUSEPORT_LB for listen reuseport.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2179
diff
changeset
|
244 or <c-def>SO_REUSEPORT_LB</c-def> on FreeBSD 12+), allowing a kernel |
1496
99ce48c8cce3
Corrected the "reuseport" description of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1493
diff
changeset
|
245 to distribute incoming connections between worker processes. |
2199
1d60e4b4ed64
Documented SO_REUSEPORT_LB for listen reuseport.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2179
diff
changeset
|
246 This currently works only on Linux 3.9+, DragonFly BSD, |
1d60e4b4ed64
Documented SO_REUSEPORT_LB for listen reuseport.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2179
diff
changeset
|
247 and FreeBSD 12+ (1.15.1). |
1493
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
248 <note> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
249 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
|
250 <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
|
251 </note> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
252 </tag-desc> |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
253 |
9faa78768252
Documented the "reuseport" option of the "listen" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1462
diff
changeset
|
254 <tag-name> |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
255 <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
|
256 </tag-name> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
257 <tag-desc> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
258 this parameter configures the “TCP keepalive” behavior |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
259 for the listening socket. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
260 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
|
261 in effect for the socket. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
262 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
|
263 <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
|
264 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
|
265 <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
|
266 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
|
267 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
|
268 <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
|
269 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
|
270 FreeBSD 9.0-STABLE), they can be configured |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
271 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
|
272 <value>keepcnt</value> parameters. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
273 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
|
274 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
|
275 For example, |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
276 <example>so_keepalive=30m::10</example> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
277 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
|
278 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
|
279 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
|
280 </tag-desc> |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
281 |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
282 </list> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
283 </para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
284 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
285 <para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
286 Different servers must listen on different |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
287 <value>address</value>:<value>port</value> pairs. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
288 </para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
289 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
290 </directive> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
291 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
292 |
1798
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
293 <directive name="preread_buffer_size"> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
294 <syntax><value>size</value></syntax> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
295 <default>16k</default> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
296 <context>stream</context> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
297 <context>server</context> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
298 <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
|
299 |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
300 <para> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
301 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
|
302 <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
|
303 </para> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
304 |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
305 </directive> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
306 |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
307 |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
308 <directive name="preread_timeout"> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
309 <syntax><value>timeout</value></syntax> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
310 <default>30s</default> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
311 <context>stream</context> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
312 <context>server</context> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
313 <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
|
314 |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
315 <para> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
316 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
|
317 <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
|
318 </para> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
319 |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
320 </directive> |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
321 |
59d1f512c3a0
Documented the ngx_stream_ssl_preread_module module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1782
diff
changeset
|
322 |
1782
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
323 <directive name="proxy_protocol_timeout"> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
324 <syntax><value>timeout</value></syntax> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
325 <default>30s</default> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
326 <context>stream</context> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
327 <context>server</context> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
328 <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
|
329 |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
330 <para> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
331 Specifies a <value>timeout</value> for |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
332 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
|
333 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
|
334 the connection is closed. |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
335 </para> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
336 |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
337 </directive> |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
338 |
363249d888e1
Documented the "proxy_protocol_timeout" directive in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1780
diff
changeset
|
339 |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
340 <directive name="resolver"> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
341 <syntax> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
342 <value>address</value> ... |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
343 [<literal>valid</literal>=<value>time</value>] |
2870
e06cf66a9f63
Documented the "ipv4=off" parameter of the "resolver" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2831
diff
changeset
|
344 [<literal>ipv4</literal>=<literal>on</literal>|<literal>off</literal>] |
3043
9eadb98ec770
Free nginx: removed commercial version documentation.
Maxim Dounin <mdounin@mdounin.ru>
parents:
2912
diff
changeset
|
345 [<literal>ipv6</literal>=<literal>on</literal>|<literal>off</literal>]</syntax> |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
346 <default/> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
347 <context>stream</context> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
348 <context>server</context> |
1753
256774f145ac
Documented stream resolver and resolver_timeout for opensource.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1742
diff
changeset
|
349 <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
|
350 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
351 <para> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
352 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
|
353 into addresses, for example: |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
354 <example> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
355 resolver 127.0.0.1 [::1]:5353; |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
356 </example> |
2452
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2451
diff
changeset
|
357 The address can be specified as a domain name or IP address, |
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2451
diff
changeset
|
358 with an optional port. |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
359 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
|
360 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
|
361 </para> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
362 |
2452
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2451
diff
changeset
|
363 <para id="resolver_ipv6"> |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
364 By default, nginx will look up both IPv4 and IPv6 addresses while resolving. |
2870
e06cf66a9f63
Documented the "ipv4=off" parameter of the "resolver" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2831
diff
changeset
|
365 If looking up of IPv4 or IPv6 addresses is not desired, |
e06cf66a9f63
Documented the "ipv4=off" parameter of the "resolver" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2831
diff
changeset
|
366 the <literal>ipv4=off</literal> (1.23.1) or |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
367 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
|
368 </para> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
369 |
2452
4487310de7e7
Added IDs to resolver parameters, minor language fixes in resolver.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2451
diff
changeset
|
370 <para id="resolver_valid"> |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
371 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
|
372 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
|
373 <example> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
374 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
|
375 </example> |
2471
c8f0f30e1513
Added a note about DNS spoofing to all "resolver" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
2458
diff
changeset
|
376 <note> |
c8f0f30e1513
Added a note about DNS spoofing to all "resolver" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
2458
diff
changeset
|
377 To prevent DNS spoofing, it is recommended |
c8f0f30e1513
Added a note about DNS spoofing to all "resolver" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
2458
diff
changeset
|
378 configuring DNS servers in a properly secured trusted local network. |
c8f0f30e1513
Added a note about DNS spoofing to all "resolver" directives.
Ruslan Ermilov <ru@nginx.com>
parents:
2458
diff
changeset
|
379 </note> |
2451
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2358
diff
changeset
|
380 </para> |
721f78cff4ef
Documented resolver statistics for stream and mail.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2358
diff
changeset
|
381 |
1450
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
382 </directive> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
383 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
384 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
385 <directive name="resolver_timeout"> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
386 <syntax><value>time</value></syntax> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
387 <default>30s</default> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
388 <context>stream</context> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
389 <context>server</context> |
1753
256774f145ac
Documented stream resolver and resolver_timeout for opensource.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1742
diff
changeset
|
390 <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
|
391 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
392 <para> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
393 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
|
394 <example> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
395 resolver_timeout 5s; |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
396 </example> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
397 </para> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
398 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
399 </directive> |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
400 |
f5b5eefc43cb
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
1405
diff
changeset
|
401 |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
402 <directive name="server"> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
403 <syntax block="yes"/> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
404 <default/> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
405 <context>stream</context> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
406 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
407 <para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
408 Sets the configuration for a server. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
409 </para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
410 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
411 </directive> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
412 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
413 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
414 <directive name="stream"> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
415 <syntax block="yes"/> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
416 <default/> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
417 <context>main</context> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
418 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
419 <para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
420 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
|
421 are specified. |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
422 </para> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
423 |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
424 </directive> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
425 |
1546
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
426 |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
427 <directive name="tcp_nodelay"> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
428 <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
|
429 <default>on</default> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
430 <context>stream</context> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
431 <context>server</context> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
432 <appeared-in>1.9.4</appeared-in> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
433 |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
434 <para> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
435 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
|
436 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
|
437 </para> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
438 |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
439 </directive> |
8ea1813272bb
Documented the tcp_nodelay directive for stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1528
diff
changeset
|
440 |
1741
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
441 |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
442 <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
|
443 <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
|
444 <default>64</default> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
445 <context>stream</context> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
446 <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
|
447 |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
448 <para> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
449 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
|
450 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
|
451 <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
|
452 </para> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
453 |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
454 </directive> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
455 |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
456 |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
457 <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
|
458 <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
|
459 <default>1024</default> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
460 <context>stream</context> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
461 <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
|
462 |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
463 <para> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
464 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
|
465 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
|
466 <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
|
467 </para> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
468 |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
469 </directive> |
a99ebc3af3e4
Added variables_hash_bucket_size and variables_max_size in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1686
diff
changeset
|
470 |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
471 </section> |
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
472 |
1742
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
473 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
474 <section id="variables" name="Embedded Variables"> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
475 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
476 <para> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
477 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
|
478 since 1.11.2. |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
479 <list type="tag"> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
480 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
481 <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
|
482 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
483 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
|
484 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
|
485 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
486 |
1768
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
487 <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
|
488 <tag-desc> |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
489 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
|
490 </tag-desc> |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
491 |
1742
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
492 <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
|
493 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
494 number of bytes sent to a client |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
495 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
496 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
497 <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
|
498 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
499 connection serial number |
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_hostname"><var>$hostname</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 host name |
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_msec"><var>$msec</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 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
|
510 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
511 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
512 <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
|
513 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
514 nginx version |
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_pid"><var>$pid</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 PID of the worker process |
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_protocol"><var>$protocol</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 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
|
525 <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
|
526 </tag-desc> |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
527 |
1778
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
528 <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
|
529 <tag-desc> |
2457
3896055c397e
Fixed descriptions of $proxy_protocol_addr and $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
530 client address from the PROXY protocol header (1.11.4) |
1778
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
531 <para> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
532 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
|
533 <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
|
534 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
|
535 </para> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
536 </tag-desc> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
537 |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
538 <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
|
539 <tag-desc> |
2457
3896055c397e
Fixed descriptions of $proxy_protocol_addr and $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2452
diff
changeset
|
540 client port from the PROXY protocol header (1.11.4) |
1778
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
541 <para> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
542 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
|
543 <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
|
544 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
|
545 </para> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
546 </tag-desc> |
1626f1bf164c
Documented listen proxy_protocol, $proxy_protocol_addr, $proxy_protocol_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1771
diff
changeset
|
547 |
2458
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
548 <tag-name id="var_proxy_protocol_server_addr"><var>$proxy_protocol_server_addr</var></tag-name> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
549 <tag-desc> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
550 server address from the PROXY protocol header (1.17.6) |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
551 <para> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
552 The PROXY protocol must be previously enabled by setting the |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
553 <literal>proxy_protocol</literal> parameter |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
554 in the <link id="listen"/> directive. |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
555 </para> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
556 </tag-desc> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
557 |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
558 <tag-name id="var_proxy_protocol_server_port"><var>$proxy_protocol_server_port</var></tag-name> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
559 <tag-desc> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
560 server port from the PROXY protocol header (1.17.6) |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
561 <para> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
562 The PROXY protocol must be previously enabled by setting the |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
563 <literal>proxy_protocol</literal> parameter |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
564 in the <link id="listen"/> directive. |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
565 </para> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
566 </tag-desc> |
9cd5883ac546
Documented $proxy_protocol_server_addr, $proxy_protocol_server_port.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2457
diff
changeset
|
567 |
2903
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
568 <tag-name id="var_proxy_protocol_tlv_"><var>$proxy_protocol_tlv_</var><value>name</value></tag-name> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
569 <tag-desc> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
570 TLV from the PROXY Protocol header (1.23.2). |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
571 The <literal>name</literal> can be a TLV type name or its numeric value. |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
572 In the latter case, the value is hexadecimal |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
573 and should be prefixed with <literal>0x</literal>: |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
574 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
575 <example> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
576 $proxy_protocol_tlv_alpn |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
577 $proxy_protocol_tlv_0x01 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
578 </example> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
579 SSL TLVs can also be accessed by TLV type name or its numeric value, |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
580 both prefixed by <literal>ssl_</literal>: |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
581 <example> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
582 $proxy_protocol_tlv_ssl_version |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
583 $proxy_protocol_tlv_ssl_0x21 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
584 </example> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
585 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
586 <para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
587 The following TLV type names are supported: |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
588 <list type="bullet"> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
589 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
590 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
591 <literal>alpn</literal> (<literal>0x01</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
592 upper layer protocol used over the connection |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
593 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
594 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
595 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
596 <literal>authority</literal> (<literal>0x02</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
597 host name value passed by the client |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
598 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
599 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
600 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
601 <literal>unique_id</literal> (<literal>0x05</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
602 unique connection id |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
603 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
604 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
605 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
606 <literal>netns</literal> (<literal>0x30</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
607 name of the namespace |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
608 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
609 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
610 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
611 <literal>ssl</literal> (<literal>0x20</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
612 binary SSL TLV structure |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
613 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
614 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
615 </list> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
616 </para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
617 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
618 <para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
619 The following SSL TLV type names are supported: |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
620 <list type="bullet"> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
621 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
622 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
623 <literal>ssl_version</literal> (<literal>0x21</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
624 SSL version used in client connection |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
625 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
626 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
627 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
628 <literal>ssl_cn</literal> (<literal>0x22</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
629 SSL certificate Common Name |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
630 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
631 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
632 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
633 <literal>ssl_cipher</literal> (<literal>0x23</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
634 name of the used cipher |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
635 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
636 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
637 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
638 <literal>ssl_sig_alg</literal> (<literal>0x24</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
639 algorithm used to sign the certificate |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
640 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
641 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
642 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
643 <literal>ssl_key_alg</literal> (<literal>0x25</literal>)— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
644 public-key algorithm |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
645 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
646 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
647 </list> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
648 </para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
649 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
650 <para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
651 Also, the following special SSL TLV type name is supported: |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
652 <list type="bullet"> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
653 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
654 <listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
655 <literal>ssl_verify</literal>— |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
656 client SSL certificate verification result, |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
657 zero if the client presented a certificate |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
658 and it was successfully verified, and non-zero otherwise |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
659 </listitem> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
660 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
661 </list> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
662 </para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
663 |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
664 <para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
665 The PROXY protocol must be previously enabled by setting the |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
666 <literal>proxy_protocol</literal> parameter |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
667 in the <link id="listen"/> directive. |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
668 </para> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
669 </tag-desc> |
44f3b52c0679
Documented the $proxy_protocol_tlv_ variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
2870
diff
changeset
|
670 |
1742
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
671 <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
|
672 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
673 client address |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
674 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
675 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
676 <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
|
677 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
678 client port |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
679 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
680 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
681 <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
|
682 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
683 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
|
684 <para> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
685 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
|
686 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
|
687 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
|
688 </para> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
689 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
690 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
691 <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
|
692 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
693 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
|
694 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
695 |
1768
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
696 <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
|
697 <tag-desc> |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
698 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
|
699 (1.11.4); |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
700 </tag-desc> |
061b590cbe1a
Documented $bytes_received, $session_time, $protocol in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1753
diff
changeset
|
701 |
1771
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
702 <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
|
703 <tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
704 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
|
705 <list type="tag"> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
706 |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
707 <tag-name><literal>200</literal></tag-name> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
708 <tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
709 session completed successfully |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
710 </tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
711 |
1780
8df9ba4e56c6
Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1778
diff
changeset
|
712 <tag-name><literal>400</literal></tag-name> |
8df9ba4e56c6
Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1778
diff
changeset
|
713 <tag-desc> |
8df9ba4e56c6
Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1778
diff
changeset
|
714 client data could not be parsed, for example, |
8df9ba4e56c6
Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1778
diff
changeset
|
715 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
|
716 </tag-desc> |
8df9ba4e56c6
Documented 400 error in stream $status.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1778
diff
changeset
|
717 |
1771
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
718 <tag-name><literal>403</literal></tag-name> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
719 <tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
720 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
|
721 <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
|
722 </tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
723 |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
724 <tag-name><literal>500</literal></tag-name> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
725 <tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
726 internal server error |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
727 </tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
728 |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
729 <tag-name><literal>502</literal></tag-name> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
730 <tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
731 bad gateway, for example, |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
732 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
|
733 </tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
734 |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
735 <tag-name><literal>503</literal></tag-name> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
736 <tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
737 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
|
738 <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
|
739 </tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
740 |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
741 </list> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
742 </tag-desc> |
6a30f04a0208
Documented the $status variable in stream.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1768
diff
changeset
|
743 |
1742
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
744 <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
|
745 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
746 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
|
747 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
748 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
749 <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
|
750 <tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
751 local time in the Common Log Format |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
752 </tag-desc> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
753 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
754 </list> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
755 </para> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
756 |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
757 </section> |
c511b73da3a9
Documented variables in ngx_stream_core_module.
Yaroslav Zhuravlev <yar@nginx.com>
parents:
1741
diff
changeset
|
758 |
1367
f1e14d87d833
Updated commercial docs for the upcoming release.
Ruslan Ermilov <ru@nginx.com>
parents:
diff
changeset
|
759 </module> |