nunofernandes/nginx-base

nginx-alt 镜像

镜像概述和主要用途

nginx-alt是一个nginx服务器的基础镜像，基于官方nginx Alpine镜像构建。它提供了一个入口点脚本，能够将nginx.conf.tmpl模板文件动态生成为最终的nginx配置文件。通过这种机制，用户可以灵活调整监听端口、文档根目录等配置，无需修改原始配置文件，特别适合需要动态配置nginx的场景。

核心功能和特性

• 基于官方镜像：构建于轻量级的nginx Alpine镜像之上，保持基础镜像的可靠性和小巧体积
• 模板配置机制：通过nginx.conf.tmpl模板文件支持动态配置生成
• 环境变量替换：支持两种变量替换方式
  • ${VAR_NAME}：直接替换为环境变量VAR_NAME的值（必填参数）
  • ${VAR_NAME:-default_value}：若环境变量VAR_NAME不存在，则使用default_value（可选参数）
• 默认配置参数：内置常用配置的环境变量，无需自定义模板即可快速调整
• 灵活扩展：子镜像可添加自定义nginx.conf.tmpl，同时保留环境变量自定义能力

使用场景和适用范围

• 需要在不同环境中动态调整nginx监听端口的场景
• 多容器部署时需要为每个nginx实例设置不同文档根目录的情况
• 希望通过环境变量而非修改配置文件来调整nginx行为的需求
• 需要快速构建包含自定义nginx配置的应用镜像

使用方法和配置说明

快速开始

使用该镜像的基本步骤：

1. 在项目中创建Dockerfile，以nunofernandes/nginx-base为基础镜像
2. 将项目的nginx.conf复制到容器内/etc/nginx/nginx.conf.tmpl路径（默认入口点脚本会自动进行变量替换并生成/etc/nginx/nginx.conf）
3. 如需部署静态资源，将其复制到文档根目录（默认/usr/share/nginx/html，可通过环境变量调整）

构建并运行镜像即可使用。

默认入口点还提供额外功能：

• 使用sh作为docker run命令参数可进入容器shell：

  bash
  docker run -it --rm docker.xuanyuan.run/your-nginx-alt-based-image sh
  / # exit
  

• 使用usage作为docker run命令参数可查看使用文档：

  bash
  docker run -it --rm docker.xuanyuan.run/your-nginx-alt-based-image usage
  

变量替换

入口点脚本支持两种变量替换方式：

• 必填参数替换：${VAR_NAME}

  • 直接替换为环境变量VAR_NAME的值
  • 若环境变量未设置，替换会失败

• 可选参数替换：${VAR_NAME:-default_value}

  • 若环境变量VAR_NAME存在，则使用其值
  • 若环境变量不存在，则使用default_value

默认nginx.conf.tmpl

默认的nginx.conf.tmpl与官方nginx Alpine镜像的默认nginx.conf相同，并通过环境变量添加了以下可配置项：

注：镜像默认暴露80端口，若使用Docker网络，可忽略PORT变量，直接使用Docker端口映射功能。

自定义nginx.conf.tmpl

若需要使用自定义模板，有两种方式：

1. 通过Dockerfile构建

在自定义镜像构建过程中，将自定义模板复制到容器内：

dockerfile
FROM docker.xuanyuan.run/nunofernandes/nginx-base
COPY nginx.conf.tmpl /etc/nginx/nginx.conf.tmpl

2. 通过运行时挂载

无需构建自定义镜像，直接在运行时挂载模板文件：

bash
docker run -v /本地路径/my.nginx.conf.tmpl:/etc/nginx/nginx.conf.tmpl docker.xuanyuan.run/nunofernandes/nginx-base