跳转到内容

安装向导

bun run setup 是本地基于 Bun 安装自部署的推荐路径。该命令会在加载向导前先从 bun.lock 安装依赖,包括在全新的代码克隆上。向导会创建你的 .env,生成 CRYPTO_SECRET,询问你的 Discord bot 令牌,并配置 PostgreSQL。重复运行也是安全的;既有的 .env 值会被保留,除非你选择重新配置它们。

  • Bun:用于运行 bot 和向导本身。
  • Discord bot 令牌:需启用 GuildMembers、MessageContent 和 GuildPresences 特权 intent。
  • 已安装 PostgreSQL:TomoriBot 将所有数据存放在 PostgreSQL 中。你不需要手动配置,向导会为你完成:如果你已安装 PostgreSQL,它将直接使用;如果你没有安装,它会在 Docker 中为你运行一个。只要确保在开始前已安装两者之一即可。TomoriBot 会在首次启动时自动初始化其数据表结构、种子数据、迁移、pgcrypto 和 RAG 数据结构。
Terminal window
git clone https://github.com/Bredrumb/TomoriBot.git
cd TomoriBot

使用以下命令运行安装向导:

Terminal window
bun run setup

运行该命令后,你将选择以下两条路径之一:

路径何时选用作用
完整安装(Full Install)需要推荐的配置及轻量附加项。运行基础安装,随后尝试配置下方的附加项。
基础安装(Base Install)只需要能够运行的最小化 bot。创建并配置 .env、Discord 令牌、PostgreSQL 和依赖。

完整安装会先运行基础安装,然后尝试安装下方的附加项。如果某一项失败,它会打印手动完成的命令或指南并继续执行:

附加项用途
pgvector用于文档与 RAG 记忆的向量检索。
pg_cron可选的冷却与提醒数据行定时清理。
分词器资源用于 NovelAI 文本生成与感知模型的词元偏置的本地分词器资源。

如需手动安装其中任何一项,请参见 手动安装附加项。

Terminal window
bun run dev # 仅运行 bot
bun run launch --searxng --crawl4ai # bot 与本地服务器一同运行(参见 bun run launch --help)

当 bot 上线后,在 Discord 中运行 /setup。它会引导你连接 AI 提供方或自定义端点。

使用优先备份的更新指令:bun run update

这会运行 bun run backup,然后执行 git pull --rebase --autostash,最后执行 bun install --frozen-lockfile。如果你从 dist/ 运行,请添加 --build;如果是 Compose 部署,请添加 --docker。完整说明请参见 维护与备份页面。