edfialliance/ods-api-web-gateway-sandbox

Ed-Fi Web Gateway Sandbox 镜像文档

1. 镜像概述和主要用途

Ed-Fi Web Gateway Sandbox 是一个 Docker 镜像，提供基于 Nginx 的网关部署方案，作为 Ed-Fi ODS/API 的反向代理，并集成 SwaggerUI 和 Sandbox Admin 工具。该镜像旨在简化 Ed-Fi 沙箱环境的网关配置与部署流程。

2. 核心功能和特性

• Nginx 反向代理：为 Ed-Fi ODS/API 提供请求路由和代理服务
• SwaggerUI 集成：内置 API 文档与交互界面，支持 API 测试
• Sandbox Admin 工具：包含沙箱环境管理功能，便于环境配置与维护
• 轻量级实现：基于 Alpine Linux 和 Nginx 构建，镜像体积小，资源占用低

3. 使用场景和适用范围

适用于 Ed-Fi ODS/API 沙箱环境的部署与管理，主要应用场景包括：

• 开发环境：供开发人员进行 API 集成测试
• 测试环境：验证 Ed-Fi ODS/API 功能兼容性
• 演示环境：展示 Ed-Fi 生态系统的 API 能力

4. 镜像版本

5. 镜像变体

当前仅支持基于 Alpine Linux 的 Nginx 实现，镜像标签格式为：
edfialliance/ods-api-web-gateway-sandbox:<version>
其中 <version> 需替换为具体版本号（如 2.1.7）。

6. 使用方法和配置说明

6.1 镜像拉取

bash
docker pull edfialliance/ods-api-web-gateway-sandbox:<version>

6.2 基本运行示例（docker run）

bash
docker run -d \
  --name edfi-web-gateway \
  -p 80:80 \
  -e ODS_VIRTUAL_NAME=ods \
  -e SANDBOX_ADMIN_VIRTUAL_NAME=sandbox-admin \
  edfialliance/ods-api-web-gateway-sandbox:2.1.7

6.3 Docker Compose 配置示例

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  web-gateway:
    image: edfialliance/ods-api-web-gateway-sandbox:2.1.7
    container_name: edfi-web-gateway
    ports:
      - "80:80"
    environment:
      - ODS_VIRTUAL_NAME=ods
      - SANDBOX_ADMIN_VIRTUAL_NAME=sandbox-admin
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

6.4 环境变量配置

7. 许可证信息

镜像包含软件的许可证信息详见 https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS-Docker/blob/main/LICENSE%E3%80%82
与所有 Docker 镜像一样，本镜像可能包含其他软件（如基础发行版中的 Bash 等），这些软件可能具有独立许可证。镜像用户需自行确保其使用符合所有包含软件的相关许可证要求。