docs: update all plugin docs to reflect bundled + auto-install

Updated docs for all bundled plugins to reflect:
- Plugins are bundled with Clawdbot
- Dependencies auto-install on first load when enabled
- npm install is an alternative, not required
- Simplified setup steps

Updated channels:
- line, matrix, mattermost, msteams, nextcloud-talk, nostr, zalo, zalouser

Updated plugins:
- voice-call, zalouser
This commit is contained in:
Hunter Miller 2026-01-26 12:55:13 -06:00
parent 3bf74611c2
commit 0b3f4a27ba
10 changed files with 170 additions and 112 deletions

View File

@ -16,20 +16,27 @@ Status: supported via plugin. Direct messages, group chats, media, locations, Fl
messages, template messages, and quick replies are supported. Reactions and threads messages, template messages, and quick replies are supported. Reactions and threads
are not supported. are not supported.
## Plugin required ## Plugin setup
Install the LINE plugin: LINE is bundled with Clawdbot. Its dependencies are automatically installed on first load
when you enable the plugin.
To enable, add `line` to your plugins allow list:
```json5
{
plugins: {
allow: ["line"]
}
}
```
Alternatively, install explicitly from npm:
```bash ```bash
clawdbot plugins install @clawdbot/line clawdbot plugins install @clawdbot/line
``` ```
Local checkout (when running from a git repo):
```bash
clawdbot plugins install ./extensions/line
```
## Setup ## Setup
1) Create a LINE Developers account and open the Console: 1) Create a LINE Developers account and open the Console:

View File

@ -13,32 +13,32 @@ but it requires E2EE to be enabled.
Status: supported via plugin (matrix-bot-sdk). Direct messages, rooms, threads, media, reactions, Status: supported via plugin (matrix-bot-sdk). Direct messages, rooms, threads, media, reactions,
polls (send + poll-start as text), location, and E2EE (with crypto support). polls (send + poll-start as text), location, and E2EE (with crypto support).
## Plugin required ## Plugin setup
Matrix ships as a plugin and is not bundled with the core install. Matrix is bundled with Clawdbot. Its dependencies are automatically installed on first load
when you enable the plugin.
Install via CLI (npm registry): To enable, add `matrix` to your plugins allow list:
```json5
{
plugins: {
allow: ["matrix"]
}
}
```
Alternatively, install explicitly from npm:
```bash ```bash
clawdbot plugins install @clawdbot/matrix clawdbot plugins install @clawdbot/matrix
``` ```
Local checkout (when running from a git repo):
```bash
clawdbot plugins install ./extensions/matrix
```
If you choose Matrix during configure/onboarding and a git checkout is detected,
Clawdbot will offer the local install path automatically.
Details: [Plugins](/plugin) Details: [Plugins](/plugin)
## Setup ## Setup
1) Install the Matrix plugin: 1) Add `matrix` to your plugins allow list (or install via CLI).
- From npm: `clawdbot plugins install @clawdbot/matrix`
- From a local checkout: `clawdbot plugins install ./extensions/matrix`
2) Create a Matrix account on a homeserver: 2) Create a Matrix account on a homeserver:
- Browse hosting options at [https://matrix.org/ecosystem/hosting/](https://matrix.org/ecosystem/hosting/) - Browse hosting options at [https://matrix.org/ecosystem/hosting/](https://matrix.org/ecosystem/hosting/)
- Or host it yourself. - Or host it yourself.

View File

@ -11,22 +11,29 @@ 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 is a self-hostable team messaging platform; see the official site at
[mattermost.com](https://mattermost.com) for product details and downloads. [mattermost.com](https://mattermost.com) for product details and downloads.
## Plugin required ## Plugin setup
Mattermost ships as a plugin and is not bundled with the core install.
Mattermost is bundled with Clawdbot. Its dependencies are automatically installed on first
load when you enable the plugin.
To enable, add `mattermost` to your plugins allow list:
```json5
{
plugins: {
allow: ["mattermost"]
}
}
```
The onboarding wizard and `clawdbot channels add` also offer to enable Mattermost.
Alternatively, install explicitly from npm:
Install via CLI (npm registry):
```bash ```bash
clawdbot plugins install @clawdbot/mattermost clawdbot plugins install @clawdbot/mattermost
``` ```
Local checkout (when running from a git repo):
```bash
clawdbot plugins install ./extensions/mattermost
```
If you choose Mattermost during configure/onboarding and a git checkout is detected,
Clawdbot will offer the local install path automatically.
Details: [Plugins](/plugin) Details: [Plugins](/plugin)
## Quick setup ## Quick setup

View File

@ -12,30 +12,34 @@ Updated: 2026-01-21
Status: text + DM attachments are supported; channel/group file sending requires `sharePointSiteId` + Graph permissions (see [Sending files in group chats](#sending-files-in-group-chats)). Polls are sent via Adaptive Cards. Status: text + DM attachments are supported; channel/group file sending requires `sharePointSiteId` + Graph permissions (see [Sending files in group chats](#sending-files-in-group-chats)). Polls are sent via Adaptive Cards.
## Plugin required ## Plugin setup
Microsoft Teams ships as a plugin and is not bundled with the core install.
**Breaking change (2026.1.15):** MS Teams moved out of core. If you use it, you must install the plugin. Microsoft Teams is bundled with Clawdbot. Its dependencies are automatically installed on
first load when you enable the plugin.
Explainable: keeps core installs lighter and lets MS Teams dependencies update independently. **Note (2026.1.15):** MS Teams is a plugin to keep core installs lighter and let its
dependencies update independently.
To enable, add `msteams` to your plugins allow list:
```json5
{
plugins: {
allow: ["msteams"]
}
}
```
Alternatively, install explicitly from npm:
Install via CLI (npm registry):
```bash ```bash
clawdbot plugins install @clawdbot/msteams clawdbot plugins install @clawdbot/msteams
``` ```
Local checkout (when running from a git repo):
```bash
clawdbot plugins install ./extensions/msteams
```
If you choose Teams during configure/onboarding and a git checkout is detected,
Clawdbot will offer the local install path automatically.
Details: [Plugins](/plugin) Details: [Plugins](/plugin)
## Quick setup (beginner) ## Quick setup (beginner)
1) Install the Microsoft Teams plugin. 1) Add `msteams` to your plugins allow list (or install via CLI).
2) Create an **Azure Bot** (App ID + client secret + tenant ID). 2) Create an **Azure Bot** (App ID + client secret + tenant ID).
3) Configure Clawdbot with those credentials. 3) Configure Clawdbot with those credentials.
4) Expose `/api/messages` (port 3978 by default) via a public URL or tunnel. 4) Expose `/api/messages` (port 3978 by default) via a public URL or tunnel.

View File

@ -7,22 +7,29 @@ read_when:
Status: supported via plugin (webhook bot). Direct messages, rooms, reactions, and markdown messages are supported. Status: supported via plugin (webhook bot). Direct messages, rooms, reactions, and markdown messages are supported.
## Plugin required ## Plugin setup
Nextcloud Talk ships as a plugin and is not bundled with the core install.
Nextcloud Talk is bundled with Clawdbot. Its dependencies are automatically installed on first
load when you enable the plugin.
To enable, add `nextcloud-talk` to your plugins allow list:
```json5
{
plugins: {
allow: ["nextcloud-talk"]
}
}
```
The onboarding wizard and `clawdbot channels add` also offer to enable Nextcloud Talk.
Alternatively, install explicitly from npm:
Install via CLI (npm registry):
```bash ```bash
clawdbot plugins install @clawdbot/nextcloud-talk clawdbot plugins install @clawdbot/nextcloud-talk
``` ```
Local checkout (when running from a git repo):
```bash
clawdbot plugins install ./extensions/nextcloud-talk
```
If you choose Nextcloud Talk during configure/onboarding and a git checkout is detected,
Clawdbot will offer the local install path automatically.
Details: [Plugins](/plugin) Details: [Plugins](/plugin)
## Quick setup (beginner) ## Quick setup (beginner)

View File

@ -10,33 +10,31 @@ read_when:
Nostr is a decentralized protocol for social networking. This channel enables Clawdbot to receive and respond to encrypted direct messages (DMs) via NIP-04. Nostr is a decentralized protocol for social networking. This channel enables Clawdbot to receive and respond to encrypted direct messages (DMs) via NIP-04.
## Install (on demand) ## Plugin setup
### Onboarding (recommended) Nostr is bundled with Clawdbot. Its dependencies are automatically installed on first load
when you enable the plugin.
- The onboarding wizard (`clawdbot onboard`) and `clawdbot channels add` list optional channel plugins. To enable, add `nostr` to your plugins allow list:
- Selecting Nostr prompts you to install the plugin on demand.
Install defaults: ```json5
{
plugins: {
allow: ["nostr"]
}
}
```
- **Dev channel + git checkout available:** uses the local plugin path. The onboarding wizard (`clawdbot onboard`) and `clawdbot channels add` also offer to enable
- **Stable/Beta:** downloads from npm. Nostr when you select it.
You can always override the choice in the prompt. Alternatively, install explicitly from npm:
### Manual install
```bash ```bash
clawdbot plugins install @clawdbot/nostr clawdbot plugins install @clawdbot/nostr
``` ```
Use a local checkout (dev workflows): Restart the Gateway after enabling plugins.
```bash
clawdbot plugins install --link <path-to-clawdbot>/extensions/nostr
```
Restart the Gateway after installing or enabling plugins.
## Quick setup ## Quick setup

View File

@ -7,17 +7,31 @@ read_when:
Status: experimental. Direct messages only; groups coming soon per Zalo docs. Status: experimental. Direct messages only; groups coming soon per Zalo docs.
## Plugin required ## Plugin setup
Zalo ships as a plugin and is not bundled with the core install.
- Install via CLI: `clawdbot plugins install @clawdbot/zalo` Zalo is bundled with Clawdbot. Its dependencies are automatically installed on first load
- Or select **Zalo** during onboarding and confirm the install prompt when you enable the plugin.
- Details: [Plugins](/plugin)
To enable, add `zalo` to your plugins allow list:
```json5
{
plugins: {
allow: ["zalo"]
}
}
```
Or select **Zalo** during onboarding. Alternatively, install explicitly from npm:
```bash
clawdbot plugins install @clawdbot/zalo
```
Details: [Plugins](/plugin)
## Quick setup (beginner) ## Quick setup (beginner)
1) Install the Zalo plugin: 1) Add `zalo` to your plugins allow list (or install via CLI/onboarding).
- From a source checkout: `clawdbot plugins install ./extensions/zalo`
- From npm (if published): `clawdbot plugins install @clawdbot/zalo`
- Or pick **Zalo** in onboarding and confirm the install prompt
2) Set the token: 2) Set the token:
- Env: `ZALO_BOT_TOKEN=...` - Env: `ZALO_BOT_TOKEN=...`
- Or config: `channels.zalo.botToken: "..."`. - Or config: `channels.zalo.botToken: "..."`.

View File

@ -10,11 +10,24 @@ 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. > **Warning:** This is an unofficial integration and may result in account suspension/ban. Use at your own risk.
## Plugin required ## Plugin setup
Zalo Personal ships as a plugin and is not bundled with the core install.
- Install via CLI: `clawdbot plugins install @clawdbot/zalouser` Zalo Personal is bundled with Clawdbot. Its dependencies are automatically installed on first
- Or from a source checkout: `clawdbot plugins install ./extensions/zalouser` load when you enable the plugin.
- Details: [Plugins](/plugin)
To enable, add `zalouser` to your plugins allow list:
```json5
{
plugins: {
allow: ["zalouser"]
}
}
```
Alternatively, install explicitly from npm: `clawdbot plugins install @clawdbot/zalouser`
Details: [Plugins](/plugin)
## Prerequisite: zca-cli ## Prerequisite: zca-cli
The Gateway machine must have the `zca` binary available in `PATH`. The Gateway machine must have the `zca` binary available in `PATH`.

View File

@ -28,9 +28,22 @@ The Voice Call plugin runs **inside the Gateway process**.
If you use a remote Gateway, install/configure the plugin on the **machine running the Gateway**, then restart the Gateway to load it. If you use a remote Gateway, install/configure the plugin on the **machine running the Gateway**, then restart the Gateway to load it.
## Install ## Plugin setup
### Option A: install from npm (recommended) Voice Call is bundled with Clawdbot. Its dependencies are automatically installed on first
load when you enable the plugin.
To enable, add `voice-call` to your plugins allow list:
```json5
{
plugins: {
allow: ["voice-call"]
}
}
```
Alternatively, install explicitly from npm:
```bash ```bash
clawdbot plugins install @clawdbot/voice-call clawdbot plugins install @clawdbot/voice-call
@ -38,15 +51,6 @@ clawdbot plugins install @clawdbot/voice-call
Restart the Gateway afterwards. Restart the Gateway afterwards.
### Option B: install from a local folder (dev, no copying)
```bash
clawdbot plugins install ./extensions/voice-call
cd ./extensions/voice-call && pnpm install
```
Restart the Gateway afterwards.
## Config ## Config
Set config under `plugins.entries.voice-call.config`: Set config under `plugins.entries.voice-call.config`:

View File

@ -19,9 +19,22 @@ This plugin runs **inside the Gateway process**.
If you use a remote Gateway, install/configure it on the **machine running the Gateway**, then restart the Gateway. If you use a remote Gateway, install/configure it on the **machine running the Gateway**, then restart the Gateway.
## Install ## Plugin setup
### Option A: install from npm Zalo Personal is bundled with Clawdbot. Its dependencies are automatically installed on first
load when you enable the plugin.
To enable, add `zalouser` to your plugins allow list:
```json5
{
plugins: {
allow: ["zalouser"]
}
}
```
Alternatively, install explicitly from npm:
```bash ```bash
clawdbot plugins install @clawdbot/zalouser clawdbot plugins install @clawdbot/zalouser
@ -29,15 +42,6 @@ clawdbot plugins install @clawdbot/zalouser
Restart the Gateway afterwards. Restart the Gateway afterwards.
### Option B: install from a local folder (dev)
```bash
clawdbot plugins install ./extensions/zalouser
cd ./extensions/zalouser && pnpm install
```
Restart the Gateway afterwards.
## Prerequisite: zca-cli ## Prerequisite: zca-cli
The Gateway machine must have `zca` on `PATH`: The Gateway machine must have `zca` on `PATH`: