changeset 2254:d765ffffd08c

Documented proxy_socket_keepalive and friends.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 09 Oct 2018 19:56:33 +0300
parents a89093ff86a3
children f70180868eeb
files xml/en/docs/http/ngx_http_fastcgi_module.xml xml/en/docs/http/ngx_http_grpc_module.xml xml/en/docs/http/ngx_http_memcached_module.xml xml/en/docs/http/ngx_http_proxy_module.xml xml/en/docs/http/ngx_http_scgi_module.xml xml/en/docs/http/ngx_http_uwsgi_module.xml xml/en/docs/stream/ngx_stream_proxy_module.xml xml/ru/docs/http/ngx_http_fastcgi_module.xml xml/ru/docs/http/ngx_http_grpc_module.xml xml/ru/docs/http/ngx_http_memcached_module.xml xml/ru/docs/http/ngx_http_proxy_module.xml xml/ru/docs/http/ngx_http_scgi_module.xml xml/ru/docs/http/ngx_http_uwsgi_module.xml xml/ru/docs/stream/ngx_stream_proxy_module.xml
diffstat 14 files changed, 278 insertions(+), 14 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/http/ngx_http_fastcgi_module.xml
+++ b/xml/en/docs/http/ngx_http_fastcgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_fastcgi_module"
         link="/en/docs/http/ngx_http_fastcgi_module.html"
         lang="en"
-        rev="50">
+        rev="51">
 
 <section id="summary">
 
@@ -1428,6 +1428,25 @@ the connection is closed.
 </directive>
 
 
+<directive name="fastcgi_socket_keepalive">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.15.6</appeared-in>
+
+<para>
+Configures the “TCP keepalive” behavior
+for outgoing connections to a FastCGI server.
+By default, the operating system’s settings are in effect for the socket.
+If the directive is set to the value “<literal>on</literal>”, the
+<c-def>SO_KEEPALIVE</c-def> socket option is turned on for the socket.
+</para>
+
+</directive>
+
+
 <directive name="fastcgi_split_path_info">
 <syntax><value>regex</value></syntax>
 <default/>
--- a/xml/en/docs/http/ngx_http_grpc_module.xml
+++ b/xml/en/docs/http/ngx_http_grpc_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_grpc_module"
         link="/en/docs/http/ngx_http_grpc_module.html"
         lang="en"
-        rev="1">
+        rev="2">
 
 <section id="summary">
 
@@ -441,6 +441,25 @@ grpc_set_header Accept-Encoding "";
 </directive>
 
 
+<directive name="grpc_socket_keepalive">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.15.6</appeared-in>
+
+<para>
+Configures the “TCP keepalive” behavior
+for outgoing connections to a gRPC server.
+By default, the operating system’s settings are in effect for the socket.
+If the directive is set to the value “<literal>on</literal>”, the
+<c-def>SO_KEEPALIVE</c-def> socket option is turned on for the socket.
+</para>
+
+</directive>
+
+
 <directive name="grpc_ssl_certificate">
 <syntax><value>file</value></syntax>
 <default/>
--- a/xml/en/docs/http/ngx_http_memcached_module.xml
+++ b/xml/en/docs/http/ngx_http_memcached_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_memcached_module"
         link="/en/docs/http/ngx_http_memcached_module.html"
         lang="en"
-        rev="16">
+        rev="17">
 
 <section id="summary">
 
@@ -318,6 +318,25 @@ the connection is closed.
 
 </directive>
 
+
+<directive name="memcached_socket_keepalive">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.15.6</appeared-in>
+
+<para>
+Configures the “TCP keepalive” behavior
+for outgoing connections to a memcached server.
+By default, the operating system’s settings are in effect for the socket.
+If the directive is set to the value “<literal>on</literal>”, the
+<c-def>SO_KEEPALIVE</c-def> socket option is turned on for the socket.
+</para>
+
+</directive>
+
 </section>
 
 
--- a/xml/en/docs/http/ngx_http_proxy_module.xml
+++ b/xml/en/docs/http/ngx_http_proxy_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_proxy_module"
         link="/en/docs/http/ngx_http_proxy_module.html"
         lang="en"
-        rev="64">
+        rev="65">
 
 <section id="summary">
 
@@ -1844,6 +1844,25 @@ proxy_set_header Accept-Encoding "";
 </directive>
 
 
+<directive name="proxy_socket_keepalive">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.15.6</appeared-in>
+
+<para>
+Configures the “TCP keepalive” behavior
+for outgoing connections to a proxied server.
+By default, the operating system’s settings are in effect for the socket.
+If the directive is set to the value “<literal>on</literal>”, the
+<c-def>SO_KEEPALIVE</c-def> socket option is turned on for the socket.
+</para>
+
+</directive>
+
+
 <directive name="proxy_ssl_certificate">
 <syntax><value>file</value></syntax>
 <default/>
--- a/xml/en/docs/http/ngx_http_scgi_module.xml
+++ b/xml/en/docs/http/ngx_http_scgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_scgi_module"
         link="/en/docs/http/ngx_http_scgi_module.html"
         lang="en"
-        rev="38">
+        rev="39">
 
 <section id="summary">
 
@@ -1310,6 +1310,25 @@ the connection is closed.
 </directive>
 
 
+<directive name="scgi_socket_keepalive">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.15.6</appeared-in>
+
+<para>
+Configures the “TCP keepalive” behavior
+for outgoing connections to an SCGI server.
+By default, the operating system’s settings are in effect for the socket.
+If the directive is set to the value “<literal>on</literal>”, the
+<c-def>SO_KEEPALIVE</c-def> socket option is turned on for the socket.
+</para>
+
+</directive>
+
+
 <directive name="scgi_store">
 <syntax>
     <literal>on</literal> |
--- a/xml/en/docs/http/ngx_http_uwsgi_module.xml
+++ b/xml/en/docs/http/ngx_http_uwsgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_http_uwsgi_module"
         link="/en/docs/http/ngx_http_uwsgi_module.html"
         lang="en"
-        rev="42">
+        rev="43">
 
 <section id="summary">
 
@@ -1352,6 +1352,25 @@ the connection is closed.
 </directive>
 
 
+<directive name="uwsgi_socket_keepalive">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.15.6</appeared-in>
+
+<para>
+Configures the “TCP keepalive” behavior
+for outgoing connections to a uwsgi server.
+By default, the operating system’s settings are in effect for the socket.
+If the directive is set to the value “<literal>on</literal>”, the
+<c-def>SO_KEEPALIVE</c-def> socket option is turned on for the socket.
+</para>
+
+</directive>
+
+
 <directive name="uwsgi_ssl_certificate">
 <syntax><value>file</value></syntax>
 <default/>
--- a/xml/en/docs/stream/ngx_stream_proxy_module.xml
+++ b/xml/en/docs/stream/ngx_stream_proxy_module.xml
@@ -9,7 +9,7 @@
 <module name="Module ngx_stream_proxy_module"
         link="/en/docs/stream/ngx_stream_proxy_module.html"
         lang="en"
-        rev="20">
+        rev="21">
 
 <section id="summary">
 
@@ -269,6 +269,24 @@ By default, the number of datagrams is n
 </directive>
 
 
+<directive name="proxy_socket_keepalive">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>stream</context>
+<context>server</context>
+<appeared-in>1.15.6</appeared-in>
+
+<para>
+Configures the “TCP keepalive” behavior
+for outgoing connections to a proxied server.
+By default, the operating system’s settings are in effect for the socket.
+If the directive is set to the value “<literal>on</literal>”, the
+<c-def>SO_KEEPALIVE</c-def> socket option is turned on for the socket.
+</para>
+
+</directive>
+
+
 <directive name="proxy_ssl">
 <syntax><literal>on</literal> | <literal>off</literal></syntax>
 <default>off</default>
--- a/xml/ru/docs/http/ngx_http_fastcgi_module.xml
+++ b/xml/ru/docs/http/ngx_http_fastcgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_fastcgi_module"
         link="/ru/docs/http/ngx_http_fastcgi_module.html"
         lang="ru"
-        rev="50">
+        rev="51">
 
 <section id="summary">
 
@@ -1427,6 +1427,25 @@ FastCGI-сервер.
 </directive>
 
 
+<directive name="fastcgi_socket_keepalive">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.15.6</appeared-in>
+
+<para>
+Конфигурирует поведение “TCP keepalive”
+для исходящих соединений к FastCGI-серверу.
+По умолчанию для сокета действуют настройки операционной системы.
+Если указано значение “<literal>on</literal>”, то
+для сокета включается параметр <c-def>SO_KEEPALIVE</c-def>.
+</para>
+
+</directive>
+
+
 <directive name="fastcgi_split_path_info">
 <syntax><value>regex</value></syntax>
 <default/>
--- a/xml/ru/docs/http/ngx_http_grpc_module.xml
+++ b/xml/ru/docs/http/ngx_http_grpc_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_grpc_module"
         link="/ru/docs/http/ngx_http_grpc_module.html"
         lang="ru"
-        rev="1">
+        rev="2">
 
 <section id="summary">
 
@@ -440,6 +440,25 @@ grpc_set_header Accept-Encoding "";
 </directive>
 
 
+<directive name="grpc_socket_keepalive">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.15.6</appeared-in>
+
+<para>
+Конфигурирует поведение “TCP keepalive”
+для исходящих соединений к gRPC-серверу.
+По умолчанию для сокета действуют настройки операционной системы.
+Если указано значение “<literal>on</literal>”, то
+для сокета включается параметр <c-def>SO_KEEPALIVE</c-def>.
+</para>
+
+</directive>
+
+
 <directive name="grpc_ssl_certificate">
 <syntax><value>файл</value></syntax>
 <default/>
--- a/xml/ru/docs/http/ngx_http_memcached_module.xml
+++ b/xml/ru/docs/http/ngx_http_memcached_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_memcached_module"
         link="/ru/docs/http/ngx_http_memcached_module.html"
         lang="ru"
-        rev="16">
+        rev="17">
 
 <section id="summary">
 
@@ -319,6 +319,25 @@ memcached_pass unix:/tmp/memcached.socke
 
 </directive>
 
+
+<directive name="memcached_socket_keepalive">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.15.6</appeared-in>
+
+<para>
+Конфигурирует поведение “TCP keepalive”
+для исходящих соединений к серверу memcached.
+По умолчанию для сокета действуют настройки операционной системы.
+Если указано значение “<literal>on</literal>”, то
+для сокета включается параметр <c-def>SO_KEEPALIVE</c-def>.
+</para>
+
+</directive>
+
 </section>
 
 
--- a/xml/ru/docs/http/ngx_http_proxy_module.xml
+++ b/xml/ru/docs/http/ngx_http_proxy_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_proxy_module"
         link="/ru/docs/http/ngx_http_proxy_module.html"
         lang="ru"
-        rev="64">
+        rev="65">
 
 <section id="summary">
 
@@ -1847,6 +1847,25 @@ proxy_set_header Accept-Encoding "";
 </directive>
 
 
+<directive name="proxy_socket_keepalive">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.15.6</appeared-in>
+
+<para>
+Конфигурирует поведение “TCP keepalive”
+для исходящих соединений к проксируемому серверу.
+По умолчанию для сокета действуют настройки операционной системы.
+Если указано значение “<literal>on</literal>”, то
+для сокета включается параметр <c-def>SO_KEEPALIVE</c-def>.
+</para>
+
+</directive>
+
+
 <directive name="proxy_ssl_certificate">
 <syntax><value>файл</value></syntax>
 <default/>
--- a/xml/ru/docs/http/ngx_http_scgi_module.xml
+++ b/xml/ru/docs/http/ngx_http_scgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_scgi_module"
         link="/ru/docs/http/ngx_http_scgi_module.html"
         lang="ru"
-        rev="38">
+        rev="39">
 
 <section id="summary">
 
@@ -1309,6 +1309,25 @@ SCGI-сервер.
 </directive>
 
 
+<directive name="scgi_socket_keepalive">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.15.6</appeared-in>
+
+<para>
+Конфигурирует поведение “TCP keepalive”
+для исходящих соединений к SCGI-серверу.
+По умолчанию для сокета действуют настройки операционной системы.
+Если указано значение “<literal>on</literal>”, то
+для сокета включается параметр <c-def>SO_KEEPALIVE</c-def>.
+</para>
+
+</directive>
+
+
 <directive name="scgi_store">
 <syntax>
     <literal>on</literal> |
--- a/xml/ru/docs/http/ngx_http_uwsgi_module.xml
+++ b/xml/ru/docs/http/ngx_http_uwsgi_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_http_uwsgi_module"
         link="/ru/docs/http/ngx_http_uwsgi_module.html"
         lang="ru"
-        rev="42">
+        rev="43">
 
 <section id="summary">
 
@@ -1348,6 +1348,25 @@ uwsgi-сервер.
 </directive>
 
 
+<directive name="uwsgi_socket_keepalive">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+<appeared-in>1.15.6</appeared-in>
+
+<para>
+Конфигурирует поведение “TCP keepalive”
+для исходящих соединений к uwsgi-серверу.
+По умолчанию для сокета действуют настройки операционной системы.
+Если указано значение “<literal>on</literal>”, то
+для сокета включается параметр <c-def>SO_KEEPALIVE</c-def>.
+</para>
+
+</directive>
+
+
 <directive name="uwsgi_ssl_certificate">
 <syntax><value>файл</value></syntax>
 <default/>
--- a/xml/ru/docs/stream/ngx_stream_proxy_module.xml
+++ b/xml/ru/docs/stream/ngx_stream_proxy_module.xml
@@ -9,7 +9,7 @@
 <module name="Модуль ngx_stream_proxy_module"
         link="/ru/docs/stream/ngx_stream_proxy_module.html"
         lang="ru"
-        rev="20">
+        rev="21">
 
 <section id="summary">
 
@@ -271,6 +271,24 @@ PROXY</link> для соединений с проксируемым сервером.
 </directive>
 
 
+<directive name="proxy_socket_keepalive">
+<syntax><literal>on</literal> | <literal>off</literal></syntax>
+<default>off</default>
+<context>stream</context>
+<context>server</context>
+<appeared-in>1.15.6</appeared-in>
+
+<para>
+Конфигурирует поведение “TCP keepalive”
+для исходящих соединений к проксируемому серверу.
+По умолчанию для сокета действуют настройки операционной системы.
+Если указано значение “<literal>on</literal>”, то
+для сокета включается параметр <c-def>SO_KEEPALIVE</c-def>.
+</para>
+
+</directive>
+
+
 <directive name="proxy_ssl">
 <syntax><literal>on</literal> | <literal>off</literal></syntax>
 <default>off</default>