Mercurial > hg > nginx-site

changeset 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 893cd7724c8c
children 3760176ba83e
files xml/en/docs/mail/ngx_mail_auth_http_module.xml xml/en/docs/mail/ngx_mail_core_module.xml xml/ru/docs/mail/ngx_mail_auth_http_module.xml xml/ru/docs/mail/ngx_mail_core_module.xml
diffstat 4 files changed, 46 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/mail/ngx_mail_auth_http_module.xml
+++ b/xml/en/docs/mail/ngx_mail_auth_http_module.xml
@@ -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 @@ Auth-SSL-Fingerprint: 29d6a80a123d13355e
 </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>
--- 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.
--- a/xml/ru/docs/mail/ngx_mail_auth_http_module.xml
+++ b/xml/ru/docs/mail/ngx_mail_auth_http_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_auth_http_module"
         link="/ru/docs/mail/ngx_mail_auth_http_module.html"
         lang="ru"
-        rev="9">
+        rev="10">
 
 <section id="directives" name="Директивы">
 
@@ -238,6 +238,16 @@ Auth-SSL-Fingerprint: 29d6a80a123d13355e
 </example>
 </para>
 
+<para id="proxy_protocol">
+При использовании
+<link doc="ngx_mail_core_module.xml" id="proxy_protocol">протокола PROXY</link>,
+информация о нём передаётся в следующих заголовках запроса:
+<header>Proxy-Protocol-Addr</header>,
+<header>Proxy-Protocol-Port</header>,
+<header>Proxy-Protocol-Server-Addr</header> и
+<header>Proxy-Protocol-Server-Port</header> (1.19.8).
+</para>
+
 </section>
 
 </module>
--- a/xml/ru/docs/mail/ngx_mail_core_module.xml
+++ b/xml/ru/docs/mail/ngx_mail_core_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_core_module"
         link="/ru/docs/mail/ngx_mail_core_module.html"
         lang="ru"
-        rev="14">
+        rev="15">
 
 <section id="summary">
 
@@ -78,6 +78,7 @@ mail {
 <syntax>
     <value>адрес</value>:<value>порт</value>
     [<literal>ssl</literal>]
+    [<literal>proxy_protocol</literal>]
     [<literal>backlog</literal>=<value>число</value>]
     [<literal>rcvbuf</literal>=<value>размер</value>]
     [<literal>sndbuf</literal>=<value>размер</value>]
@@ -120,6 +121,16 @@ listen unix:/var/run/nginx.sock;
 принимаемые на данном порту, должны работать в режиме SSL.
 </para>
 
+<para id="proxy_protocol">
+Параметр <literal>proxy_protocol</literal> (1.19.8)
+указывает на то, что все соединения, принимаемые на данном порту,
+должны использовать
+<link url="http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt">протокол
+PROXY</link>.
+Полученная информация передаётся
+<link doc="ngx_mail_auth_http_module.xml" id="proxy_protocol">серверу аутентификации</link>.
+</para>
+
 <para>
 В директиве <literal>listen</literal> можно также указать несколько
 дополнительных параметров, специфичных для связанных с сокетами