changeset 1704:792478434bb1

Documented the $proxy_protocol_port variable.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 24 May 2016 20:19:12 +0300
parents 8aa362a99f7c
children f855acbd0a94
files xml/en/docs/http/ngx_http_core_module.xml xml/ru/docs/http/ngx_http_core_module.xml
diffstat 2 files changed, 23 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_core_module.xml
+++ b/xml/en/docs/http/ngx_http_core_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_core_module"
         link="/en/docs/http/ngx_http_core_module.html"
         lang="en"
-        rev="56">
+        rev="57">
 
 <section id="directives" name="Directives">
 
@@ -2986,6 +2986,17 @@ in the <link id="listen"/> directive.
 </para>
 </tag-desc>
 
+<tag-name id="var_proxy_protocol_port"><var>$proxy_protocol_port</var></tag-name>
+<tag-desc>
+client port from the PROXY protocol header, or an empty string otherwise
+(1.11.0)
+<para>
+The PROXY protocol must be previously enabled by setting the
+<literal>proxy_protocol</literal> parameter
+in the <link id="listen"/> directive.
+</para>
+</tag-desc>
+
 <tag-name id="var_query_string"><var>$query_string</var></tag-name>
 <tag-desc>
 same as <var>$args</var>
--- a/xml/ru/docs/http/ngx_http_core_module.xml
+++ b/xml/ru/docs/http/ngx_http_core_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_core_module"
         link="/ru/docs/http/ngx_http_core_module.html"
         lang="ru"
-        rev="56">
+        rev="57">
 
 <section id="directives" name="Директивы">
 
@@ -2984,6 +2984,16 @@ cookie <value>имя</value>
 </para>
 </tag-desc>
 
+<tag-name id="var_proxy_protocol_port"><var>$proxy_protocol_port</var></tag-name>
+<tag-desc>
+порт клиента, полученный из заголовка протокола PROXY, либо пустая строка
+(1.11.0)
+<para>
+Протокол PROXY должен быть предварительно включён при помощи установки
+параметра <literal>proxy_protocol</literal> в директиве <link id="listen"/>.
+</para>
+</tag-desc>
+
 <tag-name id="var_query_string"><var>$query_string</var></tag-name>
 <tag-desc>
 то же, что и <var>$args</var>