# HG changeset patch # User Yaroslav Zhuravlev # Date 1468517585 -10800 # Node ID 3768eb3d9c6ce53d088f36541c6342d5afd3df1b # Parent 0e591e97737c9b369be7c5912c2c2599cabe9689 Documented the geo module in stream. diff -r 0e591e97737c -r 3768eb3d9c6c xml/en/GNUmakefile --- a/xml/en/GNUmakefile Wed Jul 13 21:15:55 2016 +0300 +++ b/xml/en/GNUmakefile Thu Jul 14 20:33:05 2016 +0300 @@ -96,6 +96,7 @@ 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 \ diff -r 0e591e97737c -r 3768eb3d9c6c xml/en/docs/index.xml --- a/xml/en/docs/index.xml Wed Jul 13 21:15:55 2016 +0300 +++ b/xml/en/docs/index.xml Thu Jul 14 20:33:05 2016 +0300 @@ -8,7 +8,7 @@
@@ -492,6 +492,11 @@ + +ngx_stream_geo_module + + + ngx_stream_geoip_module diff -r 0e591e97737c -r 3768eb3d9c6c xml/en/docs/stream/ngx_stream_geo_module.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/xml/en/docs/stream/ngx_stream_geo_module.xml Thu Jul 14 20:33:05 2016 +0300 @@ -0,0 +1,166 @@ + + + + + + + + +
+ + +The ngx_stream_geo_module module (1.11.3) creates variables +with values depending on the client IP address. + + +
+ + +
+ + + +geo $geo { + default 0; + + 127.0.0.1 2; + 192.168.1.0/24 1; + 10.1.0.0/16 1; + + ::1 2; + 2001:0db8::/32 1; +} + + + +
+ + +
+ + +[$address] $variable + +stream + + +Describes the dependency of values of the specified variable +on the client IP address. +By default, the address is taken from the $remote_addr variable, +but it can also be taken from another variable, for example: + +geo $arg_remote_addr $geo { + ...; +} + + + + + +Since variables are evaluated only when used, the mere existence +of even a large number of declared “geo” variables +does not cause any extra costs for connection processing. + + + + +If the value of a variable does not represent a valid IP address +then the “255.255.255.255” address is used. + + + +Addresses are specified either as prefixes in CIDR notation +(including individual addresses) or as ranges. + + + +The following special parameters are also supported: + + +delete + +deletes the specified network. + + +default + +a value set to the variable if the client address does not +match any of the specified addresses. +When addresses are specified in CIDR notation, +“0.0.0.0/0” and “::/0” +can be used instead of default. +When default is not specified, the default +value will be an empty string. + + +include + +includes a file with addresses and values. +There can be several inclusions. + + +ranges + +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. + + + + + + +Example: + +geo $country { + default ZZ; + include conf/geo.conf; + delete 127.0.0.0/16; + + 127.0.0.0/24 US; + 127.0.0.1/32 RU; + 10.1.0.0/16 RU; + 192.168.1.0/24 UK; +} + + + + +The conf/geo.conf file could contain the following lines: + +10.2.0.0/16 RU; +192.168.2.0/24 RU; + + + + +A value of the most specific match is used. +For example, for the 127.0.0.1 address the value “RU” +will be chosen, not “US”. + + + +Example with ranges: + +geo $country { + ranges; + default ZZ; + 127.0.0.0-127.0.0.0 US; + 127.0.0.1-127.0.0.1 RU; + 127.0.0.1-127.0.0.255 US; + 10.1.0.0-10.1.255.255 RU; + 192.168.1.0-192.168.1.255 UK; +} + + + + + +
+ +
diff -r 0e591e97737c -r 3768eb3d9c6c xml/ru/GNUmakefile --- a/xml/ru/GNUmakefile Wed Jul 13 21:15:55 2016 +0300 +++ b/xml/ru/GNUmakefile Thu Jul 14 20:33:05 2016 +0300 @@ -85,6 +85,7 @@ 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 \ diff -r 0e591e97737c -r 3768eb3d9c6c xml/ru/docs/index.xml --- a/xml/ru/docs/index.xml Wed Jul 13 21:15:55 2016 +0300 +++ b/xml/ru/docs/index.xml Thu Jul 14 20:33:05 2016 +0300 @@ -8,7 +8,7 @@
@@ -496,6 +496,11 @@ + +ngx_stream_geo_module + + + ngx_stream_geoip_module diff -r 0e591e97737c -r 3768eb3d9c6c xml/ru/docs/stream/ngx_stream_geo_module.xml --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/xml/ru/docs/stream/ngx_stream_geo_module.xml Thu Jul 14 20:33:05 2016 +0300 @@ -0,0 +1,167 @@ + + + + + + + + +
+ + +Модуль ngx_http_geo_module (1.11.3) создаёт переменные, +значения которых зависят от IP-адреса клиента. + + +
+ + +
+ + + +geo $geo { + default 0; + + 127.0.0.1 2; + 192.168.1.0/24 1; + 10.1.0.0/16 1; + + ::1 2; + 2001:0db8::/32 1; +} + + + +
+ + +
+ + +[$адрес] $переменная + +stream + + +Описывает для указанной переменной зависимость значения от +IP-адреса клиента. +По умолчанию адрес берётся из переменной $remote_addr, +но его также можно получить из другой переменной, например: + +geo $arg_remote_addr $geo { + ...; +} + + + + + +Поскольку переменные вычисляются только в момент использования, +само по себе наличие даже большого числа объявлений переменных +“geo” не влечёт за собой никаких дополнительных +расходов на обработку соединений. + + + + +Если значение переменной не представляет из себя правильный IP-адрес, +то используется адрес “255.255.255.255”. + + + +Адреса задаются либо префиксами в формате CIDR +(включая одиночные адреса), либо в виде диапазонов. + + + +Также поддерживаются следующие специальные параметры: + + +delete + +удаляет описанную сеть. + + +default + +значение переменной, если адрес клиента не соответствует +ни одному из заданных адресов. +При задании адресов в формате CIDR +вместо default можно использовать +“0.0.0.0/0” и “::/0”. +Если параметр default не указан, значением +по умолчанию будет пустая строка. + + +include + +включает файл с адресами и значениями. +Включений может быть несколько. + + +ranges + +указывает, что адреса задаются в виде диапазонов. +Этот параметр должен быть первым. +Для ускорения загрузки гео-базы нужно располагать адреса в порядке возрастания. + + + + + + +Пример: + +geo $country { + default ZZ; + include conf/geo.conf; + delete 127.0.0.0/16; + + 127.0.0.0/24 US; + 127.0.0.1/32 RU; + 10.1.0.0/16 RU; + 192.168.1.0/24 UK; +} + + + + +В файле conf/geo.conf могут быть такие строки: + +10.2.0.0/16 RU; +192.168.2.0/24 RU; + + + + +В качестве значения выбирается максимальное совпадение, например, +для адреса 127.0.0.1 будет выбрано значение “RU”, +а не “US”. + + + +Пример описания диапазонов: + +geo $country { + ranges; + default ZZ; + 127.0.0.0-127.0.0.0 US; + 127.0.0.1-127.0.0.1 RU; + 127.0.0.2-127.0.0.255 US; + 10.1.0.0-10.1.255.255 RU; + 192.168.1.0-192.168.1.255 UK; +} + + + + + +
+ +