资讯动态

Knowledge Agent Template 生产部署完全指南:环境变量、GitHub App 配置与自托管

发布时间:2026/10/16 2:11:37 来源:尧图企业网站定制
AI 应用AI Agent人工智能后端前端【免费下载链接】knowledge-agent-templateOpen source file-system and knowledge based agent template. Build AI agents that stay up to date with your knowledge base项目地址https://gitcode.com/gh_mirrors/kn/knowledge-agent-template点击查看免费下载Knowledge Agent Template是一个开源的基于文件系统与知识库的 AI Agent 模板它通过grep、find、cat等命令在沙箱中直接检索你的文档无需向量数据库和 embedding即可部署为聊天应用、GitHub Bot、Discord Bot。本文带你完成生产部署的三大核心环节环境变量配置、GitHub App 创建、自托管上线全程零冗余、按步骤执行即可完成。一、部署前必读它凭什么不需要向量数据库在动手之前先花 30 秒理解它的部署逻辑这决定了你需要配置哪些环境变量Sources 入库知识源GitHub 仓库、YouTube 转录等配置存在数据库中通过管理后台维护内容同步同步流程把各源的内容聚合到一个快照仓库Snapshot Repo沙箱检索用户提问时Agent 在隔离沙箱中执行文件检索命令AI 回答工具与 Vercel AI SDK 兼容可接入任意 LLM完整架构可参考 docs/ARCHITECTURE.md同步流程实现在 apps/app/server/workflows/sync-docs/。二、环境变量清单3 个必填 1 个本地开发专用项目提供了完整的环境变量模板复制一份再填写即可cp apps/app/.env.example apps/app/.env模板文件位于 apps/app/.env.example逐项说明在 docs/ENVIRONMENT.md。2.1 必填变量部署 Vercel 或自托管都必需变量用途如何获取BETTER_AUTH_SECRET会话与令牌签名密钥终端执行openssl rand -hex 32生成随机值GITHUB_CLIENT_IDGitHub OAuth 登录凭证GitHub App 设置页的 Client IDGITHUB_CLIENT_SECRETGitHub OAuth 登录凭证GitHub App 设置页生成 Client Secret2.2 本地开发专用变量变量说明AI_GATEWAY_API_KEYVercel AI Gateway 的 API Key用于路由到任意 AI 模型。部署到 Vercel 时不需要——平台会通过 OIDC 令牌自动鉴权仅本地开发时需要 小贴士其余变量沙箱、Bot、Redis 等都是可选的可以上线后在管理界面再配置。2.3 沙箱与同步相关可选建议了解变量默认值说明NUXT_GITHUB_SNAPSHOT_REPO—快照仓库owner/repo格式可在管理界面配置NUXT_GITHUB_SNAPSHOT_BRANCHmain快照使用的分支NUXT_GITHUB_TOKEN—兜底 PAT仅在 GitHub App 令牌不可用时才需要三、GitHub App 配置一个 App 同时搞定登录 BotKnowledge Agent Template 的巧妙设计是一个 GitHub App 既承担用户 OAuth 登录又驱动 GitHub BotWebhook 事件避免维护两套 App。详细流程见 apps/app/app/content/docs/getting-started.md。3.1 创建 GitHub App 的 6 个步骤进入 GitHub 的Settings → Developer settings → GitHub Apps → New GitHub App填写基础信息App name机器人名称如my-agentHomepage URL你的实例地址本地开发填http://localhost:3000Callback URLyour-url/api/auth/callback/githubOAuth 登录用Webhook URLyour-url/api/webhooks/githubBot 用Webhook secret生成一个随机字符串并保存Account permissionsEmail addresses→ Read-only登录时按邮箱识别用户Repository permissionsIssues→ Read Write机器人读 Issue 并回复Metadata→ Read-onlyGitHub 对所有 App 的强制要求若想让管理后台自动管理快照仓库再加Contents→ Read Write以及Administration→ Read WriteEvents勾选Issues和Issue comments两个 Webhook 事件创建完成后从 App 设置页收集 5 个值页面上的值对应环境变量App IDNUXT_GITHUB_APP_IDClient IDGITHUB_CLIENT_IDClient secret生成GITHUB_CLIENT_SECRETPrivate key生成PEM 格式NUXT_GITHUB_APP_PRIVATE_KEYWebhook secretNUXT_GITHUB_WEBHOOK_SECRET3.2 两个容易踩的坑必须把 App 设为 Public在设置页底部的 Danger Zone 操作。保持 Private 时组织安装器不会出现只能装到个人账户。安装到目标仓库在Install App标签页选择要启用机器人的仓库若需自动管理快照仓库确保 App 已安装到目标 owner用户/组织并具备上述权限。四、自托管部署4 条命令跑起来4.1 最快启动步骤# 1. 克隆仓库 git clone https://gitcode.com/gh_mirrors/kn/knowledge-agent-template cd knowledge-agent-template # 2. 安装依赖项目默认使用 bun bun install # 3. 配置环境变量 cp apps/app/.env.example apps/app/.env # 编辑 .env填入第二节中的必填变量 # 4. 启动 bun run dev应用将在http://localhost:3000可用。⚠️ 注意第一个注册的用户自动获得管理员权限请在生产环境想好谁第一个登录。4.2 首次上线后的三件事添加知识源进入/admin→ Sources → Add source配置 GitHub 仓库或 YouTube 频道触发同步点击 Sync同步以可重跑的 Workflow 执行——从最新快照创建沙箱、克隆各源仓库、只保留.md/.json等文档文件、推送到快照仓库并重建快照配置 Agent 行为/admin/agent可调整回复风格、模型、温度、引用方式等管理后台还提供统计/admin/stats、API Keys/admin/api-keys等模块路由实现见 apps/app/app/pages/admin/。五、可选扩展Bot、Redis 与 YouTube确认核心功能跑通后再按需添加这些可选环境变量完整说明见 docs/ENVIRONMENT.mdGitHub Bot依赖第三节的 App 凭证变量说明NUXT_PUBLIC_GITHUB_APP_NAMEGitHub App 名称NUXT_GITHUB_APP_ID/NUXT_GITHUB_APP_PRIVATE_KEYApp ID 与私钥NUXT_GITHUB_WEBHOOK_SECRETWebhook 密钥Discord BotNUXT_DISCORD_BOT_TOKEN、NUXT_DISCORD_PUBLIC_KEY、NUXT_DISCORD_APPLICATION_ID交互端点设为your-url/api/webhooks/discord。生产环境状态持久化REDIS_URL机器人状态的 Redis 连接地址不配置则用内存态重启后丢失生产环境强烈建议配置NUXT_YOUTUBE_API_KEY仅当同步 YouTube 源时需要六、部署自查清单检查项状态3 个必填环境变量已填写☐本地开发时已配置AI_GATEWAY_API_KEY☐GitHub App 设为 Public 并完成仓库安装☐Webhook 订阅了 Issues Issue comments☐首个登录用户已确认为管理员本人☐生产环境配置了REDIS_URL☐管理后台添加知识源并成功 Sync☐总结Knowledge Agent Template 的部署门槛并不高——3 个环境变量 1 个 GitHub App 就能上线文件检索代替向量库的设计还帮你省掉了 embedding 基础设施的运维成本。建议阅读 docs/CUSTOMIZATION.md 完成品牌改名以及 docs/SOURCES.md 了解更多知识源类型把它真正变成你自己的知识库 Agent。赞分享AI 应用AI Agent人工智能后端前端【免费下载链接】knowledge-agent-templateOpen source file-system and knowledge based agent template. Build AI agents that stay up to date with your knowledge base项目地址https://gitcode.com/gh_mirrors/kn/knowledge-agent-template点击查看免费下载相关推荐OneUptime 自托管 GitHub 集成完整指南创建 GitHub App、配置环境变量与安全加固OneUptime 自托管 GitHub 集成完整指南创建 GitHub App、配置环境变量与安全加固 本篇技术指南以 OneUptime 官方自托管文档为可观测性后端运维前端云原生微服务AI Agentgiscus 自托管Self-hosting完整部署指南从创建 GitHub App 到生产环境上线giscus 自托管Self hosting完整部署指南从创建 GitHub App 到生产环境上线 导读 giscus 是一款基于 GitHub Di后端Wasp 部署实战外部认证Google / GitHub 等环境变量在生产环境的完整配置指南Wasp 部署实战外部认证Google / GitHub 等环境变量在生产环境的完整配置指南 导读 在 Wasp 应用中启用 Google、GitHub后端前端Web框架编译器开发工具代码生成创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考

读完文章,也想定制专属网站?

尧图设计师 24 小时内与您沟通定制方案

免费获取报价 →
↑