classtranscribe/taskengine

WebAPI Docker镜像文档

镜像概述和主要用途

本镜像包含ClassTranscribe Server的主要API端点源代码，是ClassTranscribe系统的核心服务组件。版权归美国伊利诺伊大学所有（2019-2020），源代码采用GNU通用公共许可证3.0（https://www.gnu.org/licenses/gpl-3.0.en.html%EF%BC%89%E6%8E%88%E6%9D%83%E3%80%82%E5%A6%82%E9%9C%80%E5%85%B6%E4%BB%96%E6%8E%88%E6%9D%83%E6%96%B9%E5%BC%8F%EF%BC%8C%E8%AF%B7%E8%81%94%E7%B3%BB***%E3%80%82

核心功能和特性

镜像包含三个Docker服务组件：

• ClassTranscribeServer：服务名称为classtranscribeserver，端口8080，提供主要API服务
• PostgreSQL数据库：服务名称为db，端口5432，提供数据存储功能
• pgadmin：服务名称为pgadmin，端口5050，提供数据库图形化管理界面

使用场景和适用范围

适用于ClassTranscribe Server的部署与运行环境，供开发人员搭建和维护ClassTranscribe系统，支持API服务、数据存储及数据库管理功能。

详细使用方法和配置说明

构建前准备

1. 安装Docker环境
2. 从管理员处获取所有必要的环境变量文件

服务启动命令

启动所有服务

bash
docker-compose up

启动单个服务

bash
docker-compose up [service_name]

示例：后台启动ClassTranscribeServer

bash
docker-compose up -d classtranscribeserver

说明：-d选项使服务在后台（detached模式）运行

注意事项

1. 当ClassTranscribeServer的依赖发生变更时，需使用以下命令重建服务：

   bash
   docker-compose up --build classtranscribeserver
   

2. 代码修改后，重新运行以下命令即可重建代码：

   bash
   docker-compose up classtranscribeserver
   

3. 有关已知编码问题，请参考gotchas.md

版权说明

向本仓库提交代码（如通过git pull-request或与ClassTranscribe开发人员合作合并代码）即表示同意将代码版权转让给伊利诺伊大学。