Nginx官方文档(十八)【ngx_http_geoip_module|ngx_http_grpc_module】

ngx_http_geoip_module

ngx_http_geoip_module 模块(0.8.6+)使用预编译的 MaxMind 数据库,其创建带值的变量依赖客户端 IP 地址。

当使用支持 IPv6 的数据库时(1.3.12、1.2.7),IPv4 地址将被视为 IPv4 映射的 IPv6 地址。

此模块不是默认构建的,可以使用 --with-http_geoip_module 配置参数启用。

该模块需要 MaxMind GeoIP 库。

示例配置

http {
    geoip_country         GeoIP.dat;
    geoip_city            GeoLiteCity.dat;
    geoip_proxy           192.168.100.0/24;
    geoip_proxy           2001:0db8::/32;
    geoip_proxy_recursive on;
    ...

指令

geoip_country

-说明
语法geoip_country file;
默认——
上下文http

指定一个用于根据客户端 IP 地址确定国家的数据库。使用此数据库时,以下变量可用:

  • $geoip_country_code

    双字母国家代码,例如 RUUS

  • $geoip_country_code3

    三个字母的国家代码,例如 RUSUSA

  • $geoip_country_name

    国家名称,例如 Russian FederationUnited States

geoip_city

-说明
语法geoip_city file;
默认——
上下文http

指定一个用于根据客户端 IP 地址确定国家、地区和城市的数据库。使用此数据库时,以下变量可用:

  • $geoip_area_code

    电话区号(仅限美国)

    由于相应的数据库字段已弃用,因此此变量可能包含过时的信息

  • $geoip_city_continent_code

    双字母的大陆码,例如 EUNA

  • $geoip_city_country_code

    双字母国家代码,例如 RUUS

  • $geoip_city_country_code3

    三个字母的国家代码,例如 RUSUSA

  • $geoip_city_country_name

    国家名称,例如 Russian FederationUnited States

  • $geoip_dma_code

    美国的 DMA 地区代码(也称为城市代码),根据 Google AdWords API 中的地理位置定位

  • $geoip_latitude

    纬度

  • $geoip_longitude

    经度

  • $geoip_region

    双符号国家地区代码(地区、领土、州、省、联邦土地等),例如 48DC

  • $geoip_region_name

    国家地区名称(地区,领土,州,省,联邦土地等),例如 Moscow CityDistrict of Columbia

  • $geoip_city

    城市名称,例如 MoscowWashington

  • $geoip_postal_code

    邮政编码

geoip_org

-说明
语法geoip_org file;
默认——
上下文http
提示该指令在 1.0.3 版本中出现

指定用于根据客户端 IP 地址确定组织的数据库。使用此数据库时,以下变量可用:

  • $geoip_org

    组织名称,例如 The University of Melbourne

geoip_proxy

-说明
语法geoip_proxy address | CIDR;
默认——
上下文http
提示该指令在 1.3.0 版本和 1.2.1. 版本中出现

定义可信地址。当请求来自可信地址时,将使用来自 X-Forwarded-For 请求头字段的地址。

geoip_proxy_recursive

-说明
语法geoip_proxy_recursive on | off;
默认geoip_proxy_recursive off;
上下文http
提示该指令在 1.3.0 版本和 1.2.1. 版本中出现

如果递归搜索被禁用,那么将使用在 X-Forwarded-For 中发送的最后一个地址,而不是匹配其中一个可信地址的原始客户端地址。如果启用递归搜索,则将使用在 X-Forwarded-For 中发送的最后一个不可信地址,而不是匹配其中一个可信地址的原始客户端地址。

原文档

http://nginx.org/en/docs/http/ngx_http_geoip_module.html


- grpc_bind

ngx_http_grpc_module

ngx_http_grpc_module 模块允许将请求传递给 gRPC 服务器(1.13.10)。该模块需要 ngx_http_v2_module 模块的支持。

示例配置

server {
    listen 9000 http2;

    location / {
        grpc_pass 127.0.0.1:9000;
    }
}

指令

grpc_bind

-说明
语法map address [transparent ] | off;
默认——
上下文http、server、location

连接到一个指定了本地 IP 地址和可选端口的 gRPC 服务器。参数值可以包含变量。特殊值 off 取消从上层配置级别继承的 grpc_bind 指令的作用,其允许系统自动分配本地 IP 地址和端口。

transparent 参数允许出站从非本地 IP 地址到 gRPC 服务器的连接(例如,来自客户端的真实 IP 地址):

grpc_bind $remote_addr transparent;

为了使这个参数起作用,通常需要以超级用户权限运行 nginx worker 进程。在 Linux 上,不需要指定 transparent 参数,工作进程会继承 master 进程的 CAP_NET_RAW 功能。此外,还要配置内核路由表来拦截来自 gRPC 服务器的网络流量。

grpc_buffer_size

-说明
语法grpc_buffer_size size;
默认grpc_buffer_size 4k|8k;
上下文http、server、location

设置用于读取从 gRPC 服务器收到的响应的缓冲区的大小(size)。一旦收到响应,响应便会同步传送给客户端。

grpc_connect_timeout

-说明
语法grpc_connect_timeout time;
默认grpc_connect_timeout 60s;
上下文http、server、location

定义与 gRPC 服务器建立连接的超时时间。需要说明的是,超时通常不能超过 75 秒。

grpc_hide_header

-说明
语法grpc_hide_header field;
默认——
上下文http、server、location

默认情况下,nginx 不会将 gRPC 服务器响应中的头字段 DateServerX-Accel-... 传送给客户端。grpc_hide_header 指令设置了不会被传送的附加字段。相反,如果需要允许传送字段,则可以使用 grpc_pass_header 指令设置。

grpc_ignore_headers

-说明
语法grpc_ignore_headers field ...;
默认——
上下文http、server、location

禁用处理来自 gRPC 服务器的某些响应头字段。以下字段可以忽略:X-Accel-RedirectX-Accel-Charset

如果未禁用,处理这些头字段将产生以下作用:

grpc_intercept_errors

-说明
语法grpc_intercept_errors on | off;
默认grpc_intercept_errors off;
上下文http、server、location

确定状态码大于或等于 300 的 gRPC 服务器响应是应该传送给客户端还是拦截并重定向到 nginx 使用 error_page 指令进行处理。

grpc_next_upstream

-说明
语法grpc_next_upstream error | timeout | invalid_header | http_500 | http_502 | http_503 | http_504 | http_403 | http_404 | http_429 | non_idempotent | off ...;
默认grpc_next_upstream error timeout;
上下文http、server、location

指定在哪些情况下请求应传递给下一个服务器:

  • error

    在与服务器建立连接、传递请求或读取响应头时发生错误

  • timeout

    在与服务器建立连接、传递请求或读取响应头时发生超时

  • invalid_header

    服务器返回了空的或无效的响应

  • http_500

    服务器返回状态码为 500 的响应

  • http_502

    服务器返回状态码为 502 的响应

  • http_503

    服务器返回状态码为 503 的响应

  • http_504

    服务器返回状态码为 504 的响应

  • http_403

    服务器返回状态码为 403 的响应

  • http_404

    服务器返回状态码为 404 的响应

  • http_429

    服务器返回状态码为 429 的响应

  • non_idempotent

    通常,如果请求已发送到上游服务器,请求方法为非幂等(POST、LOCK、PATCH)的请求是不会传送到下一个服务器,使这个选项将明确允许重试这样的请求

  • off

    禁止将请求传递给下一个服务器

我们应该记住,只有在没有任何内容发送给客户端的情况下,才能将请求传递给下一个服务器。也就是说,如果在响应传输过程中发生错误或超时,修复这样的错误是不可能的。

该指令还定义了与服务器进行通信的失败尝试errortimeoutinvalid_header 的情况总是被认为是失败尝试,即使它们没有在指令中指定。只有在指令中指定了 http_500http_502http_503http_504http_429 的情况下,才会将其视为失败尝试。http_403http_404 的情况永远不会被视为失败尝试。

将请求传递给下一个服务器可能受到尝试次数时间的限制。

grpc_next_upstream_timeout

-说明
语法grpc_next_upstream_timeout time;
默认grpc_next_upstream_timeout 0;
上下文http、server、location

限制请求可以传递到下一个服务器的时间。0 值表示关闭此限制。

grpc_next_upstream_tries

-说明
语法grpc_next_upstream_tries number;
默认grpc_next_upstream_tries 0;
上下文http、server、location

限制尝试将请求传递到下一个服务器的次数。0 值表示关闭此限制。

grpc_pass

-说明
语法grpc_pass address;
默认——
上下文location、location 中的 if

设置 gRPC 服务器地址。该地址可以指定为域名或 IP 地址以及端口:

grpc_pass localhost:9000;

或使用 UNIX 域套接字路径:

grpc_pass unix:/tmp/grpc.socket;

或使用 grpc:// scheme:

grpc_pass grpc://127.0.0.1:9000;

要 gRPC 配合 SSL,应该使用 grpcs:// scheme:

grpc_pass grpcs://127.0.0.1:443;

如果域名解析为多个地址,则这些地址将以循环方式使用。另外,地址可以被指定为服务器组

grpc_pass_header

-说明
语法grpc_pass_header field;
默认——
上下文http、server、location

允许从 gRPC 服务器向客户端传递忽略的头字段。

grpc_read_timeout

-说明
语法grpc_read_timeout time;
默认grpc_read_timeout 60s;
上下文http、server、location

定义从 gRPC 服务器读取响应的超时时间。超时间隔只在两次连续的读操作之间,而不是整个响应的传输过程。如果 gRPC 服务器在此时间内没有发送任何内容,则连接关闭。

grpc_send_timeout

-说明
语法grpc_send_timeout time;
默认grpc_send_timeout 60s;
上下文http、server、location

设置向 gRPC 服务器发送请求的超时时间。超时间隔只在两次连续写入操作之间,而不是整个请求的传输过程。如果 gRPC 服务器在此时间内没有收到任何内容,则连接将关闭。

grpc_set_header

-说明
语法grpc_set_header field value;
默认grpc_set_header Content-Length $content_length;
上下文http、server、location

允许重新定义或附加字段到传递给 gRPC 服务器的请求头。该值可以包含文本、变量及其组合。当且仅当在当前级别上没有定义 grpc_set_header 指令时,这些指令才从上一级继承。

如果头字段的值是一个空字符串,那么这个字段将不会被传递给 gRPC 服务器:

grpc_set_header Accept-Encoding "";

grpc_ssl_certificate

-说明
语法grpc_ssl_certificate file;
默认——
上下文http、server、location

指定一个带有 PEM 格式证书的文件(file),用于向 gRPC SSL 服务器进行身份验证。

grpc_ssl_certificate_key

-说明
语法grpc_ssl_certificate_key file;
默认——
上下文http、server、location

指定一个文件(file),其包含 PEM 格式的密钥,用于对 gRPC SSL 服务器进行身份验证。

可以指定值 engine:name:id 来代替 file,其从 OpenSSL 引擎 name 加载具有指定 id 的密钥。

grpc_ssl_ciphers

-说明
语法grpc_ssl_ciphers ciphers;
默认grpc_ssl_ciphers DEFAULT;
上下文http、server、location

指定对 gRPC SSL 服务器的请求启用的密码。密码格式能被 OpenSSL 库所支持。

完整的列表详情可以使用 openssl ciphers 命令查看。

grpc_ssl_crl

-说明
语法grpc_ssl_crl file;
默认——
上下文http、server、location

指定一个带有 PEM 格式的撤销证书(CRL)的文件(file),用于验证 gRPC SSL 服务器的证书。

grpc_ssl_name

-说明
语法grpc_ssl_name name;
默认grpc_ssl_name host from grpc_pass;
上下文http、server、location

允许重写用于验证 gRPC SSL 服务器的证书并在与 gRPC SSL 服务器建立连接时通过 SNI 传递的服务器名称。

默认情况下,使用 grpc_pass 的主机部分。

grpc_ssl_password_file

-说明
语法grpc_ssl_password_file file;
默认——
上下文http、server、location

指定一个密码为密钥的文件,每个密码在单独的行上指定。加载密钥时会依次尝试每个密码。

grpc_ssl_server_name

-说明
语法grpc_ssl_server_name on | off;
默认grpc_ssl_server_name off;
上下文http、server、location

在建立与 gRPC SSL 服务器的连接时,启用或禁用通过 TLS 服务器名称指示扩展(SNI,RFC 6066)传送服务器名称。

grpc_ssl_session_reuse

-说明
语法grpc_ssl_session_reuse on | off;
默认grpc_ssl_session_reuse on;
上下文http、server、location

确定在使用 gRPC 服务器时是否可以重用 SSL 会话。如果错误 SSL3_GET_FINISHED:digest check fialed 出现在日志中,尝试禁用会话重用。

grpc_ssl_protocols

-说明
语法grpc_ssl_protocols [SSLv2] [SSLv3] [TLSv1] [TLSv1.1] [TLSv1.2] [TLSv1.3];
默认grpc_ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
上下文http、server、location

对 gRPC SSL 服务器的请求启用指定的协议。

grpc_ssl_trusted_certificate

-说明
语法grpc_ssl_trusted_certificate file;
默认——
上下文http、server、location

指定一个带有 PEM 格式的可信 CA 证书的文件,用于验证 gRPC SSL 服务器的证书。

grpc_ssl_verify

-说明
语法grpc_ssl_verify on | off;
默认grpc_ssl_verify off;
上下文http、server、location

启用或禁用验证 gRPC SSL 服务器证书。

grpc_ssl_verify_depth

-说明
语法grpc_ssl_verify_depth number;
默认grpc_ssl_verify_depth 1;
上下文http、server、location

设置 gRPC SSL 服务器证书链中的验证深度。

原文档

http://nginx.org/en/docs/http/ngx_http_grpc_module.html

©️2020 CSDN 皮肤主题: 编程工作室 设计师:CSDN官方博客 返回首页
实付 9.90元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值