github/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-05-31 15:03:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs: document device pairing via Telegram

Browse Source
This commit is contained in:
Mariano Belinky
2026-02-08 09:08:55 +01:00
parent 57fc17892e
commit 14b91b0a6e
3 changed files with 31 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/channels/pairing.md
View File

@@ -52,6 +52,23 @@ Treat these as sensitive (they gate access to your assistant).
Nodes connect to the Gateway as **devices** with `role: node`. The Gateway
creates a device pairing request that must be approved.
### Pair via Telegram (recommended for iOS)
If you use the `device-pair` plugin, you can do first-time device pairing entirely from Telegram:
1. In Telegram, message your bot: `/pair`
2. The bot replies with two messages: an instruction message and a separate **setup code** message (easy to copy/paste in Telegram).
3. On your phone, open the OpenClaw iOS app → Settings → Gateway.
4. Paste the setup code and connect.
5. Back in Telegram: `/pair approve`
The setup code is a base64-encoded JSON payload that contains:
- `url`: the Gateway WebSocket URL (`ws://...` or `wss://...`)
- `token`: a short-lived pairing token
Treat the setup code like a password while it is valid.
### Approve a node device
```bash

11
docs/channels/telegram.md
View File

@@ -157,10 +157,21 @@ More help: [Channel troubleshooting](/channels/troubleshooting).
Notes:
- Custom commands are **menu entries only**; OpenClaw does not implement them unless you handle them elsewhere.
- Some commands can be handled by plugins/skills without being registered in Telegram’s command menu. These still work when typed (they just won't show up in `/commands` / the menu).
- Command names are normalized (leading `/` stripped, lowercased) and must match `a-z`, `0-9`, `_` (1–32 chars).
- Custom commands **cannot override native commands**. Conflicts are ignored and logged.
- If `commands.native` is disabled, only custom commands are registered (or cleared if none).
### Device pairing commands (`device-pair` plugin)
If the `device-pair` plugin is installed, it adds a Telegram-first flow for pairing a new phone:
1. `/pair` generates a setup code (sent as a separate message for easy copy/paste).
2. Paste the setup code in the iOS app to connect.
3. `/pair approve` approves the latest pending device request.
More details: [Pairing](/channels/pairing#pair-via-telegram-recommended-for-ios).
## Limits
- Outbound text is chunked to `channels.telegram.textChunkLimit` (default 4000).