etriasnl/openresty

基于bitnami/openresty的envsubst增强镜像

镜像概述

本镜像基于bitnami/openresty构建，主要增强了envsubst功能，支持通过环境变量动态替换Nginx配置模板，实现配置的灵活管理。镜像会自动处理模板文件中的环境变量替换，并将生成的配置应用到OpenResty，简化动态配置场景下的部署流程。

核心功能与特性

1. envsubst支持

内置envsubst工具，可自动替换配置模板中的环境变量，实现配置动态化。

2. 预设默认配置

提供以下默认环境变量配置：

3. 自动化配置流程

• 将Nginx server block模板文件挂载到NGINX_ENVSUBST_TEMPLATE_DIR目录
• 镜像自动使用envsubst替换模板中的环境变量
• 生成的配置文件输出到NGINX_ENVSUBST_OUTPUT_DIR目录
• 自动启动OpenResty服务并应用新配置

使用场景

• 需要根据不同环境（开发、测试、生产）动态调整Nginx配置的场景
• 配置中包含敏感信息或环境特定参数（如域名、端口、API地址等）的场景
• 需要简化配置管理，避免手动修改配置文件的场景

使用方法与配置说明

基本使用步骤

1. 准备配置模板文件
   创建Nginx server block模板文件（后缀名为.conf），在需要动态替换的位置使用环境变量占位符（如${DOMAIN_NAME}）。

2. 挂载模板目录
   将本地模板文件所在目录挂载到容器的NGINX_ENVSUBST_TEMPLATE_DIR目录。

3. 设置环境变量
   通过-e参数或环境变量文件设置需要替换的环境变量。

4. 启动容器
   容器会自动处理模板替换并启动OpenResty。

Docker Run示例

bash
docker run -d \
  -p 80:8080 \
  -v /path/to/local/templates:/opt/bitnami/openresty/nginx/conf/server_block_templates \
  -e DOMAIN_NAME=example.com \
  -e BACKEND_SERVICE=http://backend:8080 \
  your-image-name

自定义环境变量配置

如需修改默认的模板目录、输出目录或文件后缀，可通过环境变量覆盖默认值：

bash
docker run -d \
  -p 80:8080 \
  -v /custom/templates:/my/templates \
  -e NGINX_ENVSUBST_TEMPLATE_DIR=/my/templates \
  -e NGINX_ENVSUBST_TEMPLATE_SUFFIX=.template \
  -e NGINX_ENVSUBST_OUTPUT_DIR=/my/output \
  your-image-name

模板文件示例

创建模板文件/path/to/local/templates/default.conf：

nginx
server {
    listen 8080;
    server_name ${DOMAIN_NAME};

    location / {
        proxy_pass ${BACKEND_SERVICE};
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

启动容器后，环境变量DOMAIN_NAME和BACKEND_SERVICE将被替换，生成的配置文件会输出到NGINX_ENVSUBST_OUTPUT_DIR目录，并被OpenResty加载使用。