mathematicalthinking/encompass

EnCOMPASS Web应用程序Docker镜像文档

镜像概述

EnCOMPASS Web应用程序Docker镜像将EnCOMPASS Web应用及其依赖项打包为标准化容器，旨在简化应用的部署、运行和维护流程。通过容器化技术，确保应用在不同环境中具备一致的运行行为，降低环境配置差异带来的问题。

核心功能与特性

• 容器化部署：整合应用运行所需的全部依赖，实现"一次构建，到处运行"，简化跨环境部署流程。
• 环境隔离：提供独立的运行空间，避免与主机系统或其他应用产生依赖冲突。
• 轻量级运行：优化镜像体积，减少资源占用，支持快速启动和高效运行。
• 灵活配置：支持通过环境变量、配置文件挂载等方式自定义应用参数，适应不同场景需求。
• 跨平台兼容：可在任何支持Docker的操作系统（Linux、Windows、macOS）上运行。

使用场景与适用范围

• 开发环境：供开发人员本地搭建一致的开发环境，加速开发测试流程。
• 测试环境：快速部署应用进行功能测试、性能测试或集成测试。
• 生产环境：作为生产环境的部署载体，确保应用稳定、可靠运行。
• 演示环境：用于快速搭建EnCOMPASS Web应用的演示实例，展示应用功能。

使用方法与配置说明

前提条件

• 已安装Docker Engine（推荐版本20.10及以上）
• 已获取EnCOMPASS Web应用镜像（如encompass-web:latest）

基本部署流程

1. 拉取镜像（如未本地存储）

bash
docker pull docker.xuanyuan.run/encompass-web:latest

2. 启动容器

使用docker run命令启动应用容器：

bash
docker run -d \
  --name encompass-web \
  -p 8080:80 \  # 端口映射：主机端口:容器内端口（默认容器端口为80）
  --restart unless-stopped \  # 容器退出时自动重启（除非手动停止）
  encompass-web:latest

3. 访问应用

容器启动后，通过浏览器或HTTP客户端访问：
http://<主机IP或域名>:8080

高级配置

环境变量配置

通过-e参数设置环境变量自定义应用行为，常用变量包括：

示例：配置自定义端口和日志级别

bash
docker run -d \
  --name encompass-web-config \
  -p 8081:8080 \
  -e PORT=8080 \
  -e LOG_LEVEL=debug \
  docker.xuanyuan.run/encompass-web:latest

配置文件挂载

如需使用自定义配置文件，可通过-v参数挂载主机文件到容器内指定路径（具体路径需参考应用文档）：

bash
docker run -d \
  --name encompass-web-custom \
  -p 8080:80 \
  -v /path/on/host/config.yaml:/app/config.yaml \  # 挂载主机配置文件到容器
  encompass-web:latest

使用Docker Compose部署

创建docker-compose.yml文件：

yaml
version: '3.8'
services:
  encompass-web:
    image: docker.xuanyuan.run/encompass-web:latest
    container_name: encompass-web
    ports:
      - "8080:80"
    environment:
      - LOG_LEVEL=info
      - CACHE_ENABLED=true
    restart: unless-stopped
    # 可选：挂载数据卷（如需要持久化存储）
    # volumes:
    #   - ./app-data:/app/data

启动服务：

bash
docker-compose up -d

停止服务：

bash
docker-compose down

注意事项

• 端口映射时需确保主机端口未被占用，可通过netstat -tuln检查端口占用情况。
• 生产环境建议配置数据卷（-v）持久化存储应用数据，避免容器删除导致数据丢失。
• 具体配置参数、端口号及文件路径可能因应用版本不同而变化，请以EnCOMPASS官方文档为准。