openclaw-rocketchat 0.7.4 β 0.7.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.en.md +32 -736
- package/README.md +32 -735
- package/package.json +1 -1
package/README.en.md
CHANGED
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
|
|
20
20
|
</div>
|
|
21
21
|
|
|
22
|
-
> **π Docs:** [
|
|
22
|
+
> **π Docs:** [Guide](docs/GUIDE.en.md) Β· [FAQ](docs/FAQ.en.md) Β· [Configuration](docs/CONFIGURATION.en.md) Β· [Architecture](docs/ARCHITECTURE.en.md) Β· [Security](docs/SECURITY.en.md)
|
|
23
23
|
|
|
24
24
|
---
|
|
25
25
|
|
|
@@ -40,180 +40,20 @@ And there's a deeper problem: **even if these platforms work, your AI conversati
|
|
|
40
40
|
|
|
41
41
|
> **What is Rocket.Chat?** [Rocket.Chat](https://www.rocket.chat/) is the world's largest open-source enterprise messaging platform, used by 12M+ users globally. Think of it as a self-hosted Slack/Teams you can run on your own server β polished UI, full-featured, multi-platform (phone/desktop/web), and downloadable from China's App Store.
|
|
42
42
|
|
|
43
|
-
This plugin connects OpenClaw to **Rocket.Chat**.
|
|
44
|
-
|
|
45
|
-
One command to deploy. Three steps to start chatting. Two deployment modes:
|
|
46
|
-
|
|
47
|
-
**Mode A: Co-located (Recommended)**
|
|
48
|
-
|
|
49
|
-
```
|
|
50
|
-
Your Phone (Rocket.Chat App)
|
|
51
|
-
β Direct IP Connection
|
|
52
|
-
Your Machine (Rocket.Chat + OpenClaw)
|
|
53
|
-
β localhost
|
|
54
|
-
AI Brain (OpenClaw Agent)
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
**Mode B: Split Deployment (Home network / Low-spec server friendly)**
|
|
58
|
-
|
|
59
|
-
```
|
|
60
|
-
Your Phone (Rocket.Chat App)
|
|
61
|
-
β Public IP
|
|
62
|
-
Cloud VPS (Rocket.Chat + MongoDB only)
|
|
63
|
-
β Plugin connects via public network
|
|
64
|
-
Home / Local (OpenClaw + this plugin)
|
|
65
|
-
β localhost
|
|
66
|
-
AI Brain (OpenClaw Agent)
|
|
67
|
-
```
|
|
68
|
-
|
|
69
|
-
> Mode B is great for: OpenClaw on home LAN without public IP, low-memory servers, or companies with existing RC instances.
|
|
70
|
-
> Install RC on remote VPS with one command: `curl -fsSL https://raw.githubusercontent.com/Kxiandaoyan/openclaw-rocketchat/master/install-rc.sh | bash`
|
|
71
|
-
|
|
72
|
-
**Either way, your AI data never passes through third parties.**
|
|
43
|
+
This plugin connects OpenClaw to **Rocket.Chat**. One command to deploy. Three steps to start chatting. **Your AI data never passes through third parties.**
|
|
73
44
|
|
|
74
45
|
## Ten Advantages
|
|
75
46
|
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
**You never miss an important AI response.**
|
|
87
|
-
|
|
88
|
-
### 3. π Complete Data Sovereignty
|
|
89
|
-
|
|
90
|
-
| Using Telegram | Using This Plugin |
|
|
91
|
-
|---|---|
|
|
92
|
-
| Messages go through Telegram's servers | Messages stay on your machine |
|
|
93
|
-
| Chat history stored on someone else's cloud | Chat history in your own MongoDB |
|
|
94
|
-
| You can't control where data goes | Docker volume is yours β delete anytime |
|
|
95
|
-
| Terms of service change without notice | You are the terms of service |
|
|
96
|
-
|
|
97
|
-
**Zero trust in third parties. Your AI conversations, private data, and work content stay on your own hard drive.**
|
|
98
|
-
|
|
99
|
-
### 4. π¨π³ Works Perfectly in Mainland China
|
|
100
|
-
|
|
101
|
-
- Rocket.Chat App is **directly downloadable** from China App Store / Google Play
|
|
102
|
-
- Server runs on your own machine β **no cross-border traffic**
|
|
103
|
-
- Auto **sslip.io free domain** + auto **Let's Encrypt HTTPS cert** β no domain purchase, no ICP registration needed
|
|
104
|
-
- Zero dependency on blocked services
|
|
105
|
-
|
|
106
|
-
### 5. β‘ One-Command Deployment, Two Modes
|
|
107
|
-
|
|
108
|
-
No 10-page documentation to read. No browser-based admin panels to click through. No manual JSON editing.
|
|
109
|
-
|
|
110
|
-
```bash
|
|
111
|
-
openclaw rocketchat setup
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
An interactive wizard guides you through everything β Docker deployment, account creation, config writing β all in one go.
|
|
115
|
-
|
|
116
|
-
Choose the deployment mode that fits your situation:
|
|
117
|
-
|
|
118
|
-
| | Co-located | Split Deployment |
|
|
119
|
-
|---|---|---|
|
|
120
|
-
| **Who it's for** | Users with a public server | Home network, low-spec servers |
|
|
121
|
-
| **RC runs on** | Same machine as OpenClaw | Separate cloud VPS |
|
|
122
|
-
| **How to install** | `install-rc.sh` + `openclaw rocketchat setup` | `install-rc.sh` on VPS, connect locally |
|
|
123
|
-
| **Advantage** | Simplest, one machine | OpenClaw can run at home, RC in the cloud |
|
|
124
|
-
|
|
125
|
-
> Split deployment means even if your OpenClaw is on a **home LAN without a public IP**, a cheap VPS (1 core, 1 GB RAM is enough) lets your phone connect from anywhere.
|
|
126
|
-
|
|
127
|
-
### 6. π€ Multi-Agent, Multi-Bot
|
|
128
|
-
|
|
129
|
-
Create multiple Agents in OpenClaw (e.g., "Personal Assistant", "Work Helper", "Code Reviewer"), each appearing as a separate bot in Rocket.Chat:
|
|
130
|
-
|
|
131
|
-
```
|
|
132
|
-
Conversation List
|
|
133
|
-
π¦ Lobster β DM: Personal assistant
|
|
134
|
-
πΌ Work Helper β DM: Work agent
|
|
135
|
-
π AI Squad β Group: All bots together
|
|
136
|
-
π Code Review β Group: Dedicated code agent
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
**DMs and group chats coexist** β ask simple questions via DM, tackle complex problems in groups with multiple bots collaborating.
|
|
140
|
-
|
|
141
|
-
### 7. π₯ Team Collaboration β Share AI Across Your Whole Team
|
|
142
|
-
|
|
143
|
-
This isn't just a single-user AI tool β your entire team can use it together.
|
|
144
|
-
|
|
145
|
-
```
|
|
146
|
-
γProduct Discussionγ
|
|
147
|
-
π€ Alice (Product Manager)
|
|
148
|
-
π€ Bob (Designer)
|
|
149
|
-
π€ Charlie (Developer)
|
|
150
|
-
π€ Lobster (AI Assistant)
|
|
151
|
-
|
|
152
|
-
Alice: Can you analyze the technical feasibility of this feature?
|
|
153
|
-
π¦ Lobster: Based on the requirements, I've analyzed three aspects...
|
|
154
|
-
Bob: @Lobster Any color scheme suggestions?
|
|
155
|
-
π¦ Lobster: From a UI/UX perspective, I recommend...
|
|
156
|
-
Charlie: How long would this take to implement?
|
|
157
|
-
π¦ Lobster: Based on the current tech stack, estimated...
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
One deployment, the whole team benefits:
|
|
161
|
-
|
|
162
|
-
- **Companies/Teams** β Everyone discusses with AI in the same group, stay aligned, no relay needed
|
|
163
|
-
- **Families** β Add an account for each family member, everyone gets their own AI assistant
|
|
164
|
-
- **Studios** β Different projects get different groups, each with specialized Agents
|
|
165
|
-
- **Education** β Teachers and students in the same group, AI-assisted learning
|
|
166
|
-
|
|
167
|
-
`openclaw rocketchat add-user` adds a new member in one command, `openclaw rocketchat invite` pulls them into any group. **No per-person deployment, no per-person configuration β one service for everyone.**
|
|
168
|
-
|
|
169
|
-
### 8. π Fine-Grained Permission Control
|
|
170
|
-
|
|
171
|
-
Not everyone needs to talk to AI β some people just need to watch.
|
|
172
|
-
|
|
173
|
-
| Permission | View Messages | Send Messages | DM Bots | Use Case |
|
|
174
|
-
|---|---|---|---|---|
|
|
175
|
-
| **Full Access** | β
| β
| β
| Regular team members |
|
|
176
|
-
| **Read-Only** | β
| β | β | Boss monitoring, auditing, observers |
|
|
177
|
-
|
|
178
|
-
Typical scenarios:
|
|
179
|
-
- **Boss/Manager** β Read-only, review team-AI conversations anytime, track project progress
|
|
180
|
-
- **Interns** β Read-only, observe senior staff's AI discussions, learn and grow
|
|
181
|
-
- **Clients** β Read-only, see AI-generated analysis reports without interfering
|
|
182
|
-
- **Audit/Compliance** β Read-only, monitor AI usage for regulatory compliance
|
|
183
|
-
|
|
184
|
-
```bash
|
|
185
|
-
openclaw rocketchat add-user
|
|
186
|
-
# Choose during setup:
|
|
187
|
-
# 1) Full access β can send messages in groups and DM bots
|
|
188
|
-
# 2) Read-only β can only view group messages, no sending or DM
|
|
189
|
-
```
|
|
190
|
-
|
|
191
|
-
**No other platform offers this** β on Telegram or WhatsApp, users either see everything and can say everything, or see nothing at all.
|
|
192
|
-
|
|
193
|
-
### 9. π± Cross-Platform
|
|
194
|
-
|
|
195
|
-
Official Rocket.Chat clients: [rocket.chat/download-apps](https://www.rocket.chat/download-apps)
|
|
196
|
-
|
|
197
|
-
| Platform | How to Download |
|
|
198
|
-
|---|---|
|
|
199
|
-
| **iOS** | Search **"Rocket.Chat"** on App Store (developer: Rocket.Chat Technologies Corp)<br>Available in China App Store β no account switching needed |
|
|
200
|
-
| **Android** | Search **"Rocket.Chat"** on Google Play, or download APK from the official site |
|
|
201
|
-
| **macOS** | [Mac App Store](https://apps.apple.com/app/rocket-chat/id1148741252) or [download .dmg](https://www.rocket.chat/download-apps) |
|
|
202
|
-
| **Windows** | [Download installer](https://www.rocket.chat/download-apps) |
|
|
203
|
-
| **Linux** | [Download](https://www.rocket.chat/download-apps) (.deb / .rpm / Snap) |
|
|
204
|
-
| **Web** | No download needed β open `https://YOUR-IP.sslip.io` in any browser |
|
|
205
|
-
|
|
206
|
-
> π‘ **Search tip**: In App Store / Google Play, search "Rocket.Chat" and look for the developer **Rocket.Chat Technologies Corp**.
|
|
207
|
-
|
|
208
|
-
Deploy once, access from phone, computer, tablet, or browser. Messages sync across all devices in real time.
|
|
209
|
-
|
|
210
|
-
### 10. π Completely Free, Open Source, No Vendor Lock-In
|
|
211
|
-
|
|
212
|
-
- No subscription fees, no message limits, no feature restrictions
|
|
213
|
-
- MIT license β modify as you wish
|
|
214
|
-
- Built on Rocket.Chat's open-source ecosystem with an active community
|
|
215
|
-
- **No vendor lock-in** β export your data anytime (standard MongoDB format)
|
|
216
|
-
- You're running a standard Rocket.Chat server β plug in more features in the future (video calls, file sharing, webhook integrations, etc.)
|
|
47
|
+
- π **Dedicated AI Workspace** β Open Rocket.Chat and see only your AI assistants, no social noise
|
|
48
|
+
- π **Dedicated Push Notifications** β AI messages aren't buried in other app notifications
|
|
49
|
+
- π **Complete Data Sovereignty** β Messages stay on your server, never touch third parties
|
|
50
|
+
- π¨π³ **Works Perfectly in China** β Direct App Store download, no VPN, auto free domain + HTTPS cert
|
|
51
|
+
- β‘ **One-Command Deployment** β Interactive wizard handles Docker, accounts, and config in one go
|
|
52
|
+
- π€ **Multi-Agent, Multi-Bot** β Each Agent maps to a dedicated Rocket.Chat bot
|
|
53
|
+
- π₯ **Team Collaboration** β Share AI across your whole team in the same group
|
|
54
|
+
- π **Fine-Grained Permissions** β Full access / read-only roles for different team members
|
|
55
|
+
- π± **Cross-Platform** β iOS, Android, macOS, Windows, Linux, Web β real-time sync across all devices
|
|
56
|
+
- π **Free & Open Source** β MIT license, no subscriptions, no message limits, no vendor lock-in
|
|
217
57
|
|
|
218
58
|
### Technical Features (v0.7.1)
|
|
219
59
|
|
|
@@ -232,8 +72,6 @@ Deploy once, access from phone, computer, tablet, or browser. Messages sync acro
|
|
|
232
72
|
|
|
233
73
|
## Comparison
|
|
234
74
|
|
|
235
|
-
> Full comparison table at [docs/ARCHITECTURE.en.md](docs/ARCHITECTURE.en.md)
|
|
236
|
-
|
|
237
75
|
| | Feishu | Telegram | WhatsApp | This Plugin |
|
|
238
76
|
|---|---|---|---|---|
|
|
239
77
|
| **China Available** | β
| β VPN needed | β Foreign # needed | β
|
|
|
@@ -242,147 +80,28 @@ Deploy once, access from phone, computer, tablet, or browser. Messages sync acro
|
|
|
242
80
|
| **Multi-User Team** | Enterprise only | β | β | β
One deploy for all |
|
|
243
81
|
| **Free & Open Source** | β | β | β | β
MIT |
|
|
244
82
|
|
|
245
|
-
|
|
83
|
+
> Full comparison table at [docs/ARCHITECTURE.en.md](docs/ARCHITECTURE.en.md)
|
|
246
84
|
|
|
247
|
-
|
|
85
|
+
## Quick Start (3 Steps)
|
|
248
86
|
|
|
249
|
-
|
|
250
|
-
- A server with a **public IP** (AWS, DigitalOcean, etc.)
|
|
251
|
-
- Firewall / security group allows **port 443** (HTTPS)
|
|
87
|
+
> **Full walkthrough with terminal output examples: [Usage Guide](docs/GUIDE.en.md)**
|
|
252
88
|
|
|
253
89
|
### Step 1: Deploy Rocket.Chat
|
|
254
90
|
|
|
255
|
-
Run the one-click install script on your server (works for both local and remote):
|
|
256
|
-
|
|
257
|
-
```bash
|
|
258
|
-
bash install-rc.sh
|
|
259
|
-
```
|
|
260
|
-
|
|
261
|
-
Or install remotely without downloading first:
|
|
262
|
-
|
|
263
91
|
```bash
|
|
264
92
|
curl -fsSL https://raw.githubusercontent.com/Kxiandaoyan/openclaw-rocketchat/master/install-rc.sh | bash
|
|
265
93
|
```
|
|
266
94
|
|
|
267
|
-
The script
|
|
268
|
-
- Detect and install Docker (if not present)
|
|
269
|
-
- Deploy Rocket.Chat + MongoDB + Nginx (all Docker containers)
|
|
270
|
-
- Auto-configure **sslip.io free domain** (e.g. `123-45-67-89.sslip.io`)
|
|
271
|
-
- Auto-obtains **Let's Encrypt HTTPS cert** via acme.sh (auto-renewal every 60 days)
|
|
272
|
-
- Disable email two-factor auth (no mail server on self-hosted)
|
|
273
|
-
- Rocket.Chat communicates internally only β **port 3000 is not exposed to the public**
|
|
274
|
-
|
|
275
|
-
You'll see:
|
|
276
|
-
|
|
277
|
-
```
|
|
278
|
-
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
279
|
-
β Rocket.Chat One-Click Install (HTTPS + OpenClaw) β
|
|
280
|
-
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
281
|
-
|
|
282
|
-
β³ Detecting Docker...
|
|
283
|
-
β
Docker installed (v29.2.1)
|
|
284
|
-
β
Docker Compose installed (v5.0.2)
|
|
285
|
-
β
Port 443 available
|
|
286
|
-
β³ Getting server public IP...
|
|
287
|
-
β
Public IP: 123.45.67.89
|
|
288
|
-
β³ Configuring sslip.io domain: 123-45-67-89.sslip.io
|
|
289
|
-
β³ Requesting Let's Encrypt certificate...
|
|
290
|
-
β
Let's Encrypt certificate obtained! (auto-renew enabled)
|
|
291
|
-
β³ Generating Nginx config...
|
|
292
|
-
β
Nginx config generated
|
|
293
|
-
β³ Generating docker-compose.yml...
|
|
294
|
-
β
Config generated
|
|
295
|
-
β³ Pulling images & starting (first time ~2-5 min)...
|
|
296
|
-
β
Rocket.Chat is ready!
|
|
297
|
-
|
|
298
|
-
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
299
|
-
β π Rocket.Chat installed! β
|
|
300
|
-
ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
|
301
|
-
|
|
302
|
-
Domain: 123-45-67-89.sslip.io (auto-configured via sslip.io)
|
|
303
|
-
Address: https://123-45-67-89.sslip.io
|
|
304
|
-
HTTPS: β
Let's Encrypt certificate (trusted, zero warnings)
|
|
305
|
-
|
|
306
|
-
π Admin credentials (strong password auto-generated):
|
|
307
|
-
Username: admin
|
|
308
|
-
Password: Kx8mVp2dRfT7nQwL3s9A
|
|
309
|
-
(Saved to ~/rocketchat/.rc-info β setup will auto-read it.
|
|
310
|
-
Regular users don't need this account β it's for server administration only.)
|
|
311
|
-
|
|
312
|
-
Install info saved to: ~/rocketchat/.rc-info
|
|
313
|
-
|
|
314
|
-
π Next steps:
|
|
315
|
-
1οΈβ£ Make sure firewall allows ports 443 and 80
|
|
316
|
-
2οΈβ£ Install plugin and configure:
|
|
317
|
-
openclaw plugins install openclaw-rocketchat
|
|
318
|
-
openclaw rocketchat setup
|
|
319
|
-
π‘ On the same machine, setup auto-detects install info β no manual input needed!
|
|
320
|
-
3οΈβ£ Add an AI bot:
|
|
321
|
-
openclaw rocketchat add-bot
|
|
322
|
-
```
|
|
323
|
-
|
|
324
|
-
> No Docker? The script auto-installs it.
|
|
95
|
+
The script auto-handles Docker deployment, free domain, and HTTPS certificate.
|
|
325
96
|
|
|
326
|
-
### Step 2: Install Plugin + Configure
|
|
327
|
-
|
|
328
|
-
Back on your OpenClaw machine:
|
|
97
|
+
### Step 2: Install Plugin + Configure
|
|
329
98
|
|
|
330
99
|
```bash
|
|
331
100
|
openclaw plugins install openclaw-rocketchat
|
|
332
101
|
openclaw rocketchat setup
|
|
333
102
|
```
|
|
334
103
|
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
```
|
|
338
|
-
=== Rocket.Chat Setup Wizard ===
|
|
339
|
-
|
|
340
|
-
β
Detected local Rocket.Chat installation
|
|
341
|
-
Server URL: https://123-45-67-89.sslip.io
|
|
342
|
-
Domain: 123-45-67-89.sslip.io
|
|
343
|
-
Admin: admin
|
|
344
|
-
|
|
345
|
-
Use detected info for auto-configuration? (recommended) (Y/n): Y
|
|
346
|
-
|
|
347
|
-
Using detected server address: https://123-45-67-89.sslip.io
|
|
348
|
-
β³ Testing connection to https://123-45-67-89.sslip.io ...
|
|
349
|
-
β
Connected! Rocket.Chat version: 8.1.0
|
|
350
|
-
|
|
351
|
-
β³ Creating admin (internal, you don't need to remember)...
|
|
352
|
-
Default admin password changed to strong random password (secure)
|
|
353
|
-
Public registration disabled (secure)
|
|
354
|
-
β
Admin ready
|
|
355
|
-
|
|
356
|
-
Create your phone login account
|
|
357
|
-
Username: zhangsan
|
|
358
|
-
Password: ********
|
|
359
|
-
Confirm: ********
|
|
360
|
-
|
|
361
|
-
β³ Creating account zhangsan...
|
|
362
|
-
β
Account zhangsan created
|
|
363
|
-
β³ Writing openclaw.json config...
|
|
364
|
-
β
Config saved
|
|
365
|
-
|
|
366
|
-
ββββββββββββββββββββββββββββββββββββββββββββ
|
|
367
|
-
β π Setup complete! β
|
|
368
|
-
ββββββββββββββββββββββββββββββββββββββββββββ
|
|
369
|
-
|
|
370
|
-
π± Phone setup:
|
|
371
|
-
1. Download "Rocket.Chat" from App Store
|
|
372
|
-
2. Open the app, server address: https://123-45-67-89.sslip.io
|
|
373
|
-
HTTPS cert is trusted β no warnings, connects directly
|
|
374
|
-
3. Username: zhangsan
|
|
375
|
-
4. Password: the one you just set
|
|
376
|
-
|
|
377
|
-
π‘ About the admin or rc-admin user you may see in the App:
|
|
378
|
-
This is Rocket.Chat's internal admin account, auto-created by setup,
|
|
379
|
-
used to manage bots and users. You can ignore it β don't delete it.
|
|
380
|
-
|
|
381
|
-
π₯ Important: Make sure your server firewall allows ports 443 and 80
|
|
382
|
-
|
|
383
|
-
π‘ Next: openclaw rocketchat add-bot
|
|
384
|
-
```
|
|
385
|
-
|
|
104
|
+
Interactive wizard guides you through connection and account creation. On the same machine, it auto-detects install info.
|
|
386
105
|
|
|
387
106
|
### Step 3: Add an AI Bot
|
|
388
107
|
|
|
@@ -390,49 +109,14 @@ Confirm: ********
|
|
|
390
109
|
openclaw rocketchat add-bot
|
|
391
110
|
```
|
|
392
111
|
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
```
|
|
396
|
-
=== Add Rocket.Chat Bot ===
|
|
397
|
-
|
|
398
|
-
Bot username: molty
|
|
399
|
-
Display name [default molty]: Lobster
|
|
400
|
-
|
|
401
|
-
Bind to which Agent?
|
|
402
|
-
Available Agents:
|
|
403
|
-
1) main (default)
|
|
404
|
-
2) work (Work Helper)
|
|
405
|
-
Select: 1
|
|
406
|
-
|
|
407
|
-
β³ Creating bot user molty...
|
|
408
|
-
β
Bot user molty created
|
|
409
|
-
β³ Establishing DM between zhangsan and molty...
|
|
410
|
-
β
DM ready
|
|
411
|
-
β³ Writing config + binding...
|
|
412
|
-
β
Config updated
|
|
413
|
-
|
|
414
|
-
β
Bot molty (Lobster) created
|
|
415
|
-
Bound to Agent: main
|
|
416
|
-
DM ready
|
|
417
|
-
|
|
418
|
-
π± Open Rocket.Chat App to chat with the bot:
|
|
419
|
-
If you don't see ε°ιΎθΎ in your conversation list, tap the search icon
|
|
420
|
-
in the top-left corner and type "molty" to find and start a DM.
|
|
421
|
-
```
|
|
422
|
-
|
|
423
|
-
**Type a bot name, pick an Agent number, done.**
|
|
112
|
+
Type a bot name, pick an Agent, done.
|
|
424
113
|
|
|
425
114
|
### Step 4: Download Rocket.Chat on Your Phone, Start Chatting
|
|
426
115
|
|
|
427
|
-
1.
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
2. Open the app, tap **"Add Server"**, enter: `https://YOUR-IP.sslip.io`
|
|
432
|
-
3. Login with the credentials from Step 1
|
|
433
|
-
4. If you don't see the bot in your conversation list, tap the search icon in the top-left corner, type the bot's username to find and start chatting!
|
|
434
|
-
|
|
435
|
-
**That's it. 3 commands + download an app. You're done.**
|
|
116
|
+
1. Search **"Rocket.Chat"** on App Store / Google Play
|
|
117
|
+
2. Open the app, enter server address (e.g. `https://123-45-67-89.sslip.io`)
|
|
118
|
+
3. Login with your credentials from Step 2
|
|
119
|
+
4. Find your bot and start chatting!
|
|
436
120
|
|
|
437
121
|
### π± Mobile App Screenshots
|
|
438
122
|
|
|
@@ -445,419 +129,31 @@ Bind to which Agent?
|
|
|
445
129
|
|
|
446
130
|
> **Highlight**: Code blocks in AI replies are **automatically syntax-highlighted and beautifully formatted** in Rocket.Chat App β unlike WeChat/DingTalk/Slack where code gets squished into unreadable blobs. A much better experience for developers and technical users.
|
|
447
131
|
|
|
448
|
-
---
|
|
449
|
-
|
|
450
|
-
### More Features
|
|
451
|
-
|
|
452
|
-
These commands are optional β use them when you need them:
|
|
453
|
-
|
|
454
|
-
<details>
|
|
455
|
-
<summary><b>Remote Rocket.Chat installation (split deployment)</b></summary>
|
|
456
|
-
|
|
457
|
-
If you chose Mode B (split deployment), run on your remote VPS:
|
|
458
|
-
|
|
459
|
-
```bash
|
|
460
|
-
# SSH into your VPS, then one-click install:
|
|
461
|
-
curl -fsSL https://raw.githubusercontent.com/Kxiandaoyan/openclaw-rocketchat/master/install-rc.sh | bash
|
|
462
|
-
```
|
|
463
|
-
|
|
464
|
-
The script will automatically:
|
|
465
|
-
- Detect and install Docker (if not present)
|
|
466
|
-
- Deploy Rocket.Chat + MongoDB + Nginx (HTTPS)
|
|
467
|
-
- Auto-configure **sslip.io free domain** + request **Let's Encrypt** cert via acme.sh (the script will show a clear error message if acquisition fails)
|
|
468
|
-
- Start services and wait until ready
|
|
469
|
-
- Output the `https://VPS-IP.sslip.io` address and next steps
|
|
470
|
-
|
|
471
|
-
After installation, go back to your OpenClaw machine and run `openclaw rocketchat setup`, enter `https://VPS-IP.sslip.io`.
|
|
472
|
-
|
|
473
|
-
</details>
|
|
474
|
-
|
|
475
|
-
<details>
|
|
476
|
-
<summary><b>Create multi-bot group</b></summary>
|
|
477
|
-
|
|
478
|
-
```bash
|
|
479
|
-
openclaw rocketchat add-group
|
|
480
|
-
```
|
|
481
|
-
|
|
482
|
-
```
|
|
483
|
-
=== Create Rocket.Chat Private Channel ===
|
|
484
|
-
|
|
485
|
-
Channel name: AI Squad
|
|
486
|
-
|
|
487
|
-
Add which bots?
|
|
488
|
-
Available bots:
|
|
489
|
-
1) molty (Lobster) -> Agent: main
|
|
490
|
-
2) work-claw (Work Helper) -> Agent: work
|
|
491
|
-
Select (comma-separated): 1,2
|
|
492
|
-
|
|
493
|
-
Add which users?
|
|
494
|
-
Available users:
|
|
495
|
-
1) zhangsan
|
|
496
|
-
Select (comma-separated, Enter for all):
|
|
497
|
-
|
|
498
|
-
Require @mention to respond? [y/N]: n
|
|
499
|
-
|
|
500
|
-
β
Channel "AI Squad" created
|
|
501
|
-
Members: zhangsan, molty, work-claw
|
|
502
|
-
```
|
|
503
|
-
|
|
504
|
-
</details>
|
|
505
|
-
|
|
506
|
-
<details>
|
|
507
|
-
<summary><b>Add more phone users (family, colleagues)</b></summary>
|
|
508
|
-
|
|
509
|
-
```bash
|
|
510
|
-
openclaw rocketchat add-user
|
|
511
|
-
```
|
|
512
|
-
|
|
513
|
-
```
|
|
514
|
-
=== Add Phone Login User ===
|
|
515
|
-
|
|
516
|
-
Username: lisi
|
|
517
|
-
Password: ********
|
|
518
|
-
Confirm: ********
|
|
519
|
-
|
|
520
|
-
User permission:
|
|
521
|
-
1) Full access β can send messages in groups and DM bots
|
|
522
|
-
2) Read-only β can only view group messages, no sending or DM
|
|
523
|
-
Choose: 1
|
|
524
|
-
|
|
525
|
-
Join existing groups?
|
|
526
|
-
Available groups:
|
|
527
|
-
1) AI Squad (bots: molty, work-claw)
|
|
528
|
-
Select (comma-separated): 1
|
|
529
|
-
|
|
530
|
-
β
User lisi created (full access)
|
|
531
|
-
Permission: β
Full access
|
|
532
|
-
Joined: AI Squad
|
|
533
|
-
Login: https://123-45-67-89.sslip.io / Username: lisi
|
|
534
|
-
|
|
535
|
-
π± Tell lisi to download Rocket.Chat App, server: https://123-45-67-89.sslip.io
|
|
536
|
-
Login with the username and password above, then:
|
|
537
|
-
- Discuss with AI together in "AI Squad" group
|
|
538
|
-
- DM any bot directly for one-on-one AI conversations
|
|
539
|
-
```
|
|
540
|
-
|
|
541
|
-
> **Read-only mode** is great for bosses monitoring progress, auditing, or observing. Read-only users can see all group messages but can't send messages or DM bots.
|
|
542
|
-
|
|
543
|
-
</details>
|
|
544
|
-
|
|
545
|
-
<details>
|
|
546
|
-
<summary><b>Remove a user</b></summary>
|
|
547
|
-
|
|
548
|
-
```bash
|
|
549
|
-
openclaw rocketchat remove-user
|
|
550
|
-
```
|
|
551
|
-
|
|
552
|
-
```
|
|
553
|
-
=== Remove Phone User ===
|
|
554
|
-
|
|
555
|
-
Select user to remove:
|
|
556
|
-
1) lisi
|
|
557
|
-
2) wangwu
|
|
558
|
-
Choose: 1
|
|
559
|
-
|
|
560
|
-
β οΈ About to delete user lisi β this cannot be undone!
|
|
561
|
-
The user will be permanently removed from Rocket.Chat,
|
|
562
|
-
removed from all groups, and DM history will be lost.
|
|
563
|
-
|
|
564
|
-
Confirm delete lisi? [y/N]: y
|
|
565
|
-
|
|
566
|
-
β³ Removing from "AI Squad"...
|
|
567
|
-
β
Removed from "AI Squad"
|
|
568
|
-
β³ Deleting user lisi from Rocket.Chat...
|
|
569
|
-
β
User lisi deleted from Rocket.Chat
|
|
570
|
-
β³ Cleaning local records...
|
|
571
|
-
β
Local records cleaned
|
|
572
|
-
|
|
573
|
-
β
User lisi completely deleted
|
|
574
|
-
Their Rocket.Chat App will no longer be able to log in.
|
|
575
|
-
```
|
|
576
|
-
|
|
577
|
-
</details>
|
|
578
|
-
|
|
579
|
-
<details>
|
|
580
|
-
<summary><b>Manage group members</b></summary>
|
|
581
|
-
|
|
582
|
-
```bash
|
|
583
|
-
openclaw rocketchat invite
|
|
584
|
-
```
|
|
585
|
-
|
|
586
|
-
```
|
|
587
|
-
=== Group Member Management ===
|
|
588
|
-
|
|
589
|
-
Select group:
|
|
590
|
-
1) AI Squad
|
|
591
|
-
Choose: 1
|
|
592
|
-
|
|
593
|
-
Action:
|
|
594
|
-
1) Invite user to group
|
|
595
|
-
2) Remove user
|
|
596
|
-
3) Set as admin (Moderator)
|
|
597
|
-
4) Set as owner (Owner)
|
|
598
|
-
5) Back
|
|
599
|
-
Choose: 1
|
|
600
|
-
|
|
601
|
-
Invite who?
|
|
602
|
-
1) lisi
|
|
603
|
-
2) wangwu
|
|
604
|
-
Choose: 1
|
|
605
|
-
|
|
606
|
-
β³ Inviting lisi...
|
|
607
|
-
β
lisi has joined "AI Squad"
|
|
608
|
-
```
|
|
609
|
-
|
|
610
|
-
</details>
|
|
611
|
-
|
|
612
|
-
<details>
|
|
613
|
-
<summary><b>Check running status</b></summary>
|
|
614
|
-
|
|
615
|
-
```bash
|
|
616
|
-
openclaw rocketchat status
|
|
617
|
-
```
|
|
618
|
-
|
|
619
|
-
```
|
|
620
|
-
=== Rocket.Chat Status ===
|
|
621
|
-
|
|
622
|
-
Server: Running - https://123-45-67-89.sslip.io
|
|
623
|
-
MongoDB: Running
|
|
624
|
-
|
|
625
|
-
Users
|
|
626
|
-
zhangsan lisi πreadonly
|
|
627
|
-
|
|
628
|
-
Bots Agent Status
|
|
629
|
-
molty (Lobster) main Online
|
|
630
|
-
work-claw (Work Helper) work Online
|
|
631
|
-
|
|
632
|
-
Private Channels
|
|
633
|
-
AI Squad zhangsan(Owner), lisi, molty(Bot), work-claw(Bot)
|
|
634
|
-
```
|
|
635
|
-
|
|
636
|
-
</details>
|
|
637
|
-
|
|
638
|
-
<details>
|
|
639
|
-
<summary><b>Upgrade Plugin</b></summary>
|
|
640
|
-
|
|
641
|
-
```bash
|
|
642
|
-
openclaw rocketchat upgrade
|
|
643
|
-
```
|
|
644
|
-
|
|
645
|
-
One command does it all: shows version comparison β backs up config β stops Gateway β removes old version β installs new version β restores config.
|
|
646
|
-
Fully automatic β **no bot, group, or binding config is lost**.
|
|
647
|
-
|
|
648
|
-
</details>
|
|
649
|
-
|
|
650
|
-
<details>
|
|
651
|
-
<summary><b>Uninstall</b></summary>
|
|
652
|
-
|
|
653
|
-
```bash
|
|
654
|
-
openclaw rocketchat uninstall
|
|
655
|
-
```
|
|
656
|
-
|
|
657
|
-
</details>
|
|
658
|
-
|
|
659
132
|
## Commands
|
|
660
133
|
|
|
661
134
|
| Command | Description |
|
|
662
135
|
|---|---|
|
|
663
|
-
| `openclaw rocketchat setup` | Connect to Rocket.Chat
|
|
136
|
+
| `openclaw rocketchat setup` | Connect to Rocket.Chat + create admin + create phone account |
|
|
664
137
|
| `openclaw rocketchat add-bot` | Add bot + bind Agent + create DM |
|
|
665
138
|
| `openclaw rocketchat add-group` | Create private channel (multi-bot group) |
|
|
666
139
|
| `openclaw rocketchat add-user` | Add phone login user |
|
|
667
140
|
| `openclaw rocketchat remove-user` | Remove phone login user |
|
|
668
141
|
| `openclaw rocketchat invite` | Manage group members |
|
|
669
|
-
| `openclaw rocketchat status` | View running status
|
|
142
|
+
| `openclaw rocketchat status` | View running status |
|
|
670
143
|
| `openclaw rocketchat upgrade` | **One-click upgrade (auto backup/restore config)** |
|
|
671
|
-
| `openclaw rocketchat uninstall` | Uninstall
|
|
144
|
+
| `openclaw rocketchat uninstall` | Uninstall |
|
|
672
145
|
|
|
673
146
|
All commands are **interactive** β no flags to memorize, just follow the prompts.
|
|
674
147
|
|
|
675
|
-
##
|
|
676
|
-
|
|
677
|
-
All config is written automatically by CLI commands into `~/.openclaw/openclaw.json`. You normally don't need to edit it manually, but understanding the structure helps with troubleshooting and advanced customization.
|
|
678
|
-
|
|
679
|
-
> **Full configuration docs (parameter tables + JSON example + manual editing + full reset): [docs/CONFIGURATION.en.md](docs/CONFIGURATION.en.md)**
|
|
680
|
-
|
|
681
|
-
Quick reference for the most common parameters:
|
|
682
|
-
|
|
683
|
-
| Parameter | Description |
|
|
684
|
-
|-----------|-------------|
|
|
685
|
-
| `channels.rocketchat.enabled` | Enable/disable channel |
|
|
686
|
-
| `channels.rocketchat.serverUrl` | Server URL (`https://127.0.0.1` for co-located, sslip.io domain for remote) |
|
|
687
|
-
| `channels.rocketchat.port` | HTTPS port (default `443`) |
|
|
688
|
-
| `channels.rocketchat.accounts.<id>` | Bot accounts (written by `add-bot`) |
|
|
689
|
-
| `channels.rocketchat.groups.<name>.requireMention` | @mention rule (`true`: only respond to @bot) |
|
|
690
|
-
| `bindings[].agentId` | Bot-to-Agent binding |
|
|
691
|
-
| `plugins.entries.openclaw-rocketchat.enabled` | Plugin enabled state |
|
|
692
|
-
|
|
693
|
-
> **Note**: Bot credentials are stored in `~/.openclaw/credentials/`, separate from config.
|
|
694
|
-
|
|
695
|
-
## Architecture
|
|
696
|
-
|
|
697
|
-
> Detailed architecture diagrams at [docs/ARCHITECTURE.en.md](docs/ARCHITECTURE.en.md)
|
|
698
|
-
|
|
699
|
-
```
|
|
700
|
-
Mode A (Co-located): Phone β HTTPS β [Nginx + RC + MongoDB + OpenClaw] all on one machine
|
|
701
|
-
Mode B (Split): Phone β HTTPS β [VPS: Nginx + RC + MongoDB] β WebSocket β [Home LAN: OpenClaw]
|
|
702
|
-
```
|
|
703
|
-
|
|
704
|
-
## FAQ
|
|
705
|
-
|
|
706
|
-
<details>
|
|
707
|
-
<summary><b>Setup says "registration is disabled" β what do I do?</b></summary>
|
|
708
|
-
|
|
709
|
-
This means setup was previously run and auto-disabled public registration. Solutions:
|
|
710
|
-
|
|
711
|
-
**Option 1: Reset Rocket.Chat (recommended, cleanest)**
|
|
712
|
-
|
|
713
|
-
```bash
|
|
714
|
-
cd ~/rocketchat && docker compose down -v
|
|
715
|
-
curl -fsSL https://raw.githubusercontent.com/Kxiandaoyan/openclaw-rocketchat/master/install-rc.sh | bash
|
|
716
|
-
openclaw rocketchat setup
|
|
717
|
-
openclaw rocketchat add-bot
|
|
718
|
-
```
|
|
719
|
-
|
|
720
|
-
**Option 2: Use existing admin**
|
|
721
|
-
|
|
722
|
-
If you know the admin username/password, re-run setup and choose "Use existing admin account".
|
|
723
|
-
|
|
724
|
-
</details>
|
|
725
|
-
|
|
726
|
-
<details>
|
|
727
|
-
<summary><b>How to upgrade the plugin?</b></summary>
|
|
728
|
-
|
|
729
|
-
```bash
|
|
730
|
-
openclaw rocketchat upgrade
|
|
731
|
-
```
|
|
732
|
-
|
|
733
|
-
One command does it all. Automatically backs up config β installs new version β restores config. **No bot, group, or binding config is lost.**
|
|
734
|
-
|
|
735
|
-
</details>
|
|
736
|
-
|
|
737
|
-
<details>
|
|
738
|
-
<summary><b>How to start completely fresh (reconfigure from scratch)?</b></summary>
|
|
739
|
-
|
|
740
|
-
> Full reset steps also at [docs/CONFIGURATION.en.md β Full Reset](docs/CONFIGURATION.en.md#full-reset)
|
|
741
|
-
|
|
742
|
-
```bash
|
|
743
|
-
# 1. Stop Gateway
|
|
744
|
-
openclaw gateway stop
|
|
745
|
-
|
|
746
|
-
# 2. (Optional) To also reset Rocket.Chat data:
|
|
747
|
-
# cd ~/rocketchat && docker compose down -v
|
|
748
|
-
|
|
749
|
-
# 3. Remove plugin and credentials
|
|
750
|
-
rm -rf ~/.openclaw/extensions/openclaw-rocketchat
|
|
751
|
-
rm -rf ~/.openclaw/credentials/rocketchat*
|
|
752
|
-
|
|
753
|
-
# 4. Clean all Rocket.Chat related config entries
|
|
754
|
-
python3 -c "
|
|
755
|
-
import json
|
|
756
|
-
p = '$HOME/.openclaw/openclaw.json'
|
|
757
|
-
with open(p) as f:
|
|
758
|
-
c = json.load(f)
|
|
759
|
-
c.get('channels', {}).pop('rocketchat', None)
|
|
760
|
-
c['bindings'] = [b for b in c.get('bindings', []) if b.get('match', {}).get('channel') != 'rocketchat']
|
|
761
|
-
c.get('plugins', {}).get('entries', {}).pop('openclaw-rocketchat', None)
|
|
762
|
-
c.get('plugins', {}).get('entries', {}).pop('rocketchat', None)
|
|
763
|
-
c.get('plugins', {}).get('installs', {}).pop('openclaw-rocketchat', None)
|
|
764
|
-
with open(p, 'w') as f:
|
|
765
|
-
json.dump(c, f, indent=2, ensure_ascii=False)
|
|
766
|
-
print('Done')
|
|
767
|
-
"
|
|
768
|
-
|
|
769
|
-
# 5. Reinstall (if you reset RC in step 2, run install-rc.sh first)
|
|
770
|
-
openclaw plugins install openclaw-rocketchat
|
|
771
|
-
openclaw rocketchat setup
|
|
772
|
-
openclaw rocketchat add-bot
|
|
773
|
-
openclaw gateway start
|
|
774
|
-
```
|
|
775
|
-
|
|
776
|
-
</details>
|
|
777
|
-
|
|
778
|
-
<details>
|
|
779
|
-
<summary><b>Rocket.Chat Docker management commands</b></summary>
|
|
780
|
-
|
|
781
|
-
```bash
|
|
782
|
-
# Check container status
|
|
783
|
-
docker ps
|
|
784
|
-
|
|
785
|
-
# View logs
|
|
786
|
-
cd ~/rocketchat && docker compose logs -f
|
|
787
|
-
|
|
788
|
-
# Stop service
|
|
789
|
-
cd ~/rocketchat && docker compose stop
|
|
790
|
-
|
|
791
|
-
# Start service
|
|
792
|
-
cd ~/rocketchat && docker compose start
|
|
793
|
-
|
|
794
|
-
# Restart service
|
|
795
|
-
cd ~/rocketchat && docker compose restart
|
|
796
|
-
|
|
797
|
-
# Completely uninstall (delete all data)
|
|
798
|
-
cd ~/rocketchat && docker compose down -v
|
|
799
|
-
```
|
|
800
|
-
|
|
801
|
-
</details>
|
|
802
|
-
|
|
803
|
-
<details>
|
|
804
|
-
<summary><b>What is sslip.io? Why don't I need to buy a domain?</b></summary>
|
|
805
|
-
|
|
806
|
-
[sslip.io](https://sslip.io) is a free wildcard DNS service that embeds IP addresses directly into domain names. For example:
|
|
807
|
-
|
|
808
|
-
- `166-88-11-59.sslip.io` automatically resolves to `166.88.11.59`
|
|
809
|
-
- `10-0-0-1.sslip.io` automatically resolves to `10.0.0.1`
|
|
810
|
-
|
|
811
|
-
This means **any server with a public IP gets a free domain instantly** β no registration, no DNS configuration, no annual fees.
|
|
812
|
-
|
|
813
|
-
Because sslip.io gives you a real domain name, the install script can request a **real Let's Encrypt HTTPS certificate**. Your phone app connects with a trusted "green lock" β zero warnings, zero manual trust steps.
|
|
814
|
-
|
|
815
|
-
sslip.io is:
|
|
816
|
-
- **Free** β no cost, no sign-up, no account needed
|
|
817
|
-
- **Instant** β works immediately for any IP address
|
|
818
|
-
- **Maintained by the open-source community** β [source code on GitHub](https://github.com/cunnie/sslip.io)
|
|
819
|
-
- **Reliable** β backed by multiple DNS servers worldwide
|
|
820
|
-
|
|
821
|
-
</details>
|
|
822
|
-
|
|
823
|
-
<details>
|
|
824
|
-
<summary><b>What if certificate acquisition fails?</b></summary>
|
|
825
|
-
|
|
826
|
-
The `install-rc.sh` script uses **acme.sh** to auto-obtain Let's Encrypt certificates. If acquisition fails, common reasons include:
|
|
827
|
-
|
|
828
|
-
- **Firewall not allowing port 80** β Let's Encrypt validates via HTTP on port 80; ensure it's open
|
|
829
|
-
- **Port 80 occupied** β Another service (e.g. web server) may be using it
|
|
830
|
-
- **sslip.io DNS issues** β The script relies on sslip.io for domain resolution; check connectivity
|
|
831
|
-
- **Let's Encrypt rate limits** β Too many requests in a short period; wait and retry later
|
|
832
|
-
|
|
833
|
-
Fix the underlying issue, then re-run: `bash install-rc.sh --force`
|
|
834
|
-
</details>
|
|
835
|
-
|
|
836
|
-
<details>
|
|
837
|
-
<summary><b>Are push notifications reliable in China?</b></summary>
|
|
838
|
-
|
|
839
|
-
When the app is in the foreground, messages arrive via WebSocket in real-time with zero delay. In the background, notifications go through APNs with ~1-5 second delay, occasionally lost β consistent with most apps' push behavior in China.
|
|
840
|
-
</details>
|
|
841
|
-
|
|
842
|
-
<details>
|
|
843
|
-
<summary><b>What message formats are supported?</b></summary>
|
|
844
|
-
|
|
845
|
-
Plain text, Markdown (with syntax highlighting), images, files, and voice messages. Rocket.Chat natively renders Markdown with code block highlighting.
|
|
846
|
-
</details>
|
|
847
|
-
|
|
848
|
-
<details>
|
|
849
|
-
<summary><b>Can multiple people use it?</b></summary>
|
|
850
|
-
|
|
851
|
-
Yes. Use `openclaw rocketchat add-user` to add more phone users (family, colleagues). Each person downloads Rocket.Chat and logs in with their own account.
|
|
852
|
-
</details>
|
|
853
|
-
|
|
854
|
-
## More Documentation
|
|
148
|
+
## Documentation
|
|
855
149
|
|
|
856
150
|
| Document | Content |
|
|
857
151
|
|----------|---------|
|
|
858
|
-
| [
|
|
859
|
-
| [
|
|
860
|
-
| [
|
|
152
|
+
| [Usage Guide](docs/GUIDE.en.md) | Full step-by-step walkthrough, terminal output examples, remote deployment, user management |
|
|
153
|
+
| [FAQ](docs/FAQ.en.md) | Registration disabled, upgrades, reset, Docker commands, certificates, push notifications |
|
|
154
|
+
| [Configuration](docs/CONFIGURATION.en.md) | Full parameter tables, JSON example, manual editing, full reset |
|
|
155
|
+
| [Architecture](docs/ARCHITECTURE.en.md) | Full comparison table, architecture diagrams, tech stack |
|
|
156
|
+
| [Security](docs/SECURITY.en.md) | Password security, credential storage, backup/restore, file permissions |
|
|
861
157
|
|
|
862
158
|
## Contributing
|
|
863
159
|
|