associatedpress/harvester

AP Harvester Docker 镜像文档

镜像概述

AP Harvester 是一个开源协作式数据收集平台，专为新闻编辑部设计，用于快速收集结构化数据。该工具通过降低新项目启动门槛，帮助团队更快地获取新闻所需数据。Harvester 采用 schema 驱动模式，用户定义数据集结构后，系统会自动生成友好的表单界面，供记者团队协作输入数据。当前版本使用 Google Sheets 作为数据存储机制，可与新闻编辑部常用工具无缝集成，新建数据收集项目如同创建新电子表格般简单。

核心功能与特性

• schema 驱动设计：定义数据结构后自动生成表单界面，无需手动开发
• 协作数据收集：支持团队成员共同输入和管理数据
• Google Sheets 集成：使用新闻编辑部广泛使用的电子表格工具作为数据存储
• 灵活可配置：可根据数据收集需求变化进行调整
• 透明化流程：数据收集过程清晰可见，便于团队协作和审计

使用场景与适用范围

• 新闻编辑部结构化数据收集项目
• 团队协作式数据调研与整理
• 需要快速启动的数据收集任务
• 依赖 Google Sheets 进行数据管理的工作流

前置准备：Google 凭据配置

由于 Harvester 依赖 Google Sheets 进行数据存储，部署前需完成以下准备工作：

1. 创建 Google 服务账户
2. 设置 Google OAuth 客户端

详细配置指南请参考 Google 凭据设置文档。

使用方法

拉取 Docker 镜像

shell
docker pull associatedpress/harvester

运行 Docker 容器

使用以下命令运行容器，需配置必要的环境变量和参数：

shell
docker run -it \
  --publish 8000:80 \
  --env JWT_SECRET="$( date | sha256sum | base64 )" \
  --env GOOGLE_OAUTH_CLIENT_ID=<您的Google OAuth ID> \
  --env GOOGLE_OAUTH_CLIENT_SECRET=<您的Google OAuth密钥> \
  --env GOOGLE_SERVICE_ACCOUNT_CREDENTIALS="$( cat .auth.json )" \
  --env HARVESTER_CONFIG_RESOURCE_ID=<您的配置表格ID> \
  associatedpress/harvester

参数说明

• -it：使容器交互并连接终端输出（服务器部署可省略）
• --publish 8000:80：将主机的 8000 端口映射到容器的 80 端口，通过 http://localhost:8000 访问服务
• 环境变量：
  • JWT_SECRET：用于签署 JSON Web Token 的随机字符串，可使用命令生成或自定义
  • GOOGLE_OAUTH_CLIENT_ID 和 GOOGLE_OAUTH_CLIENT_SECRET：Google OAuth 凭据，若省略则禁用身份验证
  • GOOGLE_SERVICE_ACCOUNT_CREDENTIALS：Google 服务账户凭据，可通过环境变量或文件挂载方式提供
  • HARVESTER_CONFIG_RESOURCE_ID：Harvester 配置表格 ID（可选）

Google 服务账户凭据配置方式

方式一：通过环境变量

shell
--env GOOGLE_SERVICE_ACCOUNT_CREDENTIALS="$( cat .auth.json )"

（需确保当前目录存在包含服务账户 JSON 凭据的 .auth.json 文件）

方式二：通过文件挂载

shell
--volume=/绝对路径/到/.auth.json:/app/.auth.json

（替换为本地 .auth.json 文件的绝对路径）

访问与使用

容器启动后，通过浏览器访问 http://localhost:8000 即可使用 AP Harvester。参考 创建第一个项目 开始数据收集工作。

帮助与支持

获取帮助：email ***

相关链接

• 官方文档
• https://github.com/associatedpress/harvester
• 新建配置表格
• 配置表格说明