OpenPipe

环境要求

• PostgreSQL 数据库（本地安装即可）
• NodeJS 20（更低版本未测试）
• pnpm 包管理器
• 一个 OpenAI API Key
• 一个 GitHub OAuth App（用于登录认证）

安装与启动步骤

1. 1安装基础环境

   先装好 PostgreSQL 与 NodeJS 20，再全局安装 pnpm。Node 版本过低可能运行失败。

   npm i -g pnpm

   复制

2. 2克隆仓库

   把 OpenPipe 源码拉到本地，随后进入项目目录操作。

   git clone https://github.com/openpipe/openpipe

   复制

3. 3安装项目依赖

   进入仓库根目录后用 pnpm 安装全部依赖，耗时较长请耐心等待。

   cd openpipe && pnpm install

   复制

4. 4生成环境变量文件

   从示例文件复制出 .env，之后需要在其中填入 OpenAI Key 等配置。

   cd app && cp .env.example .env

   复制

5. 5创建数据库角色

   新装 Postgres 想用默认 DATABASE_URL 时执行，创建 postgres 角色并授予超级用户权限。

   psql postgres
   CREATE ROLE postgres WITH LOGIN PASSWORD 'postgres';
   ALTER ROLE postgres SUPERUSER;

   复制

6. 6初始化数据库

   确认 .env 中 DATABASE_URL 指向你的 Postgres，然后在 app 目录执行迁移建表。

   pnpm prisma migrate dev

   复制

7. 7配置 GitHub 登录

   在 GitHub 创建 OAuth App，回调地址填本地实例的 /api/auth/callback/github。

8. 8启动应用

   在 app 目录运行开发服务器，等待编译完成后即可在浏览器访问。

   pnpm dev

   复制

关键配置

如何确认成功

浏览器打开 http://localhost:3000，能正常显示页面并可用 GitHub 账号登录即成功。

常见问题

注意事项

• 官方已暂停开源版本开发，仓库后续是否更新不确定，生产使用需谨慎评估。
• GitHub OAuth App 的回调地址必须与本地实例地址（如 http://localhost:3000）匹配，否则登录会失败。
• 若自定义了数据库账号密码或端口，务必同步修改 DATABASE_URL，不能直接沿用默认值。
• 本地默认通过 http://localhost:3000 访问，如端口被占用需自行调整启动方式。