Mercurial > hg > nginx-site

comparison xml/en/docs/mail/ngx_mail_core_module.xml @ 2676:468e6e14e5cc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented the PROXY protocol support in mail.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 10 Mar 2021 19:41:09 +0000
parents c8f0f30e1513
children 4d073d1b0b79
comparison
equal deleted inserted replaced
2675:893cd7724c8c 2676:468e6e14e5cc
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_mail_core_module" 10 <module name="Module ngx_mail_core_module"
11 link="/en/docs/mail/ngx_mail_core_module.html" 11 link="/en/docs/mail/ngx_mail_core_module.html"
12 lang="en" 12 lang="en"
13 rev="14"> 13 rev="15">
14 14
15 <section id="summary"> 15 <section id="summary">
16 16
17 <para> 17 <para>
18 This module is not built by default, it should be 18 This module is not built by default, it should be
76 76
77 <directive name="listen"> 77 <directive name="listen">
78 <syntax> 78 <syntax>
79 <value>address</value>:<value>port</value> 79 <value>address</value>:<value>port</value>
80 [<literal>ssl</literal>] 80 [<literal>ssl</literal>]
81 [<literal>proxy_protocol</literal>]
81 [<literal>backlog</literal>=<value>number</value>] 82 [<literal>backlog</literal>=<value>number</value>]
82 [<literal>rcvbuf</literal>=<value>size</value>] 83 [<literal>rcvbuf</literal>=<value>size</value>]
83 [<literal>sndbuf</literal>=<value>size</value>] 84 [<literal>sndbuf</literal>=<value>size</value>]
84 [<literal>bind</literal>] 85 [<literal>bind</literal>]
85 [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>] 86 [<literal>ipv6only</literal>=<literal>on</literal>|<literal>off</literal>]
117 </para> 118 </para>
118 119
119 <para> 120 <para>
120 The <literal>ssl</literal> parameter allows specifying that all 121 The <literal>ssl</literal> parameter allows specifying that all
121 connections accepted on this port should work in SSL mode. 122 connections accepted on this port should work in SSL mode.
123 </para>
124
125 <para id="proxy_protocol">
126 The <literal>proxy_protocol</literal> parameter (1.19.8)
127 allows specifying that all connections accepted on this port should use the
128 <link url="http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt">PROXY
129 protocol</link>.
130 Obtained information is passed to the
131 <link doc="ngx_mail_auth_http_module.xml" id="proxy_protocol">authentication server</link>.
122 </para> 132 </para>
123 133
124 <para> 134 <para>
125 The <literal>listen</literal> directive 135 The <literal>listen</literal> directive
126 can have several additional parameters specific to socket-related system calls. 136 can have several additional parameters specific to socket-related system calls.