petercatai/petercat
server image of petercat.ai
Image
Web servers
0
123
petercatai/petercat repository overview
Peter Cat
简体中文 | English
专为社区维护者和开发者打造的智能答疑机器人解决方案。
🏠 主页
✨ 特性
我们提供对话式答疑 Agent 配置系统、自托管部署方案和便捷的一体化应用 SDK，让您能够为自己的 GitHub 仓库一键创建智能答疑机器人，并快速集成到各类官网或项目中， 为社区提供更高效的技术支持生态。
特性1
仅需要告知你的仓库地址或名称，Peter Cat 即可自动完成创建机器人的全部流程
特性2
机器人创建后，所有相关Github 文档和 issue 将自动入库，作为机器人的知识依据
特性3
多种集成方式自由选择，如对话应用 SDK 集成至官网，Github APP一键安装至 Github 仓库等
📦 私有化部署
⚙️ 环境变量
本项目需要进行环境变量进行设置：
Client
.env.local
| 环境变量 | 类型 | 描述 | 示例 |
|---|---|---|---|
NEXT_PUBLIC_API_DOMAIN | 必选 | 后端服务的 API 域名。 | https://api.petercat.ai |
Server
.env
| 环境变量 | 类型 | 描述 | 示例 |
|---|---|---|---|
| 应用基础环境变量 | |||
API_URL | 必选 | 后端服务的 API 域名 | https://api.petercat.ai |
WEB_URL | 必选 | 前端 Web 服务的域名 | https://petercat.ai |
STATIC_URL | 必选 | 静态资源域名 | https://static.petercat.ai |
| AWS 相关环境变量 | |||
AWS_REGION_NAME | 必选 | AWS 部署的 Region | ap-northeast-1 |
AWS_SECRET_NAME | 必选 | AWS 托管的私钥文件名 | prod/githubapp/petercat/pem |
S3_BUCKET_NAME | 必选 | AWS 图片文件 S3 的 bucket | xxx-temp |
SQS_QUEUE_URL | 必选 | AWS SQS 消息队列 URL | https://sqs.ap-northeast-1.amazonaws.com/xxx/petercat-task-queue |
| SUPABASE 相关 env | |||
SUPABASE_URL | 必选 | supabase 服务的 URL，可以在这里找到 | https://***.supabase.co |
SUPABASE_SERVICE_KEY | 必选 | supabase 服务密钥，可以在这里找到 | {{SUPABASE_SERVICE_KEY}} |
| **Auth0 相关 env ** | |||
AUTH0_DOMAIN | 必选 | auth0 服务域名，从 auth0 / Application / Basic Information 下获取 | petercat.us.auth0.com |
AUTH0_CLIENT_ID | 必选 | auth0 客户端 ID，从 auth0 / Application / Basic Information 下获取 | artfiUxxxx |
AUTH0_CLIENT_SECRET | 必选 | auth0 客户端密钥， 从 auth0 / Application / Basic Information 下获取 | xxxx-xxxx-xxx |
API_IDENTIFIER | 必选 | auth0 的 API Identifier | https://petercat.us.auth0.com/api/v2/ |
| LLM相关的 env | |||
OPENAI_API_KEY | 必选 | OpenAI 的密钥 | sk-xxxx |
GEMINI_API_KEY | 必选 | Gemini 的密钥 | xxxx |
TAVILY_API_KEY | 必选 | Tavily 的密钥 | tvly-xxxxx |
| 注册为 Github App 的 env | |||
X_GITHUB_APP_ID | 可选 | 注册为 Github App 时，APPID | 123456 |
X_GITHUB_APPS_CLIENT_ID | 可选 | 注册为 Github App 时，APP 的 Client ID | Iv1.xxxxxxx |
X_GITHUB_APPS_CLIENT_SECRET | 可选 | 注册为 Github App 时，APP 的 Client 密钥 | xxxxxxxx |
| 限流配置 | |||
RATE_LIMIT_ENABLED | 可选 | 限流配置是否开启 | True |
RATE_LIMIT_REQUESTS | 可选 | 限流的请求数量 | 100 |
RATE_LIMIT_DURATION | 可选 | 限流的统计时长，单位为分钟 | 1 |
🔨 本地开发
🤝 参与贡献
Peter Cat 使用 yarn 作为包管理器
💼 企业版接入
📧 反馈问题
有任何问题请字 提交 Issue 或在 Discussions 提问。
👬 Contributors
📄 License
MIT@Peter Cat
Tag summary
Content type
Image
Digest
sha256:8ef223f11…
Size
194.4 MB
Last updated
about 2 years ago
docker pull petercatai/petercat