Mercurial > hg > nginx-site

diff 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
line wrap: on
line diff
--- a/xml/en/docs/mail/ngx_mail_core_module.xml
+++ b/xml/en/docs/mail/ngx_mail_core_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_core_module"
         link="/en/docs/mail/ngx_mail_core_module.html"
         lang="en"
-        rev="14">
+        rev="15">
 
 <section id="summary">
 
@@ -78,6 +78,7 @@ mail {
 <syntax>
     <value>address</value>:<value>port</value>
     [<literal>ssl</literal>]
+    [<literal>proxy_protocol</literal>]
     [<literal>backlog</literal>=<value>number</value>]
     [<literal>rcvbuf</literal>=<value>size</value>]
     [<literal>sndbuf</literal>=<value>size</value>]
@@ -121,6 +122,15 @@ The <literal>ssl</literal> parameter all
 connections accepted on this port should work in SSL mode.
 </para>
 
+<para id="proxy_protocol">
+The <literal>proxy_protocol</literal> parameter (1.19.8)
+allows specifying that all connections accepted on this port should use the
+<link url="http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt">PROXY
+protocol</link>.
+Obtained information is passed to the
+<link doc="ngx_mail_auth_http_module.xml" id="proxy_protocol">authentication server</link>.
+</para>
+
 <para>
 The <literal>listen</literal> directive
 can have several additional parameters specific to socket-related system calls.