Back to Astrbot

Connect server-satori (Koishi)

docs/en/platform/satori/server-satori.md

4.24.21.9 KB
Original Source

Connect server-satori (Koishi)

[!TIP] server-satori is a Koishi plugin that exposes Koishi as a Satori server, so AstrBot can connect to Koishi through Satori.

Preparation

Make sure you already have a running Koishi instance.

If not, follow official docs first:

Enable server-satori in Koishi

  1. Open Koishi admin panel.
  2. Go to Plugin Config.
  3. Install and enable server-satori (defaults usually work).

After enabling, server-satori serves Satori API under /satori.

Configure Satori Adapter in AstrBot

  1. Open AstrBot Dashboard.
  2. Click Bots.
  3. Click + Create Bot.
  4. Select satori.

Fill in:

  • Bot ID (id): server-satori
  • Enable (enable): checked
  • Satori API endpoint (satori_api_base_url): http://localhost:5140/satori/v1
  • Satori WebSocket endpoint (satori_endpoint): ws://localhost:5140/satori/v1/events
  • Satori token (satori_token): usually empty unless configured in Koishi

[!NOTE]

  • Koishi default port is 5140.
  • server-satori default path is /satori.
  • So the full API base is http://localhost:5140/satori/v1.
  • If your Koishi runs on different host/port/path, change accordingly.

Click Save.

Done

AstrBot should now be connected to Koishi via server-satori.

Test by sending an AstrBot command (for example /help) in Koishi sandbox.

Troubleshooting

If connection fails, check:

  1. Koishi is running.
  2. server-satori is installed and enabled.
  3. Port/path are configured correctly.
  4. Firewall is not blocking related ports.