humancolossus/oca-repository

OCA Repository 镜像文档

概述

OCA Repository是一个用于管理和处理OCA (Open Context Architecture) Bundle的Docker镜像，提供API接口支持OCA Bundle的添加、获取等操作。该镜像已迁移至GitHub Container Registry (GHCR)，适用于开发和生产环境中OCA Bundle的集中管理。

核心功能

• 支持OCA Bundle的添加与获取操作
• 提供基于OpenAPI规范的API接口（详见openapi.yml）
• 支持通过配置文件进行自定义设置
• 可在开发和生产环境中部署使用

使用场景

• 开发环境中OCA Bundle的本地管理与测试
• 生产环境中OCA Bundle的集中存储与访问
• 需要通过API接口管理OCA Bundle的应用场景

使用方法

1. 拉取镜像

由于镜像已迁移至GHCR，拉取命令如下：

bash
docker pull ghcr.io/thclab/oca-repository:latest

生产环境部署时，建议将latest替换为基于SemVer的具体版本标签，以确保版本稳定性。

2. 运行实例

bash
docker run \
    -it \
    --rm \
    -p 8000:8000 \
    -v $PWD/config/config.yml:/app/config/config.yml:ro \
    ghcr.io/thclab/oca-repository:latest

参数说明：

• -it: 以交互式终端模式运行
• --rm: 容器退出后自动删除容器文件
• -p 8000:8000: 端口映射，将容器的8000端口映射到主机的8000端口
• -v $PWD/config/config.yml:/app/config/config.yml:ro: 挂载本地配置文件（只读模式）

3. API接口说明

所有可用接口详见OCA Repository标签下的https://github.com/THCLab/oca-repository-rs/blob/main/openapi.yml%E8%A7%84%E8%8C%83%E6%96%87%E4%BB%B6%E3%80%82

开发环境设置

1. 克隆代码仓库

bash
git clone git@github.com:THCLab/oca-repository-rs.git

2. 启动开发环境

bash
docker-compose up

3. API使用示例

添加OCA Bundle

bash
curl -XPOST http://127.0.0.1:8000/oca-bundle \
  -H "Content-type: text/plain" \
  --data-binary @ocafile.txt

获取OCA Bundle

bash
curl [***]