neighborhoods/nginx-extra

Nginx 扩展模块镜像

镜像概述和主要用途

本镜像为预配置了额外模块的Nginx镜像，旨在提供增强的Web服务器功能。除基础Nginx功能外，还集成了特定扩展模块，并支持通过环境变量动态渲染配置模板，适用于需要自定义认证机制或动态配置管理的场景。

核心功能和特性

1. 额外模块支持

• ldap模块：集成自 https://github.com/kvspb/nginx-auth-ldap 项目，提供基于LDAP的认证功能。

2. 配置模板渲染

• 容器启动时，自动渲染 /etc/nginx/conf.templates.d/ 目录下的模板文件
• 使用 envsubst 工具进行变量替换
• 仅替换 NGINX_TEMPLATE_VARS 环境变量中指定的变量（变量间用逗号分隔，无空格）

使用场景和适用范围

• 需要通过LDAP进行用户认证的Web服务
• 需要根据环境变量动态调整Nginx配置的场景
• 需自定义Nginx模块功能的企业级应用部署

使用方法和配置说明

基本运行命令

bash
docker run -d --name nginx-extra-modules -p 80:80 your-image-name

配置模板使用

1. 准备模板文件

将需动态配置的Nginx配置文件（如 nginx.conf.template）放置在宿主机目录（如 ./conf.templates），模板中使用 ${VARIABLE_NAME} 标记需替换的变量。

2. 设置环境变量

通过 -e 参数指定 NGINX_TEMPLATE_VARS 及其他需替换的变量：

bash
docker run -d \
  --name nginx-extra-modules \
  -p 80:80 \
  -v ./conf.templates:/etc/nginx/conf.templates.d \
  -e NGINX_TEMPLATE_VARS="BACKEND_HOST,PORT" \
  -e BACKEND_HOST="192.168.1.100" \
  -e PORT="8080" \
  your-image-name

3. 模板渲染逻辑

容器启动时，会处理 /etc/nginx/conf.templates.d/ 下的所有模板文件，将 ${BACKEND_HOST} 和 ${PORT} 替换为环境变量值，并生成最终配置文件。

模块使用

如需使用ldap模块，需在Nginx配置中添加相应配置，例如：

nginx
server {
    listen 80;
    server_name example.com;

    auth_ldap "LDAP Authentication";
    auth_ldap_url "ldap://ldap.example.com:389/dc=example,dc=com?uid?sub?(objectClass=*)";
    auth_ldap_binddn "cn=admin,dc=example,dc=com";
    auth_ldap_binddn_passwd "password";
    auth_ldap_group_attribute member;
    auth_ldap_group_attribute_is_dn on;
    auth_ldap_require group "cn=nginx-users,ou=groups,dc=example,dc=com";

    location / {
        root /usr/share/nginx/html;
        index index.html;
    }
}