Mercurial > hg > nginx-site
changeset 1751:3768eb3d9c6c
Documented the geo module in stream.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Thu, 14 Jul 2016 20:33:05 +0300 |
parents | 0e591e97737c |
children | b4de612feff8 |
files | xml/en/GNUmakefile xml/en/docs/index.xml xml/en/docs/stream/ngx_stream_geo_module.xml xml/ru/GNUmakefile xml/ru/docs/index.xml xml/ru/docs/stream/ngx_stream_geo_module.xml |
diffstat | 6 files changed, 34 insertions(+), 81 deletions(-) [+] |
line wrap: on
line diff
--- a/xml/en/GNUmakefile +++ b/xml/en/GNUmakefile @@ -96,6 +96,7 @@ REFS = \ mail/ngx_mail_ssl_module \ stream/ngx_stream_access_module \ stream/ngx_stream_core_module \ + stream/ngx_stream_geo_module \ stream/ngx_stream_geoip_module \ stream/ngx_stream_limit_conn_module \ stream/ngx_stream_map_module \
--- a/xml/en/docs/index.xml +++ b/xml/en/docs/index.xml @@ -8,7 +8,7 @@ <article name="nginx documentation" link="/en/docs/" lang="en" - rev="27" + rev="28" toc="no"> @@ -492,6 +492,11 @@ ngx_stream_access_module</link> </listitem> <listitem> +<link doc="stream/ngx_stream_geo_module.xml"> +ngx_stream_geo_module</link> +</listitem> + +<listitem> <link doc="stream/ngx_stream_geoip_module.xml"> ngx_stream_geoip_module</link> </listitem>
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;
--- a/xml/ru/GNUmakefile +++ b/xml/ru/GNUmakefile @@ -85,6 +85,7 @@ REFS = \ mail/ngx_mail_ssl_module \ stream/ngx_stream_access_module \ stream/ngx_stream_core_module \ + stream/ngx_stream_geo_module \ stream/ngx_stream_geoip_module \ stream/ngx_stream_limit_conn_module \ stream/ngx_stream_map_module \
--- a/xml/ru/docs/index.xml +++ b/xml/ru/docs/index.xml @@ -8,7 +8,7 @@ <article name="nginx: документация" link="/ru/docs/" lang="ru" - rev="27" + rev="28" toc="no"> @@ -496,6 +496,11 @@ ngx_stream_access_module</link> </listitem> <listitem> +<link doc="stream/ngx_stream_geo_module.xml"> +ngx_stream_geo_module</link> +</listitem> + +<listitem> <link doc="stream/ngx_stream_geoip_module.xml"> ngx_stream_geoip_module</link> </listitem>
copy from xml/ru/docs/http/ngx_http_geo_module.xml copy to xml/ru/docs/stream/ngx_stream_geo_module.xml --- a/xml/ru/docs/http/ngx_http_geo_module.xml +++ b/xml/ru/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="Модуль ngx_http_geo_module" - link="/ru/docs/http/ngx_http_geo_module.html" +<module name="Модуль ngx_stream_geo_module" + link="/ru/docs/stream/ngx_stream_geo_module.html" lang="ru" - rev="5"> + rev="1"> <section id="summary"> <para> -Модуль <literal>ngx_http_geo_module</literal> создаёт переменные, +Модуль <literal>ngx_http_geo_module</literal> (1.11.3) создаёт переменные, значения которых зависят от IP-адреса клиента. </para> @@ -47,13 +46,13 @@ geo $geo { <directive name="geo"> <syntax block="yes">[<value>$адрес</value>] <value>$переменная</value></syntax> <default/> -<context>http</context> +<context>stream</context> <para> Описывает для указанной переменной зависимость значения от IP-адреса клиента. По умолчанию адрес берётся из переменной <var>$remote_addr</var>, -но его также можно получить из другой переменной (0.7.27), например: +но его также можно получить из другой переменной, например: <example> geo $arg_remote_addr $geo { ...; @@ -66,7 +65,7 @@ geo $arg_remote_addr $geo { Поскольку переменные вычисляются только в момент использования, само по себе наличие даже большого числа объявлений переменных “<literal>geo</literal>” не влечёт за собой никаких дополнительных -расходов на обработку запросов. +расходов на обработку соединений. </note> </para> @@ -77,10 +76,7 @@ geo $arg_remote_addr $geo { <para> Адреса задаются либо префиксами в формате CIDR -(включая одиночные адреса), либо в виде диапазонов (0.7.23). -<note> -IPv6-префиксы поддерживаются начиная с версий 1.3.10 и 1.2.7. -</note> +(включая одиночные адреса), либо в виде диапазонов. </para> <para> @@ -89,7 +85,7 @@ IPv6-префиксы поддерживаются начиная с версий 1.3.10 и 1.2.7. <tag-name><literal>delete</literal></tag-name> <tag-desc> -удаляет описанную сеть (0.7.23). +удаляет описанную сеть. </tag-desc> <tag-name><literal>default</literal></tag-name> @@ -109,32 +105,9 @@ IPv6-префиксы поддерживаются начиная с версий 1.3.10 и 1.2.7. Включений может быть несколько. </tag-desc> -<tag-name><literal>proxy</literal></tag-name> -<tag-desc> -задаёт доверенные адреса (0.8.7, 0.7.63), -при запросе с которых будет использоваться адрес в переданном -поле заголовка запроса <header>X-Forwarded-For</header>. -В отличие от обычных адресов, доверенные адреса проверяются -последовательно. -<note> -Доверенные IPv6-адреса поддерживаются начиная с версий 1.3.0 и 1.2.1. -</note> -</tag-desc> - -<tag-name><literal>proxy_recursive</literal></tag-name> -<tag-desc> -включает рекурсивный поиск адреса (1.3.0, 1.2.1). -При выключенном рекурсивном поиске вместо исходного адреса клиента, -совпадающего с одним из доверенных адресов, будет использоваться последний -адрес, переданный в <header>X-Forwarded-For</header>. -При включённом рекурсивном поиске вместо исходного адреса клиента, -совпадающего с одним из доверенных адресов, будет использоваться последний -не доверенный адрес, переданный в <header>X-Forwarded-For</header>. -</tag-desc> - <tag-name><literal>ranges</literal></tag-name> <tag-desc> -указывает, что адреса задаются в виде диапазонов (0.7.23). +указывает, что адреса задаются в виде диапазонов. Этот параметр должен быть первым. Для ускорения загрузки гео-базы нужно располагать адреса в порядке возрастания. </tag-desc> @@ -149,8 +122,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;