模块 ngx_mgmt_module

ngx_mgmt_module 模块启用 NGINX Plus 许可证验证和使用情况报告。对于每个 nginx/1.27.2 (nginx-plus-r33) 实例，这是强制性的。

一个名为 license.jwt 的 JWT 许可证文件应位于 Linux 的 /etc/nginx/ 或 FreeBSD 的 /usr/local/etc/nginx/，或位于由 license_token 指令指定的路径。许可证文件可从 MyF5 获取。

使用情况报告通过 安全 连接直接或通过 代理 发送给 F5 许可端点，每小时 发送一次。可选地，在网络受限环境中，报告可以 配置 发送给 F5 NGINX Instance Manager，然后从此处将报告发送到 F5 许可端点。

默认情况下，如果 F5 许可端点未接收到 初始使用情况报告，nginx 将停止处理流量。

此模块作为我们的 商业订阅 的一部分提供。

mgmt {
    # in case if custom path is required
    license_token custom/file/path/license.jwt;

    # in case of reporting to NGINX Instance Manager
    usage_report endpoint=NIM_FQDN;
}

提供配置文件的上下文，在此上下文中指定使用情况报告和许可证管理指令。

enforce_initial_report on;

启用或禁用发送初始使用情况报告的 180 天宽限期。

初始使用情况报告在 nginx 安装后首次启动时立即发送。默认情况下，如果 F5 许可端点未接收到初始报告，nginx 将停止处理流量，直到报告成功送达。将指令值设置为 off 将启用 180 天宽限期，在此期间，初始使用情况报告必须由 F5 许可端点接收。

license_token license.jwt;

指定一个 JWT 许可证 file。默认情况下，对于 Linux，license.jwt 文件应位于 /etc/nginx/；对于 FreeBSD，则应位于 /usr/local/etc/nginx/。

设置用于发送使用情况报告的 HTTP CONNECT 代理。

设置用于在 代理 上进行认证的用户名。

设置用于在 代理 上进行认证的密码。

默认情况下，密码以未加密方式发送。如果代理支持 TLS，可以使用 stream 模块保护到代理的连接。

mgmt {
    proxy          127.0.0.1:8080;
    proxy_username <name>;
    proxy_password <password>;
}

stream {
    server {
        listen 127.0.0.1:8080;
        
        proxy_ssl                     on;
        proxy_ssl_verify              on;
        proxy_ssl_trusted_certificate <proxy_ca_file>;

        proxy_pass <proxy_host>:<proxy_port>;
    }
}

配置用于解析使用情况报告端点名称的名称服务器。默认情况下，使用系统解析器。

详细信息请参阅 resolver 指令。

指定一个包含 PEM 格式的吊销证书 (CRL) 的 file，用于 验证 使用情况报告端点的证书。

ssl_trusted_certificate system CA bundle;

指定一个包含 PEM 格式的受信任 CA 证书的 file，用于 验证 使用情况报告端点的证书。

ssl_verify on;

启用或禁用使用情况报告端点证书的验证。

在 1.27.2 之前，默认值是 off。

定义一个目录，用于存储由 ngx_mgmt_module 模块创建的状态文件（nginx-mgmt-*）。Linux 的默认目录是 /var/lib/nginx/state，FreeBSD 的默认目录是 /var/db/nginx/state。

usage_report endpoint=product.connect.nginx.com interval=1h;

设置使用情况报告端点的 address 和 port。interval 参数设置两个连续报告之间的间隔。

在 1.27.2 之前，默认值是 nginx-mgmt.local 和 30m。