chiib01/base-image-express

环境变量配置基础镜像文档

镜像概述

本Docker镜像为基础环境配置镜像，主要用于定义和管理服务运行时的核心环境变量，提供SERVICE_NAME（服务名称）、PORT（服务端口）和PATH_PATTERN（路径模式）三个关键参数的配置能力，支持用户在服务部署过程中灵活自定义环境参数，简化服务配置流程。

核心功能与特性

核心功能

• 提供 SERVICE_NAME、PORT、PATH_PATTERN 三个环境变量的标准化定义与管理
• 支持环境变量的动态注入，无需修改镜像内部配置即可调整服务参数
• 可作为其他应用服务镜像的基础镜像，提供统一的环境配置层

特性

• 轻量级设计，镜像体积小，部署效率高
• 环境变量配置接口标准化，易于集成到各类服务部署流程
• 无默认值设计，强制用户显式配置关键参数，避免运行时参数缺失

使用场景与适用范围

适用场景

• 作为微服务架构中各服务实例的基础镜像，统一环境变量配置标准
• 快速搭建需要自定义服务名称、端口或路径模式的应用测试环境
• 简化Docker Compose或Kubernetes等编排工具中的服务参数配置流程

适用范围

• 需要通过环境变量控制服务标识、网络端口或访问路径的应用
• 遵循12-Factor应用原则的服务部署场景
• 多环境（开发、测试、生产）下需要差异化配置服务参数的场景

使用方法与配置说明

环境变量说明

Docker Run 部署示例

通过 docker run 命令启动容器时，使用 -e 参数注入环境变量：

bash
docker run -d \
  -e SERVICE_NAME="order-service" \
  -e PORT=8081 \
  -e PATH_PATTERN="/orders/*" \
  --name my-service \
  [镜像名称]:[标签]

Docker Compose 配置示例

在 docker-compose.yml 中通过 environment 字段配置环境变量：

yaml
version: '3'
services:
  app:
    image: [镜像名称]:[标签]
    environment:
      - SERVICE_NAME=payment-service
      - PORT=8082
      - PATH_PATTERN="/payments/*"
    ports:
      - "${PORT}:${PORT}"  # 映射配置的PORT到宿主机

注意事项

1. 所有环境变量均为必填项，未配置时容器可能无法正常启动
2. PORT 需与应用实际监听端口保持一致，避免端口映射失败
3. PATH_PATTERN 格式需符合应用路由规则要求，具体语法取决于上层应用框架
4. 生产环境中建议通过编排工具的环境变量管理功能（如Kubernetes ConfigMap）注入配置，提高安全性