comparison xml/en/docs/http/ngx_http_realip_module.xml @ 348:5a848934a12d

English translation of ngx_http_geoip_module, ngx_http_map_module, ngx_http_realip_module, ngx_http_secure_link_module, ngx_http_split_clients_module, and ngx_http_sub_module.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 23 Jan 2012 16:50:35 +0000
parents
children a4fa80755eab
comparison
equal deleted inserted replaced
347:daae2b619815 348:5a848934a12d
1 <?xml version="1.0"?>
2
3 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
4
5 <module name="Module ngx_http_realip_module"
6 link="/en/docs/http/ngx_http_realip_module.html"
7 lang="en">
8
9 <section id="summary">
10
11 <para>
12 The <literal>ngx_http_realip_module</literal> module allows
13 to change the client address to the one sent in the specified header field.
14 </para>
15
16 <para>
17 This module is not built by default, it should be enabled with the
18 <literal>--with-http_realip_module</literal>
19 configuration parameter.
20 </para>
21
22 </section>
23
24
25 <section id="example" name="Example Configuration">
26
27 <para>
28 <example>
29 set_real_ip_from 192.168.1.0/24;
30 set_real_ip_from 192.168.2.1;
31 real_ip_header X-Real-IP;
32 </example>
33 </para>
34
35 </section>
36
37
38 <section id="directives" name="Directives">
39
40 <directive name="set_real_ip_from">
41 <syntax><value>address</value> | <value>CIDR</value></syntax>
42 <default/>
43 <context>http</context>
44 <context>server</context>
45 <context>location</context>
46
47 <para>
48 Describes trusted addresses that are known to send correct
49 replacement addresses.
50 </para>
51
52 </directive>
53
54
55 <directive name="real_ip_header">
56 <syntax>
57 <value>field</value> |
58 <literal>X-Real-IP</literal> |
59 <literal>X-Forwarded-For</literal></syntax>
60 <default>X-Real-IP</default>
61 <context>http</context>
62 <context>server</context>
63 <context>location</context>
64
65 <para>
66 Defines a request header field used to send
67 the address for a replacement.
68 In case of the <header>X-Forwarded-For</header> field,
69 the last address in the field’s value is used.
70 For other fields the whole value is used.
71 </para>
72
73 </directive>
74
75 </section>
76
77 </module>