mirror of
https://github.com/AstrBotDevs/AstrBot
synced 2026-07-15 17:30:13 +08:00
fd4fe84310
* Update listen-message-event.md * Update other.md * Update send-message.md * Update ai.md * Update ai.md * Update send-message.md * Update listen-message-event.md * Delete docs/zh/dev/star/guides/env.md * Delete docs/en/dev/star/guides/env.md * Update simple.md * Update discord.md * Update discord.md * Update matrix.md * Update matrix.md * Update index.md * Update index.md * Update openapi.md * Update ppio.md * Update ppio.md * Update function-calling.md * Update function-calling.md * Update config.mjs * docs: add EN desktop deployment page * Update plugin.md * Update ai.md * Update ai.md * Update ai.md * Update desktop.md
44 lines
2.3 KiB
Markdown
44 lines
2.3 KiB
Markdown
# Connecting to Matrix
|
|
|
|
> [!TIP]
|
|
> This platform adapter is maintained by the community ([stevessr](https://github.com/stevessr)). If you find it helpful, please support the developer by giving the repository a Star. ❤️
|
|
|
|
## Deploying a Matrix Server
|
|
|
|
Matrix is an IM protocol with a rich set of server implementations.
|
|
|
|
Please refer to [Matrix Server](https://matrix.org/ecosystem/servers/) to view available server implementations.
|
|
|
|
## Supported Message Types
|
|
|
|
| Message Type | Receive | Send | Notes |
|
|
| ------------ | ------- | ---- | ----- |
|
|
| Text | Yes | Yes | |
|
|
| Image* | Yes | Yes | |
|
|
| Audio* | Yes | Yes | |
|
|
| Video* | Yes | Yes | |
|
|
| File* | Yes | Yes | |
|
|
| Poll | Yes | No | |
|
|
|
|
\*: Will be persisted locally. The plugin will clean up according to configuration. Files will be uploaded before sending; uploads exceeding the server's size limit will fail.
|
|
|
|
## Installing the astrbot_plugin_matrix_adapter Plugin
|
|
|
|
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).
|
|
|
|
Click `Enable` in the configuration dialog that appears.
|
|
|
|
## Configuration
|
|
|
|
- **`matrix_homeserver` (required)**: The full URL of your Matrix server instance, supports delegation-based auto-discovery. For example, the official instance: `https://matrix.org`
|
|
- **`matrix_user_id`**: Your full Matrix username, e.g. `@username:homeserver.com`
|
|
- **`matrix_auth_method` (required)**: Your login method. Options: `password`, `token`, `oauth2`, `qr`. It is recommended to use `password` or `oauth2/qr` mode (in oauth2/qr mode, please ensure the device used for authentication/scanning can reach the public address configured in AstrBot)
|
|
|
|
For more configuration options, please refer to the repository's [README.md](https://github.com/stevessr/astrbot_plugin_matrix_adapter?tab=readme-ov-file#astrbot-matrix-adapter-%E6%8F%92%E4%BB%B6).
|
|
|
|
## Issue Reporting
|
|
|
|
If you have any questions, please submit an issue to the [plugin repository](https://github.com/stevessr/astrbot_plugin_matrix_adapter/issues).
|