diff xml/en/docs/stream/ngx_stream_geo_module.xml @ 1751:3768eb3d9c6c

Documented the geo module in stream.
author Yaroslav Zhuravlev <yar@nginx.com>
date Thu, 14 Jul 2016 20:33:05 +0300
parents xml/en/docs/http/ngx_http_geo_module.xml@95c3c3bbf1ce
children
line wrap: on
line diff
copy from xml/en/docs/http/ngx_http_geo_module.xml
copy to xml/en/docs/stream/ngx_stream_geo_module.xml
--- a/xml/en/docs/http/ngx_http_geo_module.xml
+++ b/xml/en/docs/stream/ngx_stream_geo_module.xml
@@ -1,21 +1,20 @@
 <?xml version="1.0"?>
 
 <!--
-  Copyright (C) Igor Sysoev
   Copyright (C) Nginx, Inc.
   -->
 
 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
 
-<module name="Module ngx_http_geo_module"
-        link="/en/docs/http/ngx_http_geo_module.html"
+<module name="Module ngx_stream_geo_module"
+        link="/en/docs/stream/ngx_stream_geo_module.html"
         lang="en"
-        rev="5">
+        rev="1">
 
 <section id="summary">
 
 <para>
-The <literal>ngx_http_geo_module</literal> module creates variables
+The <literal>ngx_stream_geo_module</literal> module (1.11.3) creates variables
 with values depending on the client IP address.
 </para>
 
@@ -47,13 +46,13 @@ geo $geo {
 <directive name="geo">
 <syntax block="yes">[<value>$address</value>] <value>$variable</value></syntax>
 <default/>
-<context>http</context>
+<context>stream</context>
 
 <para>
 Describes the dependency of values of the specified variable
 on the client IP address.
 By default, the address is taken from the <var>$remote_addr</var> variable,
-but it can also be taken from another variable (0.7.27), for example:
+but it can also be taken from another variable, for example:
 <example>
 geo $arg_remote_addr $geo {
     ...;
@@ -65,7 +64,7 @@ geo $arg_remote_addr $geo {
 <note>
 Since variables are evaluated only when used, the mere existence
 of even a large number of declared “<literal>geo</literal>” variables
-does not cause any extra costs for request processing.
+does not cause any extra costs for connection processing.
 </note>
 </para>
 
@@ -76,10 +75,7 @@ then the “<literal>255.255.255.255</literal>” address is used.
 
 <para>
 Addresses are specified either as prefixes in CIDR notation
-(including individual addresses) or as ranges (0.7.23).
-<note>
-IPv6 prefixes are supported starting from versions 1.3.10 and 1.2.7.
-</note>
+(including individual addresses) or as ranges.
 </para>
 
 <para>
@@ -88,7 +84,7 @@ The following special parameters are als
 
 <tag-name><literal>delete</literal></tag-name>
 <tag-desc>
-deletes the specified network (0.7.23).
+deletes the specified network.
 </tag-desc>
 
 <tag-name><literal>default</literal></tag-name>
@@ -108,33 +104,9 @@ includes a file with addresses and value
 There can be several inclusions.
 </tag-desc>
 
-<tag-name><literal>proxy</literal></tag-name>
-<tag-desc>
-defines trusted addresses (0.8.7, 0.7.63).
-When a request comes from a trusted address,
-an address from the <header>X-Forwarded-For</header> request
-header field will be used instead.
-In contrast to the regular addresses, trusted addresses are
-checked sequentially.
-<note>
-Trusted IPv6 addresses are supported starting from versions 1.3.0 and 1.2.1.
-</note>
-</tag-desc>
-
-<tag-name><literal>proxy_recursive</literal></tag-name>
-<tag-desc>
-enables recursive address search (1.3.0, 1.2.1).
-If recursive search is disabled then instead of the original client
-address that matches one of the trusted addresses, the last
-address sent in <header>X-Forwarded-For</header> will be used.
-If recursive search is enabled then instead of the original client
-address that matches one of the trusted addresses, the last
-non-trusted address sent in <header>X-Forwarded-For</header> will be used.
-</tag-desc>
-
 <tag-name><literal>ranges</literal></tag-name>
 <tag-desc>
-indicates that addresses are specified as ranges (0.7.23).
+indicates that addresses are specified as ranges.
 This parameter should be the first.
 To speed up loading of a geo base, addresses should be put in ascending order.
 </tag-desc>
@@ -149,8 +121,6 @@ geo $country {
     default        ZZ;
     include        conf/geo.conf;
     delete         127.0.0.0/16;
-    proxy          192.168.100.0/24;
-    proxy          2001:0db8::/32;
 
     127.0.0.0/24   US;
     127.0.0.1/32   RU;