diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/xml/en/docs/http/ngx_http_realip_module.xml	Mon Jan 23 16:50:35 2012 +0000
@@ -0,0 +1,77 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
+
+<module name="Module ngx_http_realip_module"
+        link="/en/docs/http/ngx_http_realip_module.html"
+        lang="en">
+
+<section id="summary">
+
+<para>
+The <literal>ngx_http_realip_module</literal> module allows
+to change the client address to the one sent in the specified header field.
+</para>
+
+<para>
+This module is not built by default, it should be enabled with the
+<literal>--with-http_realip_module</literal>
+configuration parameter.
+</para>
+
+</section>
+
+
+<section id="example" name="Example Configuration">
+
+<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 id="directives" name="Directives">
+
+<directive name="set_real_ip_from">
+<syntax><value>address</value> | <value>CIDR</value></syntax>
+<default/>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+
+<para>
+Describes trusted addresses that are known to send correct
+replacement addresses.
+</para>
+
+</directive>
+
+
+<directive name="real_ip_header">
+<syntax>
+  <value>field</value> |
+  <literal>X-Real-IP</literal> |
+  <literal>X-Forwarded-For</literal></syntax>
+<default>X-Real-IP</default>
+<context>http</context>
+<context>server</context>
+<context>location</context>
+
+<para>
+Defines a request header field used to send
+the address for a replacement.
+In case of the <header>X-Forwarded-For</header> field,
+the last address in the field’s value is used.
+For other fields the whole value is used.
+</para>
+
+</directive>
+
+</section>
+
+</module>