open-connector

环境要求

• 已安装 Docker 与 Docker Compose（用于自托管运行时）
• 若使用 PostgreSQL 存储，需要 PostgreSQL 15 或更高版本
• 连接 OAuth 提供商前，需先在该提供商处注册应用并获取 OAuth 客户端凭据
• 可选：使用 Node.js 运行时代替 Docker 进行本地自托管

安装与启动步骤

1. 1启动自托管运行时

   在项目目录下执行 docker compose up，会自动拉取官方镜像 ghcr.io/oomol-lab/open-connector:latest 并启动服务。

   docker compose up

   复制

2. 2从源码构建启动

   如果不想用发布镜像，可叠加 build 配置文件从源码构建镜像再启动，首次构建耗时较长。

   docker compose -f docker-compose.yml -f docker-compose.build.yml up --build

   复制

3. 3打开控制台与API文档

   服务启动后在浏览器访问本地控制台查看运行时状态与提供商，访问 /docs 查看自动生成的 API 参考。

4. 4运行Action验证

   调用一个无需认证的 Action（hackernews.get_top_stories），能返回 JSON 结果说明运行时已就绪。

   curl -s -X POST http://localhost:3000/v1/actions/hackernews.get_top_stories -H 'content-type: application/json' -d '{"input":{}}'

   复制

5. 5切换PostgreSQL存储

   默认用 SQLite，配置 OOMOL_CONNECT_DATABASE_URL 后可改用 PostgreSQL；升级版本前必须先显式执行迁移，服务启动不会自动建表。

   npm run runtime:migrate

   复制

关键配置

如何确认成功

浏览器打开 http://localhost:3000 能看到控制台页面，且执行 curl 调用 hackernews.get_top_stories 返回 JSON 数据。

常见问题

注意事项

• 本地控制台默认地址为 http://localhost:3000，API 参考在 http://localhost:3000/docs。
• 自托管模式下存储与 OAuth 应用都由你自己管理。
• PostgreSQL 迁移是显式操作，多实例部署前需按文档确认权限与 TLS 要求。
• Kubernetes 部署请参考仓库中的 Helm chart（deploy/helm/open-connector）。