dhswt/nginx-basic-auth

dhswt/nginx-basic-auth 镜像说明

镜像概述

该镜像封装了NGINX反向代理并集成基础认证功能，旨在为无内置认证机制的后端服务提供简单高效的访问控制。通过环境变量即可灵活配置监听端口、认证领域、用户凭证及转发目标，无需手动编写复杂的NGINX配置文件。

核心功能

• 支持HTTP基础认证（Basic Auth），可通过文件或内联方式提供用户凭证
• 可配置监听端口、认证领域名称（显示在认证弹窗中）
• 支持转发至任意后端服务（指定协议、主机及端口）
• 兼容Swarm/Kubernetes环境，可通过Secret挂载htpasswd文件

使用场景

• 为内部测试服务添加临时访问控制
• 保护无认证的后端API或Web应用
• 快速搭建带认证的代理层，无需修改后端服务代码

配置说明

以下环境变量用于配置容器（括号内为默认值）：

部署示例

Docker Run 命令

bash
# 生成加密密码（需安装openssl）
PASSWORD=$(openssl passwd -apr1 mysecurepassword)

# 启动容器
docker run -d \
  -p 8080:8080 \
  -e LISTEN_PORT=8080 \
  -e AUTH_REALM="My Protected Service" \
  -e HTPASSWD="admin:$PASSWORD" \
  -e FORWARD_PROTOCOL=http \
  -e FORWARD_HOST=my-backend \
  -e FORWARD_PORT=80 \
  dhswt/nginx-basic-auth

生成的NGINX配置

上述命令将生成如下配置文件（/etc/nginx/conf.d/auth.conf）：

nginx
server {
    listen 8080 default_server;

    location / {
        auth_basic           "My Protected Service";
        auth_basic_user_file /etc/nginx/conf.d/auth.htpasswd;

        proxy_pass         [***]
        proxy_read_timeout 900;

        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}