コンテンツにスキップ

セットアップウィザード

bun run setup は、ローカルでのBunベースのインストールに推奨されるセルフホストパスです。このコマンドは、新規クローン時も含め、ウィザードを読み込む前に bun.lock から依存関係をインストールします。ウィザードは .env を作成し、CRYPTO_SECRET を生成し、Discordボットのトークンを尋ね、PostgreSQLを設定します。再実行しても安全です。既存の .env の値は、再設定を選択しない限り保持されます。

  • Bun(ボットおよびウィザード自体の実行に必要です)。
  • Discordボットのトークン(GuildMembers、MessageContent、および GuildPresences の特権インテントが有効になっているもの)。
  • インストール済みの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

コマンドを実行すると、2つのパスのいずれかを選択することになります:

パス使用する場合実行内容
フルインストール軽量な追加機能を含む推奨のセットアップを行いたい場合。基本インストールを実行後、以下の追加機能を試行します。
基本インストール最低限動作するボットのみが必要な場合。.env、Discordトークン、PostgreSQL、および依存関係を作成・設定します。

フルインストールでは、まず基本インストールが実行され、その後以下の追加機能のインストールが試行されます。いずれかが失敗した場合、ウィザードは手動で完了させるためのコマンドやガイドを出力し、そのまま処理を続行します:

追加機能目的
pgvectorドキュメント/RAGの記憶用のベクトル検索。
pg_cronオプションのスケジュールされたクールダウン/リマインダー行のクリーンアップ。
トークナイザーアセットNovelAIのテキスト生成およびモデルに応じたロジットバイアス用のローカルのトークナイザーアセット。

これらを手動でインストールする場合は、 マニュアルセットアップの追加機能 を参照してください。

Terminal window
bun run dev # ボットのみ
bun run launch --searxng --crawl4ai # ボットとローカルサーバー(bun run launch --help を参照)

ボットがオンラインになったら、Discordで /setup を実行します。AIプロバイダーまたはカスタムエンドポイントへの接続手順が案内されます。

バックアップ優先のアップデーターコマンドである bun run update を使用してください。

これにより、bun run backup が実行され、続いて git pull --rebase --autostash、そして bun install --frozen-lockfile が実行されます。dist/ から実行する場合は --build を、Composeデプロイメントの場合は --docker を追加してください。詳細については メンテナンスとバックアップ ページを参照してください。