From 11542e9310aabc2bf41d6ba631149d782baa7825 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Sat, 4 Apr 2026 15:02:08 +0100 Subject: [PATCH] docs: refresh bundled channel plugin refs --- docs/channels/index.md | 20 ++++++++++---------- docs/channels/line.md | 8 ++++++-- docs/channels/matrix.md | 10 +++++++--- docs/channels/mattermost.md | 13 +++++++------ docs/channels/nextcloud-talk.md | 13 +++++++------ docs/channels/nostr.md | 21 ++++++++------------- docs/channels/synology-chat.md | 10 +++++++--- docs/channels/tlon.md | 10 +++++++--- docs/channels/twitch.md | 8 ++++++-- docs/channels/zalo.md | 10 +++++++--- docs/channels/zalouser.md | 10 +++++++--- 11 files changed, 79 insertions(+), 54 deletions(-) diff --git a/docs/channels/index.md b/docs/channels/index.md index c0c352d7c09..ea4f752c5ff 100644 --- a/docs/channels/index.md +++ b/docs/channels/index.md @@ -19,25 +19,25 @@ Text is supported everywhere; media and reactions vary by channel. - [Google Chat](/channels/googlechat) — Google Chat API app via HTTP webhook. - [iMessage (legacy)](/channels/imessage) — Legacy macOS integration via imsg CLI (deprecated, use BlueBubbles for new setups). - [IRC](/channels/irc) — Classic IRC servers; channels + DMs with pairing/allowlist controls. -- [LINE](/channels/line) — LINE Messaging API bot (plugin, installed separately). -- [Matrix](/channels/matrix) — Matrix protocol (plugin, installed separately). -- [Mattermost](/channels/mattermost) — Bot API + WebSocket; channels, groups, DMs (plugin, installed separately). +- [LINE](/channels/line) — LINE Messaging API bot (bundled plugin). +- [Matrix](/channels/matrix) — Matrix protocol (bundled plugin). +- [Mattermost](/channels/mattermost) — Bot API + WebSocket; channels, groups, DMs (bundled plugin). - [Microsoft Teams](/channels/msteams) — Bot Framework; enterprise support (bundled plugin). -- [Nextcloud Talk](/channels/nextcloud-talk) — Self-hosted chat via Nextcloud Talk (plugin, installed separately). -- [Nostr](/channels/nostr) — Decentralized DMs via NIP-04 (plugin, installed separately). +- [Nextcloud Talk](/channels/nextcloud-talk) — Self-hosted chat via Nextcloud Talk (bundled plugin). +- [Nostr](/channels/nostr) — Decentralized DMs via NIP-04 (bundled plugin). - [QQ Bot](/channels/qqbot) — QQ Bot API; private chat, group chat, and rich media. - [Signal](/channels/signal) — signal-cli; privacy-focused. - [Slack](/channels/slack) — Bolt SDK; workspace apps. -- [Synology Chat](/channels/synology-chat) — Synology NAS Chat via outgoing+incoming webhooks (plugin, installed separately). +- [Synology Chat](/channels/synology-chat) — Synology NAS Chat via outgoing+incoming webhooks (bundled plugin). - [Telegram](/channels/telegram) — Bot API via grammY; supports groups. -- [Tlon](/channels/tlon) — Urbit-based messenger (plugin, installed separately). -- [Twitch](/channels/twitch) — Twitch chat via IRC connection (plugin, installed separately). +- [Tlon](/channels/tlon) — Urbit-based messenger (bundled plugin). +- [Twitch](/channels/twitch) — Twitch chat via IRC connection (bundled plugin). - [Voice Call](/plugins/voice-call) — Telephony via Plivo or Twilio (plugin, installed separately). - [WebChat](/web/webchat) — Gateway WebChat UI over WebSocket. - [WeChat](https://www.npmjs.com/package/@tencent-weixin/openclaw-weixin) — Tencent iLink Bot plugin via QR login; private chats only. - [WhatsApp](/channels/whatsapp) — Most popular; uses Baileys and requires QR pairing. -- [Zalo](/channels/zalo) — Zalo Bot API; Vietnam's popular messenger (plugin, installed separately). -- [Zalo Personal](/channels/zalouser) — Zalo personal account via QR login (plugin, installed separately). +- [Zalo](/channels/zalo) — Zalo Bot API; Vietnam's popular messenger (bundled plugin). +- [Zalo Personal](/channels/zalouser) — Zalo personal account via QR login (bundled plugin). ## Notes diff --git a/docs/channels/line.md b/docs/channels/line.md index 04493bdb922..d767c8350be 100644 --- a/docs/channels/line.md +++ b/docs/channels/line.md @@ -17,9 +17,13 @@ Status: supported via plugin. Direct messages, group chats, media, locations, Fl messages, template messages, and quick replies are supported. Reactions and threads are not supported. -## Plugin required +## Bundled plugin -Install the LINE plugin: +LINE ships as a bundled plugin in current OpenClaw releases, so normal +packaged builds do not need a separate install. + +If you are on an older build or a custom install that excludes LINE, install it +manually: ```bash openclaw plugins install @openclaw/line diff --git a/docs/channels/matrix.md b/docs/channels/matrix.md index 673b27f7474..2860c21da03 100644 --- a/docs/channels/matrix.md +++ b/docs/channels/matrix.md @@ -11,9 +11,13 @@ title: "Matrix" Matrix is the Matrix channel plugin for OpenClaw. It uses the official `matrix-js-sdk` and supports DMs, rooms, threads, media, reactions, polls, location, and E2EE. -## Plugin required +## Bundled plugin -Matrix is a plugin and is not bundled with core OpenClaw. +Matrix ships as a bundled plugin in current OpenClaw releases, so normal +packaged builds do not need a separate install. + +If you are on an older build or a custom install that excludes Matrix, install +it manually: Install from npm: @@ -31,7 +35,7 @@ See [Plugins](/tools/plugin) for plugin behavior and install rules. ## Setup -1. Install the plugin. +1. Ensure the Matrix bundled plugin is available. 2. Create a Matrix account on your homeserver. 3. Configure `channels.matrix` with either: - `homeserver` + `accessToken`, or diff --git a/docs/channels/mattermost.md b/docs/channels/mattermost.md index a495276d484..1485718f8a6 100644 --- a/docs/channels/mattermost.md +++ b/docs/channels/mattermost.md @@ -12,9 +12,13 @@ Status: supported via plugin (bot token + WebSocket events). Channels, groups, a Mattermost is a self-hostable team messaging platform; see the official site at [mattermost.com](https://mattermost.com) for product details and downloads. -## Plugin required +## Bundled plugin -Mattermost ships as a plugin and is not bundled with the core install. +Mattermost ships as a bundled plugin in current OpenClaw releases, so normal +packaged builds do not need a separate install. + +If you are on an older build or a custom install that excludes Mattermost, +install it manually: Install via CLI (npm registry): @@ -28,14 +32,11 @@ Local checkout (when running from a git repo): openclaw plugins install ./path/to/local/mattermost-plugin ``` -If you choose Mattermost during setup and a git checkout is detected, -OpenClaw will offer the local install path automatically. - Details: [Plugins](/tools/plugin) ## Quick setup -1. Install the Mattermost plugin. +1. Ensure the Mattermost bundled plugin is available. 2. Create a Mattermost bot account and copy the **bot token**. 3. Copy the Mattermost **base URL** (e.g., `https://chat.example.com`). 4. Configure OpenClaw and start the gateway. diff --git a/docs/channels/nextcloud-talk.md b/docs/channels/nextcloud-talk.md index e5ef3d91588..456c7709123 100644 --- a/docs/channels/nextcloud-talk.md +++ b/docs/channels/nextcloud-talk.md @@ -9,9 +9,13 @@ title: "Nextcloud Talk" Status: supported via plugin (webhook bot). Direct messages, rooms, reactions, and markdown messages are supported. -## Plugin required +## Bundled plugin -Nextcloud Talk ships as a plugin and is not bundled with the core install. +Nextcloud Talk ships as a bundled plugin in current OpenClaw releases, so +normal packaged builds do not need a separate install. + +If you are on an older build or a custom install that excludes Nextcloud Talk, +install it manually: Install via CLI (npm registry): @@ -25,14 +29,11 @@ Local checkout (when running from a git repo): openclaw plugins install ./path/to/local/nextcloud-talk-plugin ``` -If you choose Nextcloud Talk during setup and a git checkout is detected, -OpenClaw will offer the local install path automatically. - Details: [Plugins](/tools/plugin) ## Quick setup (beginner) -1. Install the Nextcloud Talk plugin. +1. Ensure the Nextcloud Talk bundled plugin is available. 2. On your Nextcloud server, create a bot: ```bash diff --git a/docs/channels/nostr.md b/docs/channels/nostr.md index 01ded05f483..4b1d0dcd105 100644 --- a/docs/channels/nostr.md +++ b/docs/channels/nostr.md @@ -8,25 +8,20 @@ title: "Nostr" # Nostr -**Status:** Optional plugin (disabled by default). +**Status:** Optional bundled plugin (disabled by default until configured). Nostr is a decentralized protocol for social networking. This channel enables OpenClaw to receive and respond to encrypted direct messages (DMs) via NIP-04. -## Install (on demand) +## Bundled plugin -### Onboarding (recommended) +Current OpenClaw releases ship Nostr as a bundled plugin, so normal packaged +builds do not need a separate install. -- Onboarding (`openclaw onboard`) and `openclaw channels add` list optional channel plugins. -- Selecting Nostr prompts you to install the plugin on demand. +### Older/custom installs -Install defaults: - -- **Dev channel + git checkout available:** uses the local plugin path. -- **Stable/Beta:** downloads from npm. - -You can always override the choice in the prompt. - -### Manual install +- Onboarding (`openclaw onboard`) and `openclaw channels add` still surface + Nostr from the shared channel catalog. +- If your build excludes bundled Nostr, install it manually. ```bash openclaw plugins install @openclaw/nostr diff --git a/docs/channels/synology-chat.md b/docs/channels/synology-chat.md index 1b633e9cd25..b9a11073b83 100644 --- a/docs/channels/synology-chat.md +++ b/docs/channels/synology-chat.md @@ -12,9 +12,13 @@ Status: supported via plugin as a direct-message channel using Synology Chat web The plugin accepts inbound messages from Synology Chat outgoing webhooks and sends replies through a Synology Chat incoming webhook. -## Plugin required +## Bundled plugin -Synology Chat is plugin-based and not part of the default core channel install. +Synology Chat ships as a bundled plugin in current OpenClaw releases, so normal +packaged builds do not need a separate install. + +If you are on an older build or a custom install that excludes Synology Chat, +install it manually: Install from a local checkout: @@ -26,7 +30,7 @@ Details: [Plugins](/tools/plugin) ## Quick setup -1. Install and enable the Synology Chat plugin. +1. Ensure the Synology Chat bundled plugin is available. - `openclaw onboard` now shows Synology Chat in the same channel setup list as `openclaw channels add`. - Non-interactive setup: `openclaw channels add --channel synology-chat --token --url ` 2. In Synology Chat integrations: diff --git a/docs/channels/tlon.md b/docs/channels/tlon.md index 095e48cbfe1..a558a7fdb15 100644 --- a/docs/channels/tlon.md +++ b/docs/channels/tlon.md @@ -14,9 +14,13 @@ be further restricted via allowlists. Status: supported via plugin. DMs, group mentions, thread replies, rich text formatting, and image uploads are supported. Reactions and polls are not yet supported. -## Plugin required +## Bundled plugin -Tlon ships as a plugin and is not bundled with the core install. +Tlon ships as a bundled plugin in current OpenClaw releases, so normal packaged +builds do not need a separate install. + +If you are on an older build or a custom install that excludes Tlon, install it +manually: Install via CLI (npm registry): @@ -34,7 +38,7 @@ Details: [Plugins](/tools/plugin) ## Setup -1. Install the Tlon plugin. +1. Ensure the Tlon bundled plugin is available. 2. Gather your ship URL and login code. 3. Configure `channels.tlon`. 4. Restart the gateway. diff --git a/docs/channels/twitch.md b/docs/channels/twitch.md index f1bd37f829f..b648c9945ae 100644 --- a/docs/channels/twitch.md +++ b/docs/channels/twitch.md @@ -9,9 +9,13 @@ title: "Twitch" Twitch chat support via IRC connection. OpenClaw connects as a Twitch user (bot account) to receive and send messages in channels. -## Plugin required +## Bundled plugin -Twitch ships as a plugin and is not bundled with the core install. +Twitch ships as a bundled plugin in current OpenClaw releases, so normal +packaged builds do not need a separate install. + +If you are on an older build or a custom install that excludes Twitch, install +it manually: Install via CLI (npm registry): diff --git a/docs/channels/zalo.md b/docs/channels/zalo.md index 147513fcae0..cf51de456f2 100644 --- a/docs/channels/zalo.md +++ b/docs/channels/zalo.md @@ -9,9 +9,13 @@ title: "Zalo" Status: experimental. DMs are supported. The [Capabilities](#capabilities) section below reflects current Marketplace-bot behavior. -## Plugin required +## Bundled plugin -Zalo ships as a plugin and is not bundled with the core install. +Zalo ships as a bundled plugin in current OpenClaw releases, so normal packaged +builds do not need a separate install. + +If you are on an older build or a custom install that excludes Zalo, install it +manually: - Install via CLI: `openclaw plugins install @openclaw/zalo` - Or select **Zalo** during setup and confirm the install prompt @@ -19,7 +23,7 @@ Zalo ships as a plugin and is not bundled with the core install. ## Quick setup (beginner) -1. Install the Zalo plugin: +1. Ensure the Zalo bundled plugin is available: - From a source checkout: `openclaw plugins install ./path/to/local/zalo-plugin` - From npm (if published): `openclaw plugins install @openclaw/zalo` - Or pick **Zalo** in setup and confirm the install prompt diff --git a/docs/channels/zalouser.md b/docs/channels/zalouser.md index ea981d7ef01..317b57722e0 100644 --- a/docs/channels/zalouser.md +++ b/docs/channels/zalouser.md @@ -12,9 +12,13 @@ Status: experimental. This integration automates a **personal Zalo account** via > **Warning:** This is an unofficial integration and may result in account suspension/ban. Use at your own risk. -## Plugin required +## Bundled plugin -Zalo Personal ships as a plugin and is not bundled with the core install. +Zalo Personal ships as a bundled plugin in current OpenClaw releases, so normal +packaged builds do not need a separate install. + +If you are on an older build or a custom install that excludes Zalo Personal, +install it manually: - Install via CLI: `openclaw plugins install @openclaw/zalouser` - Or from a source checkout: `openclaw plugins install ./path/to/local/zalouser-plugin` @@ -24,7 +28,7 @@ No external `zca`/`openzca` CLI binary is required. ## Quick setup (beginner) -1. Install the plugin (see above). +1. Ensure the bundled plugin is available (see above). 2. Login (QR, on the Gateway machine): - `openclaw channels login --channel zalouser` - Scan the QR code with the Zalo mobile app.