diff xml/en/docs/mail/ngx_mail_auth_http_module.xml @ 2676:468e6e14e5cc

Documented the PROXY protocol support in mail.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 10 Mar 2021 19:41:09 +0000
parents 9af1e88e10c8
children 96d6d66d36e4
line wrap: on
line diff
--- a/xml/en/docs/mail/ngx_mail_auth_http_module.xml	Tue Mar 09 18:44:56 2021 +0000
+++ b/xml/en/docs/mail/ngx_mail_auth_http_module.xml	Wed Mar 10 19:41:09 2021 +0000
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_auth_http_module"
         link="/en/docs/mail/ngx_mail_auth_http_module.html"
         lang="en"
-        rev="9">
+        rev="10">
 
 <section id="directives" name="Directives">
 
@@ -240,6 +240,17 @@
 </example>
 </para>
 
+<para id="proxy_protocol">
+When the
+<link doc="ngx_mail_core_module.xml" id="proxy_protocol">PROXY protocol</link>
+is used,
+its details are passed in the following request headers:
+<header>Proxy-Protocol-Addr</header>,
+<header>Proxy-Protocol-Port</header>,
+<header>Proxy-Protocol-Server-Addr</header>, and
+<header>Proxy-Protocol-Server-Port</header> (1.19.8).
+</para>
+
 </section>
 
 </module>