Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/en/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,8 @@ After restart, AstrBot will reload or download WebUI files that match the curren

### How to Let AstrBot Control My Mac / Windows / Linux Computer?

1. In AstrBot WebUI's `Config -> General Config`, find `Use Computer Capabilities`, and select `local` for the runtime environment.
2. In `Config -> Other Config`, find `Admin ID List`, and add your user ID (you can get it through the `/sid` command).
1. In AstrBot WebUI's `Config → AI`, find `Agent Computer Use`, and select `local` for the runtime environment.
2. In `Config → Platform`, find `Administrator IDs`, and add your user ID (you can get it through the `/sid` command).

> [!TIP]
> For security reasons, when runtime environment is set to `local`, AstrBot only allows AstrBot administrators to use computer capabilities by default.
Expand All @@ -102,7 +102,7 @@ After restart, AstrBot will reload or download WebUI files that match the curren

### No Permission to Execute Admin Commands

1. `/name, /provider, /dashboard_update, /op, /deop, /persona, /llm, /plugin, /model, /groupnew` are the default admin commands. You can use the `/sid` command to get a user's ID, then add it to the admin ID list in Settings -> Other Settings.
1. `/name, /provider, /dashboard_update, /op, /deop, /persona, /llm, /plugin, /model, /groupnew` are the default admin commands. You can use the `/sid` command to get a user's ID, then add it to `Administrator IDs` in `Config → Platform`.

### Chinese Characters Garbled When Locally Rendering Markdown Images (t2i)

Expand All @@ -125,7 +125,7 @@ This is because the provider's API returned empty text. Try the following steps:

### Cannot Install Plugin

1. Plugins are installed via GitHub. Access to GitHub from mainland China can indeed be unstable. You can use a proxy, then go to Other Settings -> HTTP Proxy to configure it. Alternatively, download the plugin archive directly and upload it.
1. Plugins are installed via GitHub. Access to GitHub from mainland China can indeed be unstable. You can use a proxy, then go to `Settings -> Network -> HTTP Proxy` to configure it. Alternatively, download the plugin archive directly and upload it.

### Error `No module named 'xxx'` After Installing Plugin

Expand Down
2 changes: 1 addition & 1 deletion docs/en/others/self-host-t2i.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You can choose to self-host the text-to-image service to improve response speed.
docker run -itd -p 8999:8999 soulter/astrbot-t2i-service:latest
```

After deployment, go to AstrBot Dashboard -> Config -> System, and change `Text-to-Image Service API Endpoint` to the URL you deployed (as shown below).
After deployment, go to AstrBot WebUI `Settings -> Appearance`, and change `Text-to-Image Service API Endpoint` to the URL you deployed (as shown below).

> If you deployed AstrBot using the Docker tutorial in this documentation, the URL should be `http://<t2i-service-container-name>:8999`.

Expand Down
4 changes: 2 additions & 2 deletions docs/en/platform/aiocqhttp.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Please refer to each implementation project's deployment documentation.
## 1. Configure OneBot v11

1. Open AstrBot's WebUI
2. Click `Bots` in the left sidebar
3. In the right panel, click `+ Create Bot`
2. Click `Platforms` in the left sidebar
3. In the right panel, click `+ Add Adapter`
4. Select `OneBot v11`

Fill in the form:
Expand Down
2 changes: 1 addition & 1 deletion docs/en/platform/dingtalk.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ DingTalk supports two setup methods: one-click QR creation in AstrBot, or manual

AstrBot version requirement: >= v4.25.0.

Open AstrBot Dashboard -> `Bots` -> `+ Create Bot`, then select `DingTalk`.
Open AstrBot Dashboard -> `Platforms` -> `+ Add Adapter`, then select `DingTalk`.

Under `Creation Method`, select `One-click QR setup`, scan the QR code with the DingTalk mobile app, then create or bind a bot on the DingTalk authorization page. After creation succeeds, AstrBot automatically fills in `ClientID` and `ClientSecret`. Click `Save` to finish.

Expand Down
4 changes: 2 additions & 2 deletions docs/en/platform/kook.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ Message receiving mode: WebSocket
## Configure in AstrBot

1. Access the AstrBot management panel.
2. Click **Bots** in the left sidebar.
3. Click `+ Create Bot` on the right side of the interface.
2. Click **Platforms** in the left sidebar.
3. Click `+ Add Adapter` on the right side of the interface.
4. Select the `kook` adapter.
5. Fill in the configuration fields:
- ID (id): Any name to identify this specific instance.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/platform/lark.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Lark supports two setup methods: one-click QR creation in AstrBot, or manually c

AstrBot version requirement: >= 4.25.0.

Open the AstrBot management panel, click `Bots` in the left sidebar, click `+ Create Bot`, and select `lark`.
Open the AstrBot management panel, click `Platforms` in the left sidebar, click `+ Add Adapter`, and select `lark`.

Under `Creation Method`, select `One-click QR Creation`, choose the China or international edition as needed, then scan the QR code with the Lark mobile app and confirm. After creation succeeds, AstrBot automatically fills in the app's `app_id`, `app_secret`, and domain configuration.

Expand All @@ -35,7 +35,7 @@ Under `Creation Method`, select `One-click QR Creation`, choose the China or int
>
> Replace `<APP_ID>` in the URL below with your Lark app ID, then open it to jump to the permission enablement page:
>
> To find the App ID, go back to AstrBot's `Bots` page, find the Lark bot you just created, click `Edit`, and check the dialog that opens.
> To find the App ID, go back to AstrBot's `Platforms` page, find the Lark bot you just created, click `Edit`, and check the dialog that opens.
>
> ```text
> https://open.feishu.cn/app/<APP_ID>/auth?q=contact:contact.base:readonly,im:message.p2p_msg:readonly,im:message.group_at_msg:readonly,im:message:send,im:message,im:message:send_as_bot,im:resource:upload,im:resource,cardkit:card:write,im:message.group_at_msg:readonly,im:message.group_msg&op_from=openapi&token_type=tenant
Expand Down
4 changes: 2 additions & 2 deletions docs/en/platform/line.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ How to get them:
## Configure AstrBot

1. Open the AstrBot admin panel
2. Click `Bots` in the left sidebar
3. Click `+ Create Bot`
2. Click `Platforms` in the left sidebar
3. Click `+ Add Adapter`
4. Select `line`

Fill in these fields:
Expand Down
2 changes: 1 addition & 1 deletion docs/en/platform/matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Please refer to [Matrix Server](https://matrix.org/ecosystem/servers/) to view a

Go to the AstrBot WebUI plugin marketplace, search for `astrbot_plugin_matrix_adapter`, and click Install.

After installation, navigate to Messaging Platforms (older versions: `Bot`) → Add Adapter → Select Matrix (if the option is missing, try restarting AstrBot or check the plugin installation status).
After installation, navigate to Platforms (older versions: `Bot`) → Add Adapter → Select Matrix (if the option is missing, try restarting AstrBot or check the plugin installation status).

Click `Enable` in the configuration dialog that appears.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/platform/mattermost.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The Mattermost adapter connects to your Mattermost server through a Bot Token an

## Create the AstrBot Mattermost Platform Adapter

Go to the `Bots` page, click `+ Create Bot`, and choose `Mattermost`.
Go to the `Platforms` page, click `+ Add Adapter`, and choose `Mattermost`.

On the configuration page, enable it first, then fill in:

Expand Down
2 changes: 1 addition & 1 deletion docs/en/platform/misskey.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## Create AstrBot Misskey Platform Adapter

Navigate to the messaging platform, click to add a new adapter, find Misskey and click to enter the Misskey configuration page.
Navigate to the Platforms, click to Add Adapter, find Misskey and click to enter the Misskey configuration page.

![Create Misskey Platform Adapter](https://files.astrbot.app/docs/source/images/misskey/create.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/en/platform/qqofficial/webhook.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Proactive message push: Supported.

### Setup Flow

1. In AstrBot WebUI, click `Bots` in the left sidebar, then click `+ Create Bot`.
1. In AstrBot WebUI, click `Platforms` in the left sidebar, then click `+ Add Adapter`.
2. Select `QQ Official Bot (Webhook)`.
3. Under `Choose setup method`, select `One-click QR setup`, click start, then scan the QR code with mobile QQ.
4. After confirming the QR binding, click `Save`.
Expand Down Expand Up @@ -93,8 +93,8 @@ Open `Development -> Development Settings`, find IP whitelist, and add your serv
### Configure in AstrBot

1. Open AstrBot Dashboard.
2. Click `Bots` in the left sidebar.
3. Click `+ Create Bot`.
2. Click `Platforms` in the left sidebar.
3. Click `+ Add Adapter`.
4. Select `QQ Official Bot (Webhook)`.

Recommended: use `One-click QR setup`.
Expand Down
6 changes: 3 additions & 3 deletions docs/en/platform/qqofficial/websockets.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Proactive message push: Supported.

### Setup Flow

1. In AstrBot WebUI, click `Bots` in the left sidebar, then click `+ Create Bot`.
1. In AstrBot WebUI, click `Platforms` in the left sidebar, then click `+ Add Adapter`.
2. Select `QQ Official Bot (WebSocket)`.
3. Under `Choose setup method`, select `One-click QR setup`, click start, then scan the QR code with mobile QQ.
4. After you confirm the QR binding, AstrBot automatically fills in `AppID` and `AppSecret`. Make sure `Enable` is checked, then click `Save`.
Expand Down Expand Up @@ -82,8 +82,8 @@ Open `Development -> Development Settings`, find IP whitelist, and add your serv
### Configure in AstrBot

1. Open AstrBot Dashboard.
2. Click `Bots` in the left sidebar.
3. Click `+ Create Bot`.
2. Click `Platforms` in the left sidebar.
3. Click `+ Add Adapter`.
4. Select `qq_official`.

Recommended: use `One-click QR setup`.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/platform/satori/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Please refer to the deployment documentation of the chosen implementation projec
## 2. Configure Satori protocol in AstrBot

1. Open AstrBot WebUI.
2. Click `Bots` in the left sidebar.
3. In the right panel, click `+ Create Bot`.
2. Click `Platforms` in the left sidebar.
3. In the right panel, click `+ Add Adapter`.
4. Select `satori`.

Fill in the form:
Expand Down
4 changes: 2 additions & 2 deletions docs/en/platform/satori/server-satori.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ 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`.
2. Click `Platforms`.
3. Click `+ Add Adapter`.
4. Select `satori`.

Fill in:
Expand Down
2 changes: 1 addition & 1 deletion docs/en/platform/slack.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Create AstrBot Slack Platform Adapter

Navigate to the `Bots` page, click `+ Create Bot`, find Slack and click to enter the Slack configuration page.
Navigate to the `Platforms` page, click `+ Add Adapter`, find Slack and click to enter the Slack configuration page.

![image](https://files.astrbot.app/docs/source/images/slack/image-1.png)

Expand Down
4 changes: 2 additions & 2 deletions docs/en/platform/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

AstrBot supports integration with many mainstream instant messaging platforms, so you can use AstrBot on the IM platform your team already uses.

In WebUI, click **Bots** in the left sidebar to open the messaging platform integration page.
Then click **Create Bot** in the top-right corner, choose the platform you want to connect, and follow the platform-specific guide in the left sidebar of this documentation.
In WebUI, click **Platforms** in the left sidebar to open the messaging platform integration page.
Then click **Add Adapter** in the top-right corner, choose the platform you want to connect, and follow the platform-specific guide in the left sidebar of this documentation.
8 changes: 4 additions & 4 deletions docs/en/platform/telegram.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ If you need to use the bot in group chats, you must disable the bot's [Privacy m
## 2. Configure AstrBot

1. Enter the AstrBot admin panel
2. Click `Bots` in the left sidebar
3. In the interface on the right, click `+ Create Bot`
2. Click `Platforms` in the left sidebar
3. In the interface on the right, click `+ Add Adapter`
4. Select `telegram`

Fill in the configuration fields that appear:
Expand All @@ -36,11 +36,11 @@ Fill in the configuration fields that appear:
- Enable: Check this option.
- Bot Token: Your Telegram bot's `token`.

Please ensure your network environment can access Telegram. You may need to configure a proxy using `Configuration -> Other Settings -> HTTP Proxy`.
Please ensure your network environment can access Telegram. You may need to configure a proxy using `Settings -> Network -> HTTP Proxy`.

## Streaming Output

The Telegram platform supports streaming output. Enable the "Streaming Output" switch in "AI Configuration" -> "Other Settings".
The Telegram platform supports streaming output. Enable the "Streaming Output" switch in the Config page.

### Private Chat Streaming

Expand Down
2 changes: 1 addition & 1 deletion docs/en/platform/vocechat.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In AstrBot Dashboard Plugin Market, search for `astrbot_plugin_vocechat` and ins

![image](https://files.astrbot.app/docs/source/images/vocechat/image.png)

After installation, go to `Bots` -> `+ Create Bot` -> `VoceChat`.
After installation, go to `Platforms` -> `+ Add Adapter` -> `VoceChat`.
If VoceChat is missing, restart AstrBot or verify plugin installation.

Enable the adapter in the configuration dialog.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/platform/wecom.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ Proactive message push: Supported for WeCom Application. Not fully tested for We
## Before You Start

1. Open AstrBot Dashboard.
2. Click `Bots` in the left sidebar.
3. Click `+ Create Bot`.
2. Click `Platforms` in the left sidebar.
3. Click `+ Add Adapter`.
4. Select `wecom`.

A configuration dialog will appear. Keep it open and continue with the steps below.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/platform/wecom_ai_bot.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Generate `Token` and `EncodingAESKey` using random generation, but do not click

## Configure AstrBot

1. Open AstrBot Dashboard, click `Messaging Platforms`, then click `+ Add Adapter`, choose `WeCom AI Bot`.
1. Open AstrBot Dashboard, click `Platforms`, then click `+ Add Adapter`, choose `WeCom AI Bot`.

![Add Adapter](https://files.astrbot.app/docs/source/images/wecom_ai_bot/image-2.png)

Expand Down
4 changes: 2 additions & 2 deletions docs/en/platform/weixin-official-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ AstrBot supports WeChat Official Account integration (version >= v3.5.8). After
## Before You Start

1. Open AstrBot Dashboard.
2. Click `Bots` in the left sidebar.
3. Click `+ Create Bot`.
2. Click `Platforms` in the left sidebar.
3. Click `+ Add Adapter`.
4. Select `weixin_official_account`.

A configuration dialog will appear. Keep it open and continue.
Expand Down
4 changes: 2 additions & 2 deletions docs/en/platform/weixin_oc.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ AstrBot supports connecting a personal WeChat account through the `Personal WeCh
## Create the Bot

1. Open AstrBot WebUI.
2. Click `Bots` in the left sidebar.
3. Click `+ Create Bot` in the upper-right corner.
2. Click `Platforms` in the left sidebar.
3. Click `+ Add Adapter` in the upper-right corner.
4. Select `Personal WeChat`.
5. The login QR code is shown directly. Scan it with WeChat on your phone and confirm the login inside WeChat.
6. After login succeeds, click `Save`.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/providers/302ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If needed, visit [this link](https://dash.302.ai/charge) to top up your account

## Connect

Open the AstrBot dashboard → Service Providers page, click **Add Provider**, find and click `302.AI` (requires version >= 3.5.18).
Open the AstrBot dashboard → Providers page, click **Add Provider**, find and click `302.AI` (requires version >= 3.5.18).

Set an ID, fill in the API Key and model name in the dialog form, then click **Save** to complete the setup.

Expand Down
4 changes: 2 additions & 2 deletions docs/en/providers/agent-runners/coze.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ We need to record the `bot_id` for later use.

After completing all the preparation work, we can now configure Coze in AstrBot.

Go to AstrBot Admin Panel -> Service Provider -> Add Service Provider -> Coze to enter the configuration page.
Go to AstrBot Admin Panel -> Providers -> Agent Runner -> Add Provider -> Coze to enter the configuration page.

![Coze Provider](https://files.astrbot.app/docs/source/images/coze/image_8.png)

Expand All @@ -61,5 +61,5 @@ Fill in the API Key and bot_id you just created, then click Save.

## Select Agent Runner

Go to the Configuration page in the left sidebar, click "Agent Execution Method", select "Coze", then select the ID of the Coze Agent Runner you just created in the new configuration options that appear below, and click "Save" in the bottom right corner to complete the configuration.
Go to the Config page in the left sidebar, click "Agent Execution Method", select "Coze", then select the ID of the Coze Agent Runner you just created in the new configuration options that appear below, and click "Save" in the bottom right corner to complete the configuration.

4 changes: 2 additions & 2 deletions docs/en/providers/agent-runners/dashscope.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Click to enter the application, click Publishing Channel -> API Call -> API KEY,

![alt text](https://files.astrbot.app/docs/source/images/dashscope/image-2.png)

In the WebUI, click "Model Provider" -> "Add Provider", select "Agent Runner", select "Alibaba Cloud Bailian Application", and enter the Alibaba Cloud Bailian Application configuration page.
In the WebUI, click "Providers" -> "Add Provider", select "Agent Runner", select "Alibaba Cloud Bailian Application", and enter the Alibaba Cloud Bailian Application configuration page.

According to Alibaba Cloud Bailian Application, there are four application types:

Expand All @@ -34,7 +34,7 @@ After filling in these three items, click Save.

## Select Agent Runner

Go to the Configuration page in the left sidebar, click "Agent Execution Method", select "Alibaba Cloud Bailian Application", then select the ID of the Alibaba Cloud Bailian Application Agent Runner you just created in the new configuration options that appear below, and click "Save" in the bottom right corner to complete the configuration.
Go to the Config page in the left sidebar, click "Agent Execution Method", select "Alibaba Cloud Bailian Application", then select the ID of the Alibaba Cloud Bailian Application Agent Runner you just created in the new configuration options that appear below, and click "Save" in the bottom right corner to complete the configuration.

## Appendix: Dynamically Set Workflow Input Variables During Chat (Optional)

Expand Down
4 changes: 2 additions & 2 deletions docs/en/providers/agent-runners/deerflow.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Make sure DeerFlow is running properly and that AstrBot can reach the DeerFlow g

## Configure DeerFlow in AstrBot

In the WebUI, click "Model Provider" -> "Add Provider", select "Agent Runner", select "DeerFlow", and enter the DeerFlow configuration page.
In the WebUI, click "Providers" -> "Add Provider", select "Agent Runner", select "DeerFlow", and enter the DeerFlow configuration page.

Fill in the following fields:

Expand All @@ -41,7 +41,7 @@ After filling in the configuration, click Save.

## Select Agent Runner

Go to the Configuration page in the left sidebar, click "Agent Execution Method", select "DeerFlow", then select the ID of the DeerFlow Agent Runner you just created in the new configuration option below, and click "Save" in the bottom right corner to complete the configuration.
Go to the Config page in the left sidebar, click "Agent Execution Method", select "DeerFlow", then select the ID of the DeerFlow Agent Runner you just created in the new configuration option below, and click "Save" in the bottom right corner to complete the configuration.

## Common Checks

Expand Down
4 changes: 2 additions & 2 deletions docs/en/providers/agent-runners/dify.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ If you haven't installed Dify yet, please refer to the [Dify Installation Docume

## Configure Dify in AstrBot

In the WebUI, click "Model Provider" -> "Add Provider", select "Agent Runner", select "Dify", and enter the Dify configuration page.
In the WebUI, click "Providers" -> "Add Provider", select "Agent Runner", select "Dify", and enter the Dify configuration page.

![image](https://files.astrbot.app/docs/source/images/dify/image.png)

Expand Down Expand Up @@ -64,7 +64,7 @@ Copy the key and paste it into the `API Key` field in the configuration, then cl

### Select Agent Runner

Go to the Configuration page in the left sidebar, click "Agent Execution Method", select "Dify", then select the ID of the Dify Agent Runner you just created in the new configuration options that appear below, and click "Save" in the bottom right corner to complete the configuration.
Go to the Config page in the left sidebar, click "Agent Execution Method", select "Dify", then select the ID of the Dify Agent Runner you just created in the new configuration options that appear below, and click "Save" in the bottom right corner to complete the configuration.

## Appendix: Dynamically Set Workflow Input Variables During Chat (Optional)

Expand Down
Loading
Loading