Ed-Fi Web Sandbox Admin Docker镜像文档

镜像概述和主要用途

Ed-Fi Web Sandbox Admin Docker镜像是用于Sandbox Admin工具的容器化部署方案。该镜像基于Alpine Linux构建，提供了Sandbox Admin工具的便捷部署方式，适用于开发、测试等非生产环境。

注意：此镜像不推荐用于生产环境。

核心功能和特性

• 容器化部署：简化Sandbox Admin工具的部署流程，减少环境配置差异
• PostgreSQL支持：兼容PostgreSQL数据库，需配置数据库连接参数
• 环境变量配置：通过环境变量灵活配置数据库连接、管理员账户、模板密钥等关键参数
• 多版本支持：提供多个版本标签，适配不同需求场景

使用场景和适用范围

• 开发环境：快速部署Sandbox Admin工具用于功能开发和调试
• 测试环境：验证Sandbox Admin工具的功能完整性和兼容性
• 演示环境：搭建临时演示环境展示Sandbox Admin工具功能

不适用于生产环境，生产环境部署需评估安全性和稳定性要求。

镜像变体

当前仅支持基于Alpine Linux的实现，镜像标签格式如下：
edfialliance/ods-api-web-sandbox-admin:<version>

其中<version>为具体版本号（如2.1.7、2.1.6等）。

环境变量配置

以下环境变量用于配置镜像运行参数，部分为必填项：

使用方法和部署示例

基本运行命令

使用docker run命令启动容器，需指定必要环境变量：

bash
docker run -d \
  --name edfi-sandbox-admin \
  -p 8080:8080 \
  -e LOGS_FOLDER=/app/logs \
  -e POSTGRES_USER=postgres \
  -e POSTGRES_PASSWORD=postgres123 \
  -e ADMIN_POSTGRES_HOST=admin-postgres \
  -e ODS_POSTGRES_HOST=ods-postgres \
  -e ADMIN_USER=admin \
  -e ADMIN_PASSWORD=admin123 \
  -e MINIMAL_KEY=minimal-key \
  -e MINIMAL_SECRET=minimal-secret \
  -e POPULATED_KEY=populated-key \
  -e POPULATED_SECRET=populated-secret \
  edfialliance/ods-api-web-sandbox-admin:2.1.7

Docker Compose配置示例

以下为配合PostgreSQL数据库的docker-compose.yml示例：

yaml
version: '3.8'

services:
  sandbox-admin:
    image: edfialliance/ods-api-web-sandbox-admin:2.1.7
    ports:
      - "8080:8080"
    environment:
      - LOGS_FOLDER=/app/logs
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres123
      - POSTGRES_PORT=5432
      - ADMIN_POSTGRES_HOST=admin-postgres
      - ODS_POSTGRES_HOST=ods-postgres
      - ADMIN_USER=admin
      - ADMIN_PASSWORD=admin123
      - MINIMAL_KEY=minimal-key
      - MINIMAL_SECRET=minimal-secret
      - POPULATED_KEY=populated-key
      - POPULATED_SECRET=populated-secret
    volumes:
      - ./logs:/app/logs
    depends_on:
      - admin-postgres
      - ods-postgres

  admin-postgres:
    image: postgres:14-alpine
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres123
    volumes:
      - admin-postgres-data:/var/lib/postgresql/data

  ods-postgres:
    image: postgres:14-alpine
    environment:
      - POSTGRES_USER=postgres
      - POSTGRES_PASSWORD=postgres123
    volumes:
      - ods-postgres-data:/var/lib/postgresql/data

volumes:
  admin-postgres-data:
  ods-postgres-data:

版本信息

该镜像提供多个版本标签，对应不同发布版本，具体Dockerfile可参考：

• 2.1.7
• 2.1.6
• 2.1.5
• 2.1.4
• 2.1.3
• 2.1.2
• 2.1.1
• 2.1.0
• 2.0.0
• 1.1.0
• 1.0.0

许可信息

镜像包含软件的许可信息请查看许可说明。

与所有Docker镜像一样，该镜像可能包含其他软件（如基础发行版中的Bash等），这些软件可能受其他许可协议约束。使用前请确保遵守所有包含软件的许可要求。