view xml/ru/docs/http/ngx_http_realip_module.xml @ 102:c76a257f3fd4

The directive name is now automatically printed in <default> and <syntax>. Specifying <default> is made non-optional. Visible changes: - "types" and "proxy_set_header" get proper defaults (not yet displayed nicely); - "fastcgi_hide_header", "fastcgi_ignore_headers", "fastcgi_pass_header", "proxy_hide_header", "proxy_ignore_headers", and "proxy_pass_header" now have their (empty) defaults documented; - mentions of "fastcgi_redirect_errors" and "proxy_redirect_errors" which are long unsupported were removed.
author Ruslan Ermilov <ru@nginx.com>
date Wed, 19 Oct 2011 05:15:24 +0000
parents 1d315ef37215
children 40eec261c2a6
line wrap: on
line source

<?xml version="1.0" encoding="utf-8"?>

<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">

<module name="Директивы модуля ngx_http_realip_module"
        link="/ru/docs/http/ngx_http_realip_module.html"
        lang="ru">

<section name="" id="summary">

<para>
Модуль ngx_http_realip_module позволяет менять адрес клиента
на переданный в указанной строке заголовка.
По умолчанию модуль не собирается, нужно разрешить его сборку
при конфигурировании параметром <command>--with-http_realip_module</command>.
</para>

</section>


<section name="Пример конфигурации" id="example">

<para>
<example>
    set_real_ip_from   192.168.1.0/24;
    set_real_ip_from   192.168.2.1;
    real_ip_header     X-Real-IP;
</example>
</para>

</section>


<section name="Директивы" id="directives">

<directive name="set_real_ip_from">
<syntax><value>[адрес|CIDR]</value></syntax>
<default/>
<context>http, server, location</context>

<para>
Директива описывает доверенные адреса, которые передают верный адрес
для замены.
</para>

</directive>


<directive name="real_ip_header">
<syntax><value>имя строки[X-Real-IP|X-Forwarded-For]</value></syntax>
<default>X-Real-IP</default>
<context>http, server, location</context>

<para>
Директива указывает название строки в заголовке запроса,
в котором передаётся адрес для замены.
В случае строки "X-Forwarded-For" используется последний адрес в значении
строки. Для остальных строк используется всё значение.
</para>

</directive>

</section>

</module>