diff xml/ru/docs/stream/ngx_stream_realip_module.xml @ 1779:ee56773d44e8

Documented ngx_stream_realip_module.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 13 Sep 2016 16:14:00 +0300
parents xml/ru/docs/http/ngx_http_realip_module.xml@f855acbd0a94
children
line wrap: on
line diff
copy from xml/ru/docs/http/ngx_http_realip_module.xml
copy to xml/ru/docs/stream/ngx_stream_realip_module.xml
--- a/xml/ru/docs/http/ngx_http_realip_module.xml
+++ b/xml/ru/docs/stream/ngx_stream_realip_module.xml
@@ -1,29 +1,31 @@
 <?xml version="1.0"?>
 
 <!--
-  Copyright (C) Igor Sysoev
   Copyright (C) Nginx, Inc.
   -->
 
 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
 
-<module name="Модуль ngx_http_realip_module"
-        link="/ru/docs/http/ngx_http_realip_module.html"
+<module name="Модуль ngx_stream_realip_module"
+        link="/ru/docs/stream/ngx_stream_realip_module.html"
         lang="ru"
-        rev="5">
+        rev="1">
 
 <section id="summary">
 
 <para>
-Модуль <literal>ngx_http_realip_module</literal> позволяет
-менять адрес и необязательный порт клиента
-на переданный в указанных полях заголовка.
+Модуль <literal>ngx_stream_realip_module</literal> позволяет
+менять адрес и порт клиента
+на переданные в заголовке протокола PROXY (1.11.4).
+Протокол PROXY должен быть предварительно включён при помощи установки
+параметра <link doc="ngx_stream_core_module.xml" id="proxy_protocol"/>
+в директиве <literal>listen</literal>.
 </para>
 
 <para>
 По умолчанию этот модуль не собирается, его сборку необходимо
 разрешить с помощью конфигурационного параметра
-<literal>--with-http_realip_module</literal>.
+<literal>--with-stream_realip_module</literal>.
 </para>
 
 </section>
@@ -33,11 +35,11 @@
 
 <para>
 <example>
+listen 12345 proxy_protocol;
+
 set_real_ip_from  192.168.1.0/24;
 set_real_ip_from  192.168.2.1;
 set_real_ip_from  2001:0db8::/32;
-real_ip_header    X-Forwarded-For;
-real_ip_recursive on;
 </example>
 </para>
 
@@ -52,74 +54,14 @@ real_ip_recursive on;
     <value>CIDR</value> |
     <literal>unix:</literal></syntax>
 <default/>
-<context>http</context>
+<context>stream</context>
 <context>server</context>
-<context>location</context>
 
 <para>
 Задаёт доверенные адреса, которые передают верный адрес
 для замены.
 Если указано специальное значение <literal>unix:</literal>,
 доверенными будут считаться все UNIX-сокеты.
-<note>
-IPv6-адреса поддерживаются начиная с версий 1.3.0 и 1.2.1.
-</note>
-</para>
-
-</directive>
-
-
-<directive name="real_ip_header">
-<syntax>
-    <value>поле</value> |
-    <literal>X-Real-IP</literal> |
-    <literal>X-Forwarded-For</literal> |
-    <literal>proxy_protocol</literal></syntax>
-<default>X-Real-IP</default>
-<context>http</context>
-<context>server</context>
-<context>location</context>
-
-<para>
-Задаёт поле заголовка запроса,
-значение которого будет использоваться для замены адреса клиента.
-</para>
-
-<para>
-Параметры <literal>X-Real-IP</literal> и <literal>X-Forwarded-For</literal>
-могут содержать необязательный порт (1.11.0).
-Адрес и порт должны быть указаны согласно
-<link url="http://tools.ietf.org/html/3986">RFC 3986</link>.
-</para>
-
-<para>
-Параметр <literal>proxy_protocol</literal> (1.5.12) меняет
-адрес клиента на указанный в заголовке PROXY-протокола.
-Протокол PROXY должен быть предварительно включён при помощи установки
-параметра <literal>proxy_protocol</literal> в директиве
-<link doc="ngx_http_core_module.xml" id="listen"/>.
-</para>
-
-</directive>
-
-
-<directive name="real_ip_recursive">
-<syntax><literal>on</literal> | <literal>off</literal></syntax>
-<default>off</default>
-<context>http</context>
-<context>server</context>
-<context>location</context>
-<appeared-in>1.3.0</appeared-in>
-<appeared-in>1.2.1</appeared-in>
-
-<para>
-При выключенном рекурсивном поиске исходный адрес клиента,
-совпадающий с одним из доверенных адресов, заменяется на последний
-адрес, переданный в поле заголовка запроса, заданного
-директивой <link id="real_ip_header"/>.
-При включённом рекурсивном поиске исходный адрес клиента,
-совпадающий с одним из доверенных адресов, заменяется на последний
-не доверенный адрес, переданный в заданном поле заголовка запроса.
 </para>
 
 </directive>
@@ -134,12 +76,12 @@ IPv6-адреса поддерживаются начиная с версий 1.3.0 и 1.2.1.
 
 <tag-name id="var_realip_remote_addr"><var>$realip_remote_addr</var></tag-name>
 <tag-desc>
-хранит исходный адрес клиента (1.9.7)
+хранит исходный адрес клиента
 </tag-desc>
 
 <tag-name id="var_realip_remote_port"><var>$realip_remote_port</var></tag-name>
 <tag-desc>
-хранит исходный порт клиента (1.11.0)
+хранит исходный порт клиента
 </tag-desc>
 
 </list>