healthopenshift/webclient

Web Client Application Docker 镜像文档

一、镜像概述和主要用途

概述

Web Client Application 镜像是一个预配置的容器化解决方案，用于快速部署前端Web应用（如单页应用SPA、静态网站等）。该镜像基于轻量级基础镜像构建，集成高效Web服务器，优化静态资源服务能力，支持多环境配置和灵活部署。

主要用途

• 静态资源（HTML/CSS/JS/图片等）的高效托管
• 单页应用（SPA）的容器化部署
• 前端应用在开发、测试、生产环境的一致运行环境提供
• 快速集成到CI/CD流程，实现前端构建产物的标准化交付

二、核心功能和特性

核心功能

1. 轻量级基础：基于 Alpine Linux 构建，镜像体积小（通常<50MB），启动速度快
2. 内置Web服务器：预配置 Nginx 作为静态资源服务器，支持HTTP/HTTPS、Gzip压缩、缓存控制
3. 环境适配：支持通过环境变量注入动态配置（如后端API地址、运行环境标识等）
4. 灵活扩展：可自定义Web服务器配置（如路由规则、跨域策略、SSL证书等）
5. 多阶段构建优化：支持从源码构建到产物部署的全流程容器化，镜像精简无冗余依赖

特性亮点

• 静态资源优化：内置Nginx配置优化静态资源加载性能（如长连接、资源预加载）
• 安全加固：默认禁用不必要的HTTP方法，限制目录遍历，支持HTTPS配置
• 多平台支持：适配AMD64/ARM64架构，兼容主流容器运行时（Docker、containerd）
• 日志可观测性：支持日志输出到标准输出（stdout），便于容器平台日志收集

三、使用场景和适用范围

适用场景

1. 静态网站部署：个人博客、企业官网等纯静态内容的托管
2. 单页应用（SPA）托管：React/Vue/Angular等框架构建的前端应用部署
3. 开发环境隔离：前端开发过程中，通过容器隔离依赖和运行环境
4. CI/CD集成：在持续集成流程中，将前端构建产物直接打包为镜像，用于测试或生产部署
5. 多环境一致部署：通过环境变量配置，实现开发、测试、生产环境的无缝切换

适用范围

• 技术栈：支持所有静态前端技术（HTML/CSS/JS、React、Vue、Next.js静态导出、Vite构建产物等）
• 规模：小型静态网站到中大型SPA均适用
• 环境：本地开发、云服务器、Kubernetes集群、Serverless容器平台（如AWS ECS Fargate）

四、使用方法和配置说明

4.1 镜像获取

方式1：从镜像仓库拉取（推荐）

bash
docker pull [镜像仓库地址]/web-client-app:latest  # 替换为实际镜像仓库地址

方式2：本地构建

若需基于源码构建，可使用以下Dockerfile（见4.6节“多阶段构建示例”）。

4.2 基本运行命令

最简启动（默认配置）

bash
docker run -d -p 8080:80 --name web-client-app [镜像仓库地址]/web-client-app:latest

• 说明：容器内Web服务器默认监听80端口，映射到宿主机8080端口；访问 http://localhost:8080 即可打开应用。

指定自定义端口

bash
docker run -d -p 3000:8080 \  # 宿主机3000端口映射到容器8080端口
  -e PORT=8080 \  # 设置容器内Web服务器监听端口
  --name web-client-app [镜像仓库地址]/web-client-app:latest

4.3 自定义Web服务器配置

若需修改Nginx配置（如跨域规则、路由重写、SSL配置等），可通过挂载配置文件覆盖默认配置：

bash
docker run -d -p 8080:80 \
  -v /本地路径/nginx.conf:/etc/nginx/conf.d/default.conf \  # 挂载自定义Nginx配置
  --name web-client-app [镜像仓库地址]/web-client-app:latest

示例Nginx配置（nginx.conf）：

nginx
server {
    listen 80;
    server_name localhost;

    # 静态资源目录（镜像内固定路径）
    root /usr/share/nginx/html;
    index index.html;

    # SPA路由支持（前端路由模式下避免404）
    location / {
        try_files $uri $uri/ /index.html;
    }

    # 跨域配置示例
    location /api/ {
        proxy_pass http://backend-api:8080/;
        add_header 'Access-Control-Allow-Origin' '*';
    }

    # 静态资源缓存策略
    location ~* \.(js|css|png|jpg|jpeg|gif|ico)$ {
        expires 1y;
        add_header Cache-Control "public, max-age=31536000";
    }
}

4.4 环境变量配置

通过环境变量注入动态参数（如后端API地址、运行环境等），镜像启动时会自动替换前端资源中的占位符（需前端构建时预留变量名，如__API_BASE_URL__）。

常用环境变量

使用示例

bash
docker run -d -p 8080:80 \
  -e API_BASE_URL=https://api.prod.example.com \  # 生产环境后端API地址
  -e LOG_LEVEL=warn \  # 仅输出警告及以上日志
  --name web-client-app [镜像仓库地址]/web-client-app:latest

4.5 Docker Compose 部署示例

创建 docker-compose.yml 文件，定义多服务协同部署（如前端+后端API）：

yaml
version: '3.8'

services:
  web-client:
    image: [镜像仓库地址]/web-client-app:latest
    ports:
      - "80:80"  # 宿主机80端口映射到容器80端口
    environment:
      - API_BASE_URL=http://backend-api:3000  # 后端服务地址（容器网络内域名）
      - LOG_LEVEL=info
    depends_on:
      - backend-api  # 依赖后端服务启动
    restart: unless-stopped  # 异常退出后自动重启

  backend-api:
    image: [后端API镜像地址]:latest
    ports:
      - "3000:3000"
    restart: unless-stopped

启动命令：

bash
docker-compose up -d

4.6 多阶段构建示例（从源码构建镜像）

若需基于前端源码构建镜像，可使用多阶段构建优化镜像体积（以React应用为例）：

项目结构：

my-spa/
├── Dockerfile
├── package.json
├── src/
└── public/

Dockerfile：

dockerfile
# 阶段1：构建前端产物（基于Node.js）
FROM node:18-alpine AS builder
WORKDIR /app
COPY package*.json ./
RUN npm install  # 安装依赖
COPY . .
RUN npm run build  # 构建静态产物（输出到./build目录）

# 阶段2：生成运行时镜像（基于Nginx Alpine）
FROM nginx:alpine
# 复制构建产物到Nginx静态目录
COPY --from=builder /app/build /usr/share/nginx/html
# 复制自定义Nginx配置（可选）
COPY nginx.conf /etc/nginx/conf.d/default.conf
# 暴露端口
EXPOSE 80
# 启动Nginx
CMD ["nginx", "-g", "daemon off;"]

构建命令：

bash
docker build -t my-web-client:v1.0 .

五、配置参数和环境变量详解

核心配置参数

环境变量注入原理

镜像启动时，通过 envsubst 工具替换前端资源中的环境变量占位符（需前端构建时预留）。例如：

• 前端代码中使用 window.API_BASE_URL = '${API_BASE_URL}'
• 镜像启动时，环境变量 API_BASE_URL 的值会自动替换 ${API_BASE_URL} 占位符

六、注意事项

1. 静态资源路径：确保前端构建产物的静态资源路径正确（如相对路径），避免因路径错误导致404
2. 容器网络：若需访问宿主机服务，可使用 host.docker.internal 作为宿主机域名（仅Docker Desktop支持）
3. HTTPS配置：生产环境建议通过挂载SSL证书（如 /etc/nginx/ssl）并修改Nginx配置启用HTTPS
4. 镜像更新：定期更新基础镜像（如Nginx Alpine）以修复安全漏洞，可通过CI/CD自动触发构建

七、总结

Web Client Application 镜像提供了开箱即用的前端应用容器化方案，通过轻量级设计、灵活配置和标准化部署流程，简化了前端应用的交付和运维成本。适用于从开发测试到生产环境的全流程使用，支持静态网站、SPA等多种前端应用类型。