zappi/nginx-proxy

Docker Nginx Proxy

这是一个基础反向代理工具，主要用于简化请求头的处理操作。

使用方法

配置上游服务时，需创建 app.conf 文件并编写 server 块，示例如下：

nginx
server {
    listen 8080;  # 监听端口

    location / {
        proxy_pass [];  # 代理请求到上游服务（此处示例上游服务地址为 app:80）
    }
}

创建完成后，将该文件放置在容器内的 /etc/nginx 目录下。

请求头处理

在 server 块中，可通过 headers-more 模块对请求头进行处理，支持移除或设置请求头，示例如下：

nginx
server {
    ...  # 其他配置

    # 移除请求头（示例：移除 Server 头）
    more_clear_headers "Server";

    # 设置请求头（示例：设置 X-Robots-Tag 头）
    more_set_headers 'X-Robots-Tag: "noindex, nofollow"';

    ...  # 其他配置
}

追踪配置

如需开启可观测性，可启用追踪传播并将遥测数据发送到 OTel 收集器，配置示例如下：

nginx
otel_trace          on;  # 开启追踪
otel_service_name   example_service:nginx;  # 服务名称（自定义）
otel_trace_context  propagate;  # 传播追踪上下文
otel_exporter {
    endpoint        otel-collector:4317;  # OTel 收集器地址（示例）
    interval        5s;  # 发送间隔
    batch_size      512;  # 批处理大小
    batch_count     4;  # 批处理数量
}

进一步自定义

由于 app.conf 中定义的是标准 Nginx server 块，因此可根据需求添加更多自定义配置。例如，添加自定义 location 规则：

nginx
server {
    ...  # 其他配置

    # 示例：自定义 /robots.txt 路径，返回默认禁止所有爬虫的规则
    location /robots.txt {
        alias /etc/nginx/robots.txt;  # 关联到容器内的 /etc/nginx/robots.txt 文件
    }

    ...  # 其他配置
}

日志配置

如需修改日志行为，可将自定义日志配置文件挂载到容器内的 /etc/nginx/log.conf。例如，关闭日志输出：

nginx
access_log off;  # 关闭访问日志
error_log off;   # 关闭错误日志

核心配置

如需修改 Nginx 核心配置（如 main 区块的配置，详见 Nginx 核心模块文档），可将自定义配置文件挂载到容器内的 /etc/nginx/main.conf。示例：

nginx
worker_processes auto;  # 工作进程数自动调整
worker_shutdown_timeout 300s;  # 工作进程关闭超时时间

注意：覆盖此文件会移除默认配置，建议从默认配置副本开始修改。

健康检查

工具内置健康检查接口，可通过 18081 端口的 /healthz 路径访问。