<!-- review: finished -->

<a id="http-geo"></a>

# Geo

该模块根据客户端 IP 地址创建具有不同值的变量。

<a id="configuration-example-16"></a>

## 配置示例

```nginx
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;
}
```

<a id="directives-17"></a>

## 指令

<a id="index-0"></a>

<a id="id3"></a>

### geo

| [语法](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile)   | `geo` [$address] $variable { ... }   |
|--------------------------------------------------------------------------------------|--------------------------------------|
| 默认值                                                                                  | —                                    |
| [上下文](https://cn.angie.software//angie/docs/configuration/configfile.md#configfile)  | http                                 |

描述了指定变量的值如何依赖于客户端 IP 地址。默认情况下，地址从 [$remote_addr](https://cn.angie.software//angie/docs/configuration/modules/http/index.md#v-remote-addr) 变量中获取，但也可以从其他变量中获取，例如：

```nginx
geo $arg_remote_addr $geo {
    ...;
}
```

#### NOTE
由于变量仅在使用时才会被计算，即使声明了大量的 `geo` 变量，也不会对请求处理造成额外开销。

如果变量的值不是有效的 IP 地址，则会使用 "255.255.255.255" 地址。

地址可以用 CIDR 表示法指定为前缀（包括单个地址）或作为范围。

还支持以下特殊参数：

| `delete`          | 删除指定的网络                                                                                                                                     |
|-------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
| `default`         | 如果客户端地址不匹配任何指定的地址，则为变量设置的值。当地址以 CIDR 表示法指定时，可以使用 `0.0.0.0/0` 和 `::/0` 代替 `default`。如果未指定 `default`，则默认值将为空字符串                               |
| `include`         | 包含一个带有地址和值的文件。可以有多个包含。                                                                                                                      |
| `proxy`           | 定义受信任的地址。当请求来自受信任的地址时，将使用 `X-Forwarded-For` 请求头字段中的地址。与常规地址不同，受信任的地址是按顺序检查的。                                                                |
| `proxy_recursive` | 启用递归地址搜索。如果禁用递归搜索，则将使用 `X-Forwarded-For` 中发送的最后一个地址，而不是与受信任地址匹配的原始客户端地址。如果启用递归搜索，则将使用 `X-Forwarded-For` 中发送的最后一个非受信任地址，而不是与受信任地址匹配的原始客户端地址。 |
| `ranges`          | 表示地址是作为范围指定的。此参数应为第一个。为加快地理数据库的加载，地址应按升序排列。                                                                                                 |
| `volatile`        | 表示该变量不可缓存。                                                                                                                                  |

示例：

```nginx
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;
    10.1.0.0/16    RU;
    192.168.1.0/24 UK;
}
```

`conf/geo.conf` 文件可能包含以下行：

```console
10.2.0.0/16    RU;
192.168.2.0/24 RU;
```

使用最具体的匹配值。例如，对于 `127.0.0.1` 地址，将选择值 `RU`，而不是 `US`。

示例范围描述：

```nginx
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;
}
```