Mercurial > hg > nginx-site

annotate xml/ru/docs/http/ngx_http_realip_module.xml @ 1601:8854618e1ca5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented the "$realip_remote_addr" variable.
author Yaroslav Zhuravlev <yar@nginx.com>
date Fri, 13 Nov 2015 16:11:56 +0300
parents 3b4a86b3515e
children bc25f237a966
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
222
bfe3eff81d04 Removed redundant encoding specification.
Ruslan Ermilov <ru@nginx.com>
parents: 110
diff changeset
1 <?xml version="1.0"?>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
2
580
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 523
diff changeset
3 <!--
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 523
diff changeset
4 Copyright (C) Igor Sysoev
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 523
diff changeset
5 Copyright (C) Nginx, Inc.
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 523
diff changeset
6 -->
be54c443235a Added copyright markers to documentation sources.
Ruslan Ermilov <ru@nginx.com>
parents: 523
diff changeset
7
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
9
342
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
10 <module name="Модуль ngx_http_realip_module"
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
11 link="/ru/docs/http/ngx_http_realip_module.html"
589
764fbac1b8b4 Added document revision.
Ruslan Ermilov <ru@nginx.com>
parents: 580
diff changeset
12 lang="ru"
1601
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
13 rev="4">
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
14
110
40eec261c2a6 Added proper support for anonymous sections, notably for the summary.
Ruslan Ermilov <ru@nginx.com>
parents: 102
diff changeset
15 <section id="summary">
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
16
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
17 <para>
342
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
18 Модуль <literal>ngx_http_realip_module</literal> позволяет менять адрес клиента
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
19 на переданный в указанном поле заголовка.
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
20 </para>
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
21
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
22 <para>
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
23 По умолчанию этот модуль не собирается, его сборку необходимо
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
24 разрешить с помощью конфигурационного параметра
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
25 <literal>--with-http_realip_module</literal>.
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
26 </para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
27
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
28 </section>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
29
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
30
342
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
31 <section id="example" name="Пример конфигурации">
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
32
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
33 <para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
34 <example>
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
35 set_real_ip_from 192.168.1.0/24;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
36 set_real_ip_from 192.168.2.1;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
37 set_real_ip_from 2001:0db8::/32;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
38 real_ip_header X-Forwarded-For;
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
39 real_ip_recursive on;
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
40 </example>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
41 </para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
42
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
43 </section>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
44
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
45
342
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
46 <section id="directives" name="Директивы">
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
47
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
48 <directive name="set_real_ip_from">
468
31e81dcc4ffd set_real_ip_from: documented the special parameter "unix:".
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
49 <syntax>
31e81dcc4ffd set_real_ip_from: documented the special parameter "unix:".
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
50 <value>адрес</value> |
31e81dcc4ffd set_real_ip_from: documented the special parameter "unix:".
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
51 <value>CIDR</value> |
31e81dcc4ffd set_real_ip_from: documented the special parameter "unix:".
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
52 <literal>unix:</literal></syntax>
99
1d315ef37215 The case <default/> is now language-agnostic.
Ruslan Ermilov <ru@nginx.com>
parents: 76
diff changeset
53 <default/>
342
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
54 <context>http</context>
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
55 <context>server</context>
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
56 <context>location</context>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
57
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
58 <para>
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
59 Задаёт доверенные адреса, которые передают верный адрес
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
60 для замены.
468
31e81dcc4ffd set_real_ip_from: documented the special parameter "unix:".
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
61 Если указано специальное значение <literal>unix:</literal>,
31e81dcc4ffd set_real_ip_from: documented the special parameter "unix:".
Ruslan Ermilov <ru@nginx.com>
parents: 364
diff changeset
62 доверенными будут считаться все UNIX-сокеты.
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
63 <note>
523
a8daad8e83bb Documented 1.2.1 changes.
Ruslan Ermilov <ru@nginx.com>
parents: 518
diff changeset
64 IPv6-адреса поддерживаются начиная с версий 1.3.0 и 1.2.1.
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
65 </note>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
66 </para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
67
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
68 </directive>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
69
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
70
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
71 <directive name="real_ip_header">
271
4c6d2c614d2c Cleaned up XML tag mess:
Ruslan Ermilov <ru@nginx.com>
parents: 222
diff changeset
72 <syntax>
364
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
73 <value>поле</value> |
bb51d3e17dd0 Style fixed.
Ruslan Ermilov <ru@nginx.com>
parents: 351
diff changeset
74 <literal>X-Real-IP</literal> |
1097
eeb690d4212b Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 589
diff changeset
75 <literal>X-Forwarded-For</literal> |
eeb690d4212b Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 589
diff changeset
76 <literal>proxy_protocol</literal></syntax>
102
c76a257f3fd4 The directive name is now automatically printed in <default> and <syntax>.
Ruslan Ermilov <ru@nginx.com>
parents: 99
diff changeset
77 <default>X-Real-IP</default>
342
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
78 <context>http</context>
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
79 <context>server</context>
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
80 <context>location</context>
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
81
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
82 <para>
342
a076f7661569 Revision.
Ruslan Ermilov <ru@nginx.com>
parents: 271
diff changeset
83 Задаёт поле заголовка запроса,
1523
3b4a86b3515e Rephrased the "real_ip_header" directive.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1097
diff changeset
84 значение которого будет использоваться для замены адреса клиента.
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
85 </para>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
86
1097
eeb690d4212b Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 589
diff changeset
87 <para>
eeb690d4212b Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 589
diff changeset
88 Параметр <literal>proxy_protocol</literal> (1.5.12) меняет
eeb690d4212b Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 589
diff changeset
89 адрес клиента на указанный в заголовке PROXY-протокола.
eeb690d4212b Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 589
diff changeset
90 Протокол PROXY должен быть предварительно включён при помощи установки
eeb690d4212b Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 589
diff changeset
91 параметра <literal>proxy_protocol</literal> в директиве
eeb690d4212b Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 589
diff changeset
92 <link doc="ngx_http_core_module.xml" id="listen"/>.
eeb690d4212b Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 589
diff changeset
93 </para>
eeb690d4212b Documented the PROXY protocol support.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 589
diff changeset
94
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
95 </directive>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
96
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
97
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
98 <directive name="real_ip_recursive">
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
99 <syntax><literal>on</literal> | <literal>off</literal></syntax>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
100 <default>off</default>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
101 <context>http</context>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
102 <context>server</context>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
103 <context>location</context>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
104 <appeared-in>1.3.0</appeared-in>
523
a8daad8e83bb Documented 1.2.1 changes.
Ruslan Ermilov <ru@nginx.com>
parents: 518
diff changeset
105 <appeared-in>1.2.1</appeared-in>
518
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
106
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
107 <para>
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
108 При выключенном рекурсивном поиске исходный адрес клиента,
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
109 совпадающий с одним из доверенных адресов, заменяется на последний
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
110 адрес, переданный в поле заголовка запроса, заданного
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
111 директивой <link id="real_ip_header"/>.
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
112 При включённом рекурсивном поиске исходный адрес клиента,
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
113 совпадающий с одним из доверенных адресов, заменяется на последний
65750bdde8fb Documented recent changes.
Ruslan Ermilov <ru@nginx.com>
parents: 468
diff changeset
114 не доверенный адрес, переданный в заданном поле заголовка запроса.
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
115 </para>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
116
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
117 </directive>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
118
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
119 </section>
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
120
1601
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
121
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
122 <section id="variables" name="Встроенные переменные">
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
123
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
124 <para>
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
125 <list type="tag">
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
126
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
127 <tag-name id="var_realip_remote_addr"><var>$realip_remote_addr</var></tag-name>
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
128 <tag-desc>
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
129 хранит исходный адрес клиента (1.9.7).
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
130 </tag-desc>
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
131
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
132 </list>
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
133 </para>
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
134
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
135 </section>
8854618e1ca5 Documented the "$realip_remote_addr" variable.
Yaroslav Zhuravlev <yar@nginx.com>
parents: 1523
diff changeset
136
76
4a4caa566120 Russian documentation import.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
137 </module>