changeset 1782:363249d888e1

Documented the "proxy_protocol_timeout" directive in stream.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 13 Sep 2016 18:54:58 +0300
parents 0aacc6cbc759
children 031566771bbd
files xml/en/docs/stream/ngx_stream_core_module.xml xml/ru/docs/stream/ngx_stream_core_module.xml
diffstat 2 files changed, 36 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/stream/ngx_stream_core_module.xml
+++ b/xml/en/docs/stream/ngx_stream_core_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_core_module"
         link="/en/docs/stream/ngx_stream_core_module.html"
         lang="en"
-        rev="19">
+        rev="20">
 
 <section id="summary">
 
@@ -235,6 +235,23 @@ Different servers must listen on differe
 </directive>
 
 
+<directive name="proxy_protocol_timeout">
+<syntax><value>timeout</value></syntax>
+<default>30s</default>
+<context>stream</context>
+<context>server</context>
+<appeared-in>1.11.4</appeared-in>
+
+<para>
+Specifies a <value>timeout</value> for
+reading the PROXY protocol header to complete.
+If no entire header is transmitted within this time,
+the connection is closed.
+</para>
+
+</directive>
+
+
 <directive name="resolver">
 <syntax>
     <value>address</value> ...
--- a/xml/ru/docs/stream/ngx_stream_core_module.xml
+++ b/xml/ru/docs/stream/ngx_stream_core_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_stream_core_module"
         link="/ru/docs/stream/ngx_stream_core_module.html"
         lang="ru"
-        rev="19">
+        rev="20">
 
 <section id="summary">
 
@@ -241,6 +241,23 @@ FreeBSD 9.0-STABLE)
 </directive>
 
 
+<directive name="proxy_protocol_timeout">
+<syntax><value>время</value></syntax>
+<default>30s</default>
+<context>stream</context>
+<context>server</context>
+<appeared-in>1.11.4</appeared-in>
+
+<para>
+Задаёт <value>время</value> для
+завершения операции чтения заголовка протокола PROXY.
+Если по истечении этого времени заголовок полностью не получен,
+соединение закрывается.
+</para>
+
+</directive>
+
+
 <directive name="resolver">
 <syntax>
     <value>адрес</value> ...