edfialliance/ods-api-web-api-mssql

Ed-Fi Web ODS/API

镜像概述和主要用途

该镜像提供Ed-Fi ODS/API的Docker部署方案，适用于生产环境使用。基于Alpine系统实现，支持与SQL Server数据库集成，可通过环境变量灵活配置系统参数。

核心功能和特性

• 生产环境适用：经过优化，适合生产环境部署
• Alpine基础：基于Alpine系统构建，镜像体积小，资源占用低
• 灵活配置：通过环境变量配置API模式、数据库连接、日志路径等关键参数
• SQL Server集成：支持连接SQL Server数据库，包括ODS数据库和Admin/Security/Master数据库
• TPDM扩展支持：可选启用TPDM扩展（默认启用）

使用场景和适用范围

适用于需要部署Ed-Fi ODS/API的教育数据系统，特别是需要在生产环境中快速部署、配置和维护Ed-Fi ODS/API服务的场景。

使用方法和配置说明

镜像变体

目前仅支持基于Alpine的实现，镜像格式如下：

edfialliance/ods-api-web-api-mssql:<version>

其中<version>需替换为具体版本号。

支持的环境变量

以下环境变量可用于配置镜像：

API_MODE=<用于替换app.settings.json中ApiSettings.Mode的值，例如YearSpecific>
LOGS_FOLDER=<日志文件存储路径>
SQLSERVER_ODS_DATASOURCE=<SQL Server实例的DNS或IP地址（含端口），例如sql.somedns.org或10.1.5.9,1433>
SQLSERVER_ADMIN_DATASOURCE=<包含Admin/Security/Master数据库的SQL Server实例的DNS或IP地址（含端口），例如sql.somedns.org或10.1.5.9,1433>
SQLSERVER_USER=<具有Ed-Fi数据库访问权限的SQL用户名，例如edfiadmin>
SQLSERVER_PASSWORD=<SQLSERVER_USER对应的SQL密码，例如password123!>
SQLSERVER_ENCRYPT=<是否加密SQL Server连接（true/false）；若为true，容器需配置正确证书>
TPDM_ENABLED=<是否加载TPDM扩展（true/false）>（可选，默认值：true）

Docker部署示例

使用docker run命令部署

bash
docker run -d \
  --name edfi-ods-api \
  -e API_MODE="YearSpecific" \
  -e LOGS_FOLDER="/var/log/edfi" \
  -e SQLSERVER_ODS_DATASOURCE="sql-server,1433" \
  -e SQLSERVER_ADMIN_DATASOURCE="sql-server,1433" \
  -e SQLSERVER_USER="edfiadmin" \
  -e SQLSERVER_PASSWORD="securepassword" \
  -e SQLSERVER_ENCRYPT="false" \
  -e TPDM_ENABLED="true" \
  -p 80:80 \
  docker.xuanyuan.run/edfialliance/ods-api-web-api-mssql:<version>

许可信息

查看包含在该镜像中软件的https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS-Docker/blob/main/LICENSE。

与所有Docker镜像一样，此镜像可能还包含其他软件，这些软件可能受其他许可协议约束（例如基础发行版中的Bash等，以及主要软件的任何直接或间接依赖项）。

对于任何预构建镜像的使用，镜像用户有责任确保对该镜像的任何使用都符合其中包含的所有软件的相关许可协议。