Skip to content

更新 WebChat 附件存储路径说明与数据目录结构文档 #136

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
astrbot-doc-agent wants to merge 1 commit into
base: v4
Choose a base branch
from
Open

更新 WebChat 附件存储路径说明与数据目录结构文档 #136

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions en/dev/star/guides/storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,18 @@ from astrbot.core.utils.astrbot_path import get_astrbot_data_path

plugin_data_path = get_astrbot_data_path() / "plugin_data" / self.name # self.name is the plugin name; available in v4.9.2 and above. For lower versions, specify the plugin name yourself.
```

## AstrBot Data Directory Structure

AstrBot's data directory (`data/`) contains the following important subdirectories:

| Directory | Description |
|-----------|-------------|
| `data/attachments/` | Unified attachment storage for images, audio, files, etc. from WebChat and other platforms |
| `data/plugin_data/` | Plugin data storage directory |
| `data/config/` | Multi-configuration file storage (files starting with `abconf_`) |
| `data/dist/` | Admin panel frontend files |
| `data/webchat/imgs/` | (Deprecated) Legacy WebChat image directory; migrated to `attachments/` in newer versions |

> [!NOTE]
> To access attachment files from WebChat and other platforms, use the `data/attachments/` directory. AstrBot automatically handles backward-compatible reading from both new and old locations.
7 changes: 7 additions & 0 deletions en/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ To modify your account credentials, follow these steps:
> For security reasons, when runtime environment is set to `local`, AstrBot only allows AstrBot administrators to use computer capabilities by default.
> You can select `sandbox` for the runtime environment, which allows all users to use computer capabilities (in an isolated sandbox). For more details, see [AstrBot Sandbox Environment](/en/use/astrbot-agent-sandbox.md)

### Where are WebChat attachments (images/files) stored?

WebChat attachments (images, audio, files) are stored in the unified `data/attachments/` directory.

> [!NOTE]
> In earlier versions, WebChat attachments were stored in `data/webchat/imgs/`. Newer versions have migrated to the unified `data/attachments/` directory with backward compatibility for reading from the old location.

### Bot Cannot Chat in Group Conversations

1. In group chats, to prevent message flooding, the bot will not respond to every monitored message. Please try mentioning (@) the bot or using a wake word to chat, such as the default `/`, for example: `/hello`.
Expand Down
15 changes: 15 additions & 0 deletions zh/dev/star/guides/storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,18 @@ from astrbot.core.utils.astrbot_path import get_astrbot_data_path

plugin_data_path = get_astrbot_data_path() / "plugin_data" / self.name # self.name 为插件名称，在 v4.9.2 及以上版本可用，低于此版本请自行指定插件名称
```

## AstrBot 数据目录结构

AstrBot 的数据目录（`data/`）包含以下重要子目录：

| 目录 | 说明 |
|------|------|
| `data/attachments/` | 统一附件存储目录，存放 WebChat 等平台的图片、音频、文件等附件 |
| `data/plugin_data/` | 插件数据存储目录 |
| `data/config/` | 多配置文件存储目录（以 `abconf_` 开头） |
| `data/dist/` | 管理面板前端文件 |
| `data/webchat/imgs/` | （已废弃）旧版 WebChat 图片目录，新版本已迁移至 `attachments/` |

> [!NOTE]
> 如需访问 WebChat 等平台的附件文件，请使用 `data/attachments/` 目录。AstrBot 会自动处理新旧目录的兼容读取。
7 changes: 7 additions & 0 deletions zh/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,13 @@
- Windows: `C:\Users\你的用户名\.astrbot_launcher`
- MacOS / Linux: `/Users/你的用户名/.astrbot_launcher` 或者 `/home/你的用户名/.astrbot_launcher`

### WebChat 聊天记录中的图片/文件存储在哪里？

WebChat 的附件（图片、音频、文件）统一存储在 `data/attachments/` 目录下。

> [!NOTE]
> 在较早版本中，WebChat 附件存储在 `data/webchat/imgs/` 目录。新版本已迁移至统一的 `data/attachments/` 目录，并保持对旧目录的向后兼容读取。

### 机器人在群聊无法聊天

1. 群聊情况下，由于防止消息泛滥，不会对每条监听到的消息都回复，请尝试 @ 机器人或者使用唤醒词来聊天，比如默认的 `/`，输入 `/你好`。
Expand Down