edfialliance/ods-api-db-ods-sandbox

Ed-Fi ODS Sandbox部署数据库镜像

镜像概述与主要用途

本镜像提供基于PostgreSQL的Ed-Fi数据标准（Ed-Fi Data Standard）的EdFi_Ods_Sandbox数据库的Docker部署方案。数据库会在镜像首次启动时自动完成安装配置，适用于快速部署符合Ed-Fi规范的沙箱数据库环境。

核心功能与特性

• 基于PostgreSQL：采用PostgreSQL作为数据库引擎，兼容Ed-Fi数据标准的存储需求
• 自动安装配置：首次启动容器时自动完成EdFi_Ods_Sandbox数据库的初始化与部署
• TPDM表支持：可配置是否包含TPDM（Teacher Preparation Data Model）相关表结构
• 环境变量定制：支持通过环境变量灵活配置数据库用户、密码及实例名称

使用场景与适用范围

适用场景

• 教育数据系统中Ed-Fi ODS Sandbox数据库的容器化部署
• 需要快速搭建符合Ed-Fi数据标准的测试或生产环境

适用范围

• 生产环境中的共享实例模式（shared instance mode）

使用方法与配置说明

环境变量配置

Docker部署示例

1. 使用docker run命令部署

bash
docker run -d \
  --name edfi-ods-sandbox \
  -e POSTGRES_USER=edfi_admin \
  -e POSTGRES_PASSWORD=SecurePassword123 \
  -e ODS_DB=edfi_ods_sandbox_prod \
  -e TPDM_ENABLED=true \
  -p 5432:5432 \
  edfi/ods-sandbox-db:latest

2. 使用docker-compose配置部署

创建docker-compose.yml文件：

yaml
version: '3.8'
services:
  edfi-ods-sandbox-db:
    image: edfi/ods-sandbox-db:latest
    container_name: edfi-ods-sandbox
    environment:
      - POSTGRES_USER=edfi_admin
      - POSTGRES_PASSWORD=SecurePassword123
      - ODS_DB=edfi_ods_sandbox_prod
      - TPDM_ENABLED=true
    ports:
      - "5432:5432"  # 映射容器PostgreSQL端口到主机
    restart: unless-stopped  # 容器退出时自动重启（除非手动停止）

启动服务：

bash
docker-compose up -d

相关文档

• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS/blob/main/CODE_OF_CONDUCT.md
• https://github.com/Ed-Fi-Alliance-OSS/Project-Tanager/blob/main/CONTRIBUTING.md
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS/blob/main/CONTRIBUTORS.md
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS/blob/main/NOTICES.md
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS/blob/main/SECURITY.md
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS/blob/main/LICENSE

***信息

版权与许可

Copyright (c) 2024 Ed-Fi Alliance, LLC及贡献者。
本镜像基于Apache License, Version 2.0（“许可证”）授权。
除非适用***要求或书面同意，否则根据许可证分发的软件按“原样”提供，不附带任何明示或暗示的担保或条件。有关详细权限和限制，请参见许可证。

Docker基础镜像说明

与所有Docker镜像一样，本镜像可能包含其他软件（如基础发行版中的Bash等，以及主软件的直接或间接依赖项），这些软件可能受其他许可证约束。
对于任何预构建镜像的使用，镜像用户有责任确保其使用行为符合镜像中所有软件的相关许可证要求。