Mercurial > hg > nginx-site
changeset 1561:ed420c318557
Updated docs for the upcoming NGINX Plus release.
author | Ruslan Ermilov <ru@nginx.com> |
---|---|
date | Thu, 10 Sep 2015 15:50:32 +0300 |
parents | dad3af7a1019 |
children | 1d323f723e14 |
files | xml/en/docs/http/ngx_http_core_module.xml xml/en/docs/http/ngx_http_spdy_module.xml xml/en/docs/http/ngx_http_status_module.xml xml/en/docs/http/ngx_http_upstream_module.xml xml/ru/docs/http/ngx_http_status_module.xml xml/ru/docs/http/ngx_http_upstream_module.xml |
diffstat | 6 files changed, 303 insertions(+), 36 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="45"> + rev="46"> <section id="directives" name="Directives"> @@ -1118,7 +1118,7 @@ The “wait-read-ignore” cycle is repeated, but no longer than specified by the <value>address</value>[:<value>port</value>] [<literal>default_server</literal>] [<literal>ssl</literal>] - [<literal>spdy</literal>] + [<literal>spdy</literal> | <literal>http2</literal>] [<literal>proxy_protocol</literal>] [<literal>setfib</literal>=<value>number</value>] [<literal>fastopen</literal>=<value>number</value>] @@ -1135,7 +1135,7 @@ The “wait-read-ignore” cycle is repeated, but no longer than specified by the <value>port</value> [<literal>default_server</literal>] [<literal>ssl</literal>] - [<literal>spdy</literal>] + [<literal>spdy</literal> | <literal>http2</literal>] [<literal>proxy_protocol</literal>] [<literal>setfib</literal>=<value>number</value>] [<literal>fastopen</literal>=<value>number</value>] @@ -1152,7 +1152,7 @@ The “wait-read-ignore” cycle is repeated, but no longer than specified by the <literal>unix:</literal><value>path</value> [<literal>default_server</literal>] [<literal>ssl</literal>] - [<literal>spdy</literal>] + [<literal>spdy</literal> | <literal>http2</literal>] [<literal>proxy_protocol</literal>] [<literal>backlog</literal>=<value>number</value>] [<literal>rcvbuf</literal>=<value>size</value>] @@ -1231,6 +1231,20 @@ connections without SSL. </para> <para> +The <literal>http2</literal> parameter configures the port to accept +HTTP/2 connections. +Normally, for this to work the <literal>ssl</literal> parameter should be +specified as well, but nginx can also be configured to accept HTTP/2 +connections without SSL. +<note> +The <literal>http2</literal> parameter is only available in the +<literal>nginx-plus-http2</literal> package (NGINX Plus release 7). +Since HTTP/2 supersedes SPDY, the <literal>nginx-plus-http2</literal> +package does not support the <literal>spdy</literal> parameter. +</note> +</para> + +<para> The <literal>proxy_protocol</literal> parameter (1.5.12) 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
--- a/xml/en/docs/http/ngx_http_spdy_module.xml +++ b/xml/en/docs/http/ngx_http_spdy_module.xml @@ -9,7 +9,7 @@ <module name="Module ngx_http_spdy_module" link="/en/docs/http/ngx_http_spdy_module.html" lang="en" - rev="6"> + rev="7"> <section id="summary"> @@ -32,6 +32,12 @@ the <literal>--with-http_spdy_module</li configuration parameter. </para> +<para> +<note> +This module is not available in the <literal>nginx-plus-http2</literal> package. +</note> +</para> + </section>
--- a/xml/en/docs/http/ngx_http_status_module.xml +++ b/xml/en/docs/http/ngx_http_status_module.xml @@ -9,7 +9,7 @@ <module name="Module ngx_http_status_module" link="/en/docs/http/ngx_http_status_module.html" lang="en" - rev="7"> + rev="8"> <section id="summary"> @@ -184,7 +184,7 @@ The following status information is prov <tag-name id="version"><literal>version</literal></tag-name> <tag-desc> Version of the provided data set. -The current version is 5. +The current version is 6. </tag-desc> <tag-name><literal>nginx_version</literal></tag-name> @@ -213,6 +213,11 @@ Time of the last reload of configuration Current time in milliseconds since Epoch. </tag-desc> +<tag-name id="pid"><literal>pid</literal></tag-name> +<tag-desc> +The ID of the worker process that handled status request. +</tag-desc> + <tag-name id="processes"><literal>processes</literal></tag-name> <tag-desc> <list type="tag"> @@ -253,6 +258,28 @@ The current number of idle client connec </list> </tag-desc> +<tag-name id="ssl"><literal>ssl</literal></tag-name> +<tag-desc> +<list type="tag"> + +<tag-name><literal>handshakes</literal></tag-name> +<tag-desc> +The total number of successful SSL handshakes. +</tag-desc> + +<tag-name><literal>handshakes_failed</literal></tag-name> +<tag-desc> +The total number of failed SSL handshakes. +</tag-desc> + +<tag-name><literal>session_reuses</literal></tag-name> +<tag-desc> +The total number of session reuses during SSL handshake. +</tag-desc> + +</list> +</tag-desc> + <tag-name><literal>requests</literal></tag-name> <tag-desc> <list type="tag"> @@ -311,6 +338,11 @@ The number of responses with status code </list> </tag-desc> +<tag-name id="discarded"><literal>discarded</literal></tag-name> +<tag-desc> +The total number of requests completed without sending a response. +</tag-desc> + <tag-name><literal>received</literal></tag-name> <tag-desc> The total number of bytes received from clients. @@ -327,14 +359,19 @@ The total number of bytes sent to client <tag-name id="upstreams"><literal>upstreams</literal></tag-name> <tag-desc> For each -<link doc="ngx_http_upstream_module.xml" id="server"/> -in the <link doc="ngx_http_upstream_module.xml" id="zone">dynamically configurable</link> <link doc="ngx_http_upstream_module.xml" id="upstream">group</link>, the following data are provided: <list type="tag"> +<tag-name id="peers"><literal>peers</literal></tag-name> +<tag-desc> +For each +<link doc="ngx_http_upstream_module.xml" id="server"/>, +the following data are provided: +<list type="tag"> + <tag-name id="id"><literal>id</literal></tag-name> <tag-desc> The ID of the server. @@ -376,14 +413,6 @@ or The current number of active connections. </tag-desc> -<!-- -<tag-name><literal>keepalive</literal></tag-name> -<tag-desc> -The current number of -idle <link doc="ngx_http_upstream_module.xml" id="keepalive"/> connections. -</tag-desc> ---> - <tag-name id="max_conns"><literal>max_conns</literal></tag-name> <tag-desc> The <link doc="ngx_http_upstream_module.xml" id="max_conns"/> limit @@ -522,6 +551,39 @@ load balancing method. </list> </tag-desc> +<tag-name><literal>keepalive</literal></tag-name> +<tag-desc> +The current number of +idle <link doc="ngx_http_upstream_module.xml" id="keepalive"/> connections. +</tag-desc> + +<tag-name id="queue"><literal>queue</literal></tag-name> +<tag-desc> +For the requests <link doc="ngx_http_upstream_module.xml" id="queue"/>, +the following data are provided: +<list type="tag"> + +<tag-name><literal>size</literal></tag-name> +<tag-desc> +The current number of requests in the queue. +</tag-desc> + +<tag-name id="max_size"><literal>max_size</literal></tag-name> +<tag-desc> +The maximum number of requests that can be in the queue at the same time. +</tag-desc> + +<tag-name><literal>overflows</literal></tag-name> +<tag-desc> +The total number of requests rejected due to the queue overflow. +</tag-desc> + +</list> +</tag-desc> + +</list> +</tag-desc> + <tag-name id="caches"><literal>caches</literal></tag-name> <tag-desc> For each cache (configured by @@ -642,14 +704,19 @@ The total number of bytes sent to client <tag-name><literal>upstreams</literal></tag-name> <tag-desc> For each -<link doc="../stream/ngx_stream_upstream_module.xml" id="server"/> -in the <link doc="../stream/ngx_stream_upstream_module.xml" id="zone">dynamically configurable</link> <link doc="../stream/ngx_stream_upstream_module.xml" id="upstream">group</link>, the following data are provided: <list type="tag"> +<tag-name><literal>peers</literal></tag-name> +<tag-desc> +For each +<link doc="../stream/ngx_stream_upstream_module.xml" id="server"/> +the following data are provided: +<list type="tag"> + <tag-name><literal>id</literal></tag-name> <tag-desc> The ID of the server. @@ -806,6 +873,9 @@ when the server was last selected to pro </tag-desc> </list> +</tag-desc> + +</list> </para> </section> @@ -816,6 +886,35 @@ when the server was last selected to pro <list type="bullet"> <listitem> +The <link id="ssl"/> status data +were added in <link id="version"/> 6. +</listitem> + +<listitem> +The +<link id="discarded"/> field in +<link id="server_zones"/> +was added in <link id="version"/> 6. +</listitem> + +<listitem> +The <link id="queue"/> status data +were added in <link id="version"/> 6. +</listitem> + +<listitem> +The +<link id="pid"/> field +was added in <link id="version"/> 6. +</listitem> + +<listitem> +The list of servers in <link id="upstreams"/> +was moved into <link id="peers"/> in +<link id="version"/> 6. +</listitem> + +<listitem> The <literal>keepalive</literal> field of an upstream server was removed in <link id="version"/> 5. </listitem>
--- a/xml/en/docs/http/ngx_http_upstream_module.xml +++ b/xml/en/docs/http/ngx_http_upstream_module.xml @@ -10,7 +10,7 @@ <module name="Module ngx_http_upstream_module" link="/en/docs/http/ngx_http_upstream_module.html" lang="en" - rev="41"> + rev="42"> <section id="summary"> @@ -516,6 +516,34 @@ SCGI and uwsgi protocols do not have a n </directive> +<directive name="ntlm"> +<syntax/> +<default/> +<context>upstream</context> +<appeared-in>1.9.2</appeared-in> + +<para> +Allows proxying requests with +<link url="https://en.wikipedia.org/wiki/Integrated_Windows_Authentication">NTLM +Authentication</link>. +The upstream connection is bound to the client connection +once the client sends a request with the <header>Authorization</header> +header field value +starting with “<literal>Negotiate</literal>” or “<literal>NTLM</literal>”. +Further client requests will be proxied through the same upstream connection, +keeping the authentication context. +</para> + +<para> +<note> +This directive is available as part of our +<commercial_version>commercial subscription</commercial_version>. +</note> +</para> + +</directive> + + <directive name="least_conn"> <syntax/> <default/>
--- a/xml/ru/docs/http/ngx_http_status_module.xml +++ b/xml/ru/docs/http/ngx_http_status_module.xml @@ -9,7 +9,7 @@ <module name="Модуль ngx_http_status_module" link="/ru/docs/http/ngx_http_status_module.html" lang="ru" - rev="7"> + rev="8"> <section id="summary"> @@ -187,7 +187,7 @@ http://127.0.0.1/status/stream/upstreams <tag-name id="version"><literal>version</literal></tag-name> <tag-desc> Версия предоставляемого набора данных. -Текущей является версия 5. +Текущей является версия 6. </tag-desc> <tag-name><literal>nginx_version</literal></tag-name> @@ -197,7 +197,7 @@ http://127.0.0.1/status/stream/upstreams <tag-name><literal>address</literal></tag-name> <tag-desc> -Адрес сервера, принявшего запрос получения информации о состоянии. +Адрес сервера, принявшего запрос на получение информации о состоянии. </tag-desc> <tag-name id="generation"><literal>generation</literal></tag-name> @@ -217,6 +217,12 @@ http://127.0.0.1/status/stream/upstreams Текущее время в миллисекундах с начала эпохи. </tag-desc> +<tag-name id="pid"><literal>pid</literal></tag-name> +<tag-desc> +Идентификатор рабочего процесса, +обработавшего запрос на получение информации о состоянии. +</tag-desc> + <tag-name id="processes"><literal>processes</literal></tag-name> <tag-desc> <list type="tag"> @@ -257,6 +263,29 @@ http://127.0.0.1/status/stream/upstreams </list> </tag-desc> +<tag-name id="ssl"><literal>ssl</literal></tag-name> +<tag-desc> +<list type="tag"> + +<tag-name><literal>handshakes</literal></tag-name> +<tag-desc> +Суммарное число успешных операций SSL handshake. +</tag-desc> + +<tag-name><literal>handshakes_failed</literal></tag-name> +<tag-desc> +Суммарное число неуспешных операций SSL handshake. +</tag-desc> + +<tag-name><literal>session_reuses</literal></tag-name> +<tag-desc> +Суммарное число повторных использований SSL-сессий +во время операций SSL handshake. +</tag-desc> + +</list> +</tag-desc> + <tag-name><literal>requests</literal></tag-name> <tag-desc> <list type="tag"> @@ -315,6 +344,11 @@ http://127.0.0.1/status/stream/upstreams </list> </tag-desc> +<tag-name id="discarded"><literal>discarded</literal></tag-name> +<tag-desc> +Суммарное число запросов, завершившихся без отправки ответа. +</tag-desc> + <tag-name><literal>received</literal></tag-name> <tag-desc> Суммарное число байт, полученных от клиентов. @@ -330,12 +364,17 @@ http://127.0.0.1/status/stream/upstreams <tag-name id="upstreams"><literal>upstreams</literal></tag-name> <tag-desc> +Для каждой +<link doc="ngx_http_upstream_module.xml" id="zone">динамически +настраиваемой</link> +<link doc="ngx_http_upstream_module.xml" id="upstream">группы</link> +доступны следующие данные: +<list type="tag"> + +<tag-name id="peers"><literal>peers</literal></tag-name> +<tag-desc> Для каждого <link doc="ngx_http_upstream_module.xml" id="server">сервера</link> -в -<link doc="ngx_http_upstream_module.xml" id="zone">динамически -настраиваемой</link> -<link doc="ngx_http_upstream_module.xml" id="upstream">группе</link> доступны следующие данные: <list type="tag"> @@ -378,14 +417,6 @@ http://127.0.0.1/status/stream/upstreams Текущее число активных соединений. </tag-desc> -<!-- -<tag-name><literal>keepalive</literal></tag-name> -<tag-desc> -Текущее число бездействующих -<link doc="ngx_http_upstream_module.xml" id="keepalive"/>-соединений. -</tag-desc> ---> - <tag-name id="max_conns"><literal>max_conns</literal></tag-name> <tag-desc> Ограничение <link doc="ngx_http_upstream_module.xml" id="max_conns"/> @@ -521,6 +552,39 @@ http://127.0.0.1/status/stream/upstreams </list> </tag-desc> +<tag-name><literal>keepalive</literal></tag-name> +<tag-desc> +Текущее число бездействующих +<link doc="ngx_http_upstream_module.xml" id="keepalive"/>-соединений. +</tag-desc> + +<tag-name id="queue"><literal>queue</literal></tag-name> +<tag-desc> +Для <link doc="ngx_http_upstream_module.xml" id="queue">очереди</link> запросов +доступны следующие данные: +<list type="tag"> + +<tag-name><literal>size</literal></tag-name> +<tag-desc> +Текущее число запросов в очереди. +</tag-desc> + +<tag-name><literal>max_size</literal></tag-name> +<tag-desc> +Максимальное число запросов, которые могут одновременно находиться в очереди. +</tag-desc> + +<tag-name><literal>overflows</literal></tag-name> +<tag-desc> +Суммарное число запросов, отклонённых из-за переполнения очереди. +</tag-desc> + +</list> +</tag-desc> + +</list> +</tag-desc> + <tag-name id="caches"><literal>caches</literal></tag-name> <tag-desc> Для каждого кэша, сконфигурированного при помощи @@ -812,6 +876,33 @@ http://127.0.0.1/status/stream/upstreams <list type="bullet"> <listitem> +Поля <link id="ssl"/> +были добавлены в <link id="version">версии</link> 6. +</listitem> + +<listitem> +Поле <link id="discarded"/> в +<link id="server_zones"/> +было добавлено в <link id="version">версии</link> 6. +</listitem> + +<listitem> +Поля <link id="queue"/> +были добавлены в <link id="version">версии</link> 6. +</listitem> + +<listitem> +Поле <link id="pid"/> +было добавлено в <link id="version">версии</link> 6. +</listitem> + +<listitem> +Список серверов в <link id="upstreams"/> был +перемещён в <link id="peers"/> в +<link id="version">версии</link> 6. +</listitem> + +<listitem> Поле <literal>keepalive</literal> сервера группы было удалено в <link id="version">версии</link> 5. </listitem>
--- a/xml/ru/docs/http/ngx_http_upstream_module.xml +++ b/xml/ru/docs/http/ngx_http_upstream_module.xml @@ -10,7 +10,7 @@ <module name="Модуль ngx_http_upstream_module" link="/ru/docs/http/ngx_http_upstream_module.html" lang="ru" - rev="41"> + rev="42"> <section id="summary"> @@ -520,6 +520,35 @@ server { </directive> +<directive name="ntlm"> +<syntax/> +<default/> +<context>upstream</context> +<appeared-in>1.9.2</appeared-in> + +<para> +Позволяет проксировать запросы с +<link url="https://en.wikipedia.org/wiki/Integrated_Windows_Authentication">проверкой +подлинности NTLM</link>. +Соединение с сервером группы привязывается к клиентскому соединению, +как только клиент отправляет запрос, в заголовке которого есть поле +<header>Authorization</header> со значением, +начинающимся с “<literal>Negotiate</literal>” или “<literal>NTLM</literal>”. +Последующие запросы клиента будут проксироваться через это же соединение +с сервером группы, +сохраняя контекст аутентификации. +</para> + +<para> +<note> +Эта директива доступна как часть +<commercial_version>коммерческой подписки</commercial_version>. +</note> +</para> + +</directive> + + <directive name="least_conn"> <syntax/> <default/>