teic/teigarage

TEIGarage 镜像文档

镜像概述和主要用途

TEIGarage 是一个 Web 服务和 RESTful 服务，用于转换、转换和验证多种格式，重点关注 TEI（文本编码倡议）格式。该服务基于成熟的 https://github.com/TEIC/oxgarage 项目构建。

可以通过 teigarage.tei-c.org 访问 TEIGarage 的公开运行实例。关于 MEIGarage 和 TEIGarage 的代码结构信息可参考 https://github.com/Edirom/MEIGarage/blob/main/doc/code-structure.md%EF%BC%8C%E6%BC%94%E7%A4%BA%E5%B9%BB%E7%81%AF%E7%89%87%E5%92%8C%E6%B5%B7%E6%8A%A5%E7%AD%89%E8%B5%84%E6%96%99%E5%8F%AF%E5%8F%82%E8%80%83 https://anneferger.github.io/MEITEIGarage/%E3%80%82

核心功能和特性

• RESTful API：提供标准化的接口用于文件格式转换、转换和验证操作
• 多格式支持：专注于 TEI 格式，同时支持多种其他格式的处理
• Web 界面：提供图形化用户界面，方便直接操作
• 开源基础：基于经过验证的 OxGarage 项目构建，代码开源可审计
• 可配置性：支持自定义样式表和 TEI 源文件，适应特定需求

使用场景和适用范围

• TEI 文档处理：研究人员、编辑和出版机构用于 TEI 格式文档的转换、验证和管理
• 学术出版工作流：集成到学术出版系统中，实现文档格式自动化转换
• 数字人文项目：在数字人文研究中处理和转换文本编码格式
• API 集成：开发人员通过 RESTful API 将 TEI 处理功能集成到自定义应用中

使用方法和配置说明

获取镜像

可从 GitHub Container Registry 或 DockerHub 获取预构建镜像：

bash
# 从 GitHub Container Registry 获取
docker pull ghcr.io/teic/teigarage:latest

# 或从 DockerHub 获取
docker pull teic/teigarage:latest

# 获取开发版本
docker pull teic/teigarage:dev

运行容器

基本运行命令：

bash
docker run --rm \
    -p 8080:8080 \
    -e WEBSERVICE_URL=http://localhost:8080/ege-webservice/ \
    --name teigarage ghcr.io/teic/teigarage

服务启动后：

• 图形用户界面：访问 http://localhost:8080
• Web 服务端点：访问 http://localhost:8080/ege-webservice

配置参数

环境变量

• WEBSERVICE_URL：RESTful Web 服务的完整 URL，当容器运行在不同端口或 URL 时，用于 Web 客户端（GUI）正确连接服务，默认值为容器内部地址

卷挂载

可通过 -v 参数挂载本地目录来自定义样式表和 TEI 源文件：

bash
docker run --rm \
    -p 8080:8080 \
    -e WEBSERVICE_URL=http://localhost:8080/ege-webservice/ \
    -v /本地路径/Stylesheets:/usr/share/xml/tei/stylesheet \
    -v /本地路径/TEI/P5:/usr/share/xml/tei/odd \
    --name teigarage ghcr.io/teic/teigarage

端口映射

容器暴露两个端口：

• 8080：HTTP 连接，适用于常规 HTTP 访问
• 8081：HTTPS 连接，适用于部署在 SSL 终止负载均衡器 后的 HTTPS 场景

API 使用示例

Open API 文档可在 https://github.com/TEIC/TEIGarage/blob/main/src/main/webapp/openapi.json 或运行实例的 https://teigarage.tei-c.org/ege-webservice/ 查看。

以下是使用 curl 调用 API 将 .docx 文件转换为 TEI 文件的示例：

bash
curl -o output.xml -F upload=@input.docx https://teigarage.tei-c.org/ege-webservice/Conversions/docx%3Aapplication%3Avnd.openxmlformats-officedocument.wordprocessingml.document/TEI%3Atext%3Axml/

TEI 源文件和样式表

Docker 镜像构建时已包含最新版本的 TEI 源文件和样式表。如需使用其他版本，可通过卷挂载本地文件：

可从 GitHub 下载相应版本，按上述路径挂载即可覆盖默认文件。