sproutlabs/annotator-store

Annotator Store 镜像说明

镜像概述

本镜像为Annotator（注释工具）的后端存储服务，基于Flask框架和Elasticsearch构建，提供注释数据的存储管理与HTTP API接口，支持权限过滤和配置自定义。

核心功能

1. Elasticsearch抽象层：封装Elasticsearch操作，简化注释存储管理，支持根据权限设置过滤搜索结果。
2. Flask Web服务：通过Flask蓝图暴露HTTP API接口（需以[flask]选项构建包），兼容Annotator工具的存储需求。

使用场景

适用于需要集成注释功能的Web应用、文档平台或内容管理系统，作为Annotator工具的后端存储服务，实现用户注释数据的存储与查询。

配置说明

环境变量

需设置以下必填环境变量：

• SECRET_KEY：用于身份验证的密钥
• ES_HOST：Elasticsearch服务器地址（如es:9200）
• AUTH：是否启用身份验证（可选值：True/False）

可选环境变量：

• HOST：服务绑定地址（默认127.0.0.1）
• PORT：服务端口（默认5000）

部署示例

Docker Compose部署

直接执行以下命令启动服务（需确保docker-compose.yml包含Annotator Store和Elasticsearch配置）：

bash
docker-compose up

单独运行容器

bash
docker run -d \
  -e SECRET_KEY=your_secure_secret \
  -e ES_HOST=elasticsearch:9200 \
  -e AUTH=False \
  -p 5000:5000 \
  sproutlabs/annotator-store

Store API

API默认挂载于/api路径，兼容Annotator工具的存储接口规范，详情可参考Annotator官方文档。

测试说明

1. 安装测试依赖：pip install -e .[testing]
2. 确保Elasticsearch运行，执行测试：

bash
nosetests

或使用Tox运行多版本Python测试：

bash
tox

若测试失败，请提交issue并附上pip freeze输出。 ===FULL_DESC===