diff xml/en/docs/mail/ngx_mail_proxy_module.xml @ 2678:a4d3e6db81b9

Documented the "proxy_protocol" directive in mail.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 10 Mar 2021 20:36:35 +0000
parents 1f8f12a32ecd
children 7ebe15d6c68d
line wrap: on
line diff
--- a/xml/en/docs/mail/ngx_mail_proxy_module.xml
+++ b/xml/en/docs/mail/ngx_mail_proxy_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_proxy_module"
         link="/en/docs/mail/ngx_mail_proxy_module.html"
         lang="en"
-        rev="4">
+        rev="5">
 
 <section id="directives" name="Directives">
 
@@ -75,6 +75,22 @@ The directive should be enabled in this 
 </directive>
 
 
+<directive name="proxy_protocol">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>mail</context>
+<context>server</context>
+<appeared-in>1.19.8</appeared-in>
+
+<para>
+Enables the
+<link url="http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt">PROXY
+protocol</link> for connections to a backend.
+</para>
+
+</directive>
+
+
 <directive name="proxy_smtp_auth">
 <syntax><literal>on</literal> | <literal>off</literal></syntax>
 <default>off</default>