create-openclaw-bot 5.5.0 → 5.6.0

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.
Files changed (39) hide show
  1. package/README.md +18 -17
  2. package/README.vi.md +18 -17
  3. package/{cli.js → dist/cli.js} +295 -224
  4. package/dist/setup/shared/install-gen.js +485 -0
  5. package/{setup/shared/scaffold-gen.js → dist/setup/shared/workspace-gen.js} +247 -25
  6. package/{setup.js → dist/setup.js} +771 -1158
  7. package/package.json +10 -7
  8. package/.github/workflows/check-openclaw-update.yml +0 -106
  9. package/CHANGELOG.md +0 -602
  10. package/CHANGELOG.vi.md +0 -588
  11. package/docs/SETUP.md +0 -532
  12. package/docs/SETUP.vi.md +0 -439
  13. package/docs/ai-providers.md +0 -144
  14. package/docs/ai-providers.vi.md +0 -144
  15. package/docs/browser-automation-guide.md +0 -207
  16. package/docs/faq.md +0 -63
  17. package/docs/faq.vi.md +0 -63
  18. package/docs/hardware-guide.md +0 -55
  19. package/docs/hardware-guide.vi.md +0 -55
  20. package/docs/install-docker.md +0 -161
  21. package/docs/install-docker.vi.md +0 -161
  22. package/docs/install-native.md +0 -96
  23. package/docs/install-native.vi.md +0 -96
  24. package/docs/preview.png +0 -0
  25. package/docs/skills-plugins-guide.md +0 -126
  26. package/index.html +0 -589
  27. package/old_v510.js +0 -0
  28. package/setup/shared/runtime-gen.js +0 -710
  29. package/style.css +0 -1653
  30. package/upgrade.ps1 +0 -90
  31. package/upgrade.sh +0 -93
  32. /package/{setup → dist/setup}/data/channels.js +0 -0
  33. /package/{setup → dist/setup}/data/header.js +0 -0
  34. /package/{setup → dist/setup}/data/index.js +0 -0
  35. /package/{setup → dist/setup}/data/plugins.js +0 -0
  36. /package/{setup → dist/setup}/data/providers.js +0 -0
  37. /package/{setup → dist/setup}/data/skills.js +0 -0
  38. /package/{setup → dist/setup}/shared/common-gen.js +0 -0
  39. /package/{setup → dist/setup}/shared/docker-gen.js +0 -0
@@ -1,144 +0,0 @@
1
- # Hướng dẫn Cấu hình AI Provider
2
-
3
- Tài liệu này tổng hợp toàn bộ AI provider được hỗ trợ trong OpenClaw. Sử dụng để lựa chọn provider phù hợp với ngân sách, yêu cầu kỹ thuật và nhu cầu bảo mật của bạn.
4
-
5
- ---
6
-
7
- ## 📊 So sánh các Provider
8
-
9
- | Provider | Chi phí | Cần API Key | Dữ liệu | Phù hợp nhất |
10
- | --- | --- | --- | --- | --- |
11
- | **9Router** | 🆓 Miễn phí | ❌ Đăng nhập OAuth | Cloud | Người mới bắt đầu. Không cần cấu hình. |
12
- | **Google Gemini** | 🆓 Free tier | ✅ Có | Cloud | Chất lượng cao. Giới hạn miễn phí rộng rãi. |
13
- | **Anthropic Claude** | 💰 Trả phí | ✅ Có | Cloud | Lý luận và viết văn tốt nhất. |
14
- | **OpenAI / Codex** | 💰 Trả phí | ✅ Có | Cloud | Sinh code, hệ sinh thái rộng. |
15
- | **OpenRouter** | 🆓/💰 Hỗn hợp | ✅ Có | Cloud | Truy cập nhiều provider bằng một key duy nhất. |
16
- | **Ollama (Local)** | 🏠 Miễn phí | ❌ Không cần | **Cục bộ** | Bảo mật tuyệt đối. Chạy offline được. |
17
-
18
- ---
19
-
20
- ## 🔀 9Router — Khuyên dùng cho người mới
21
-
22
- 9Router là một **AI proxy mã nguồn mở** chạy trên máy của bạn và tự động định tuyến yêu cầu AI đến model miễn phí tốt nhất. Thay vì quản lý API key, bạn chỉ cần đăng nhập một lần qua OAuth.
23
-
24
- **Lý do chọn 9Router:**
25
- - Không cần API key — chỉ cần đăng nhập OAuth một lần (GitHub, Google, ...)
26
- - Tự động định tuyến đến model miễn phí (iFlow, Qwen, Gemini) với fallback thông minh
27
- - Hỗ trợ 40+ provider và 100+ model
28
- - Hoạt động trên **mọi nền tảng: Windows, macOS, Linux, VPS**
29
- - Miễn phí hoàn toàn — mã nguồn mở
30
-
31
- **Tùy chọn A — Cài native (hoạt động trên mọi OS kể cả Windows):**
32
- ```bash
33
- npm install -g 9router
34
- 9router
35
- ```
36
- Dashboard 9Router mở tại `http://localhost:20128`. Đăng nhập và kết nối một provider miễn phí.
37
-
38
- **Tùy chọn B — Docker sidecar (tự động khi dùng Docker mode của OpenClaw):**
39
- Khi bạn chọn 9Router trong Setup Wizard với Docker mode, file `docker-compose.yml` được tạo ra tự động bao gồm 9Router như một container sidecar. Không cần cài riêng.
40
-
41
- **Dùng 9Router với OpenClaw:**
42
- Dù bạn cài 9Router native hay qua Docker, cấu hình OpenClaw để dùng nó:
43
- - API endpoint: `http://localhost:20128/v1`
44
- - API key: sao chép từ dashboard 9Router
45
- - Model: chọn bất kỳ model nào hiển thị là available trong dashboard
46
-
47
- > [!TIP]
48
- > Bắt đầu với combo miễn phí: Gemini CLI (180K free/tháng) + iFlow models (miễn phí không giới hạn) = $0/tháng.
49
-
50
- ---
51
-
52
- ## 🧠 Google Gemini
53
-
54
- Google Gemini cung cấp free tier hào phóng nhất hiện có, là lựa chọn tốt nhất nếu bạn muốn dùng API key mà không mất tiền.
55
-
56
- **Các model hỗ trợ:** Gemini 2.5 Flash, Gemini 2.5 Pro, Gemini 3.0 Flash
57
-
58
- **Cách lấy API key:**
59
- 1. Truy cập [Google AI Studio](https://aistudio.google.com/apikey)
60
- 2. Đăng nhập bằng tài khoản Google
61
- 3. Nhấn **Create API Key**
62
- 4. Sao chép key và dán vào Setup Wizard khi được hỏi
63
-
64
- **Giới hạn free tier:** ~15 yêu cầu/phút, ~1 triệu token/ngày (tính đến 2025). Đủ cho nhu cầu cá nhân.
65
-
66
- ---
67
-
68
- ## 🤖 Anthropic Claude
69
-
70
- Claude được đánh giá là model hàng đầu về lý luận phức tạp, viết nội dung dài và tuân thủ hướng dẫn.
71
-
72
- **Các model hỗ trợ:** Claude Sonnet 4, Claude Opus 4, Claude Haiku 3.5
73
-
74
- **Cách lấy API key:**
75
- 1. Truy cập [Anthropic Console](https://console.anthropic.com/settings/keys)
76
- 2. Tạo tài khoản và thêm thông tin thanh toán
77
- 3. Tạo API key và dán vào Setup Wizard
78
-
79
- > [!WARNING]
80
- > Anthropic Claude yêu cầu tài khoản trả phí để lấy API key. Không có free tier vĩnh viễn.
81
-
82
- ---
83
-
84
- ## 🤖 OpenAI / Codex
85
-
86
- Phù hợp nếu bạn cần GPT-4o cho các tác vụ đa dạng hoặc Codex Mini cho quy trình làm việc nặng về code.
87
-
88
- **Các model hỗ trợ:** GPT-4o, GPT-4o Mini, o3, Codex Mini
89
-
90
- **Cách lấy API key:**
91
- 1. Truy cập [OpenAI Platform](https://platform.openai.com/api-keys)
92
- 2. Tạo tài khoản và nạp tối thiểu $5
93
- 3. Tạo API key và dán vào Setup Wizard
94
-
95
- ---
96
-
97
- ## 🌐 OpenRouter
98
-
99
- OpenRouter tổng hợp hàng trăm model (bao gồm cả model miễn phí) dưới một API key duy nhất. Hữu ích khi muốn chuyển đổi provider mà không cần chạy lại Setup Wizard.
100
-
101
- **Cách lấy API key:**
102
- 1. Truy cập [OpenRouter.ai](https://openrouter.ai/keys)
103
- 2. Tạo tài khoản (miễn phí)
104
- 3. Tạo API key. Một số model trên OpenRouter có giới hạn sử dụng miễn phí.
105
- 4. Dán key vào Setup Wizard
106
-
107
- > [!TIP]
108
- > OpenRouter bao gồm quyền truy cập miễn phí vào nhiều model mã nguồn mở. Lọc theo `Price: Free` trên trang web của họ để xem danh sách.
109
-
110
- ---
111
-
112
- ## 🏠 Ollama — AI Cục bộ (Không cần API Key)
113
-
114
- Ollama chạy model AI trực tiếp trên máy tính hoặc máy chủ của bạn. Dữ liệu không rời khỏi hạ tầng của bạn. Lý tưởng cho các triển khai cần bảo mật cao.
115
-
116
- **Các model local được hỗ trợ:** Gemma 4, Llama 3, Qwen 2.5, Phi-3, Mistral và nhiều hơn nữa.
117
-
118
- ### Docker Mode (Khuyên dùng)
119
- Khi chạy OpenClaw với Docker và chọn Ollama, Setup Wizard tự động:
120
- - Thêm service `ollama` vào `docker-compose.yml`
121
- - Cấu hình URL nội bộ là `http://ollama:11434`
122
- - Đặt `OLLAMA_KEEP_ALIVE=24h` để giữ model trong RAM
123
- - Pull model đã chọn khi `docker compose up` lần đầu
124
-
125
- Bạn **không cần** cài Ollama riêng.
126
-
127
- ### Native Mode
128
- Nếu không dùng Docker, bạn phải cài Ollama thủ công:
129
- 1. Truy cập [ollama.com](https://ollama.com) và tải installer cho OS của bạn
130
- 2. Sau khi cài xong, pull model muốn dùng:
131
- ```bash
132
- ollama pull gemma4
133
- ```
134
- 3. Đảm bảo Ollama đang chạy trước khi khởi động bot. OpenClaw sẽ kết nối đến `http://localhost:11434`.
135
-
136
- ### Chọn phiên bản Gemma 4 phù hợp
137
- Xem [Hướng dẫn RAM & Phần cứng](hardware-guide.vi.md) để biết chi tiết.
138
-
139
- | Model | RAM tối thiểu | Phù hợp |
140
- | --- | --- | --- |
141
- | `gemma4:e2b` | 4 GB | Rất nhẹ. VPS giá rẻ. |
142
- | `gemma4:e4b` | 8 GB | Laptop và VPS phổ thông. |
143
- | `gemma4` (Base) | 16 GB | Khuyên dùng. Chất lượng output tốt. |
144
- | `gemma4:26b` | 32 GB+ | Máy chủ cao cấp có GPU. |
@@ -1,207 +0,0 @@
1
- # OpenClaw Browser Automation — Hướng dẫn sử dụng
2
-
3
- ## Tổng quan
4
-
5
- Browser Automation cho phép bot AI **điều khiển Chrome thật trên màn hình** máy bạn theo thời gian thực. Bot có thể:
6
- - 🌐 Mở website, duyệt web ngay trên màn hình bạn
7
- - 📝 Điền form tự động
8
- - 🖱️ Click, gõ phím, cuộn trang
9
- - 📸 Chụp ảnh màn hình và gửi về chat
10
- - 🔐 Dùng luôn session login sẵn (Facebook, Gmail...)
11
-
12
- > ⚠️ **Lưu ý:** Chrome debug dùng **profile riêng** (`%TEMP%\chrome-debug`). Bạn cần login lại Facebook/Gmail 1 lần trong profile này.
13
-
14
- ---
15
-
16
- ## Cách hoạt động
17
-
18
- ```
19
- Máy bạn (Windows) Docker Container
20
- ┌─────────────────────┐ ┌──────────────────────────┐
21
- │ Chrome Debug Mode │◄────────────►│ socat proxy │
22
- │ Port 9222 (visible) │ TCP/CDP │ (9222 → host.docker:9222)│
23
- │ │ │ │
24
- │ Bạn thấy bot thao │ │ browser-tool.js │
25
- │ tác TRỰC TIẾP! │ │ → Playwright CDP client │
26
- └─────────────────────┘ └──────────────────────────┘
27
- ```
28
-
29
- 1. Chrome chạy trên máy bạn ở **Debug Mode** (port 9222) — **có giao diện, bạn nhìn thấy được**
30
- 2. Docker container dùng **socat** để bridge cổng: `container:9222 → Windows host:9222`
31
- 3. **`browser-tool.js`** dùng Playwright CDP client kết nối vào Chrome thật đó
32
- 4. Bot thao tác → bạn thấy Chrome di chuyển ngay trên màn hình
33
-
34
- ---
35
-
36
- ## Bước 1: Bật Chrome Debug Mode
37
-
38
- File **`start-chrome-debug.bat`** đã có sẵn trong thư mục dự án. Mỗi khi cần bot duyệt web:
39
-
40
- 1. Mở thư mục dự án (ví dụ: `D:\openclaw-setup`)
41
- 2. **Click đúp vào `start-chrome-debug.bat`**
42
- 3. Đợi Chrome mở ra và thấy dòng `OK! Chrome Debug Mode dang chay.` màu xanh
43
- 4. **Để cửa sổ này mở** trong suốt quá trình bot làm việc
44
-
45
- > **Quan trọng:** Phải bật Chrome Debug **trước khi** khởi động Docker. Nếu bot báo lỗi "chưa bật Chrome", hãy click đúp file này rồi thử lại.
46
-
47
- <details>
48
- <summary>Nội dung file bat (tham khảo)</summary>
49
-
50
- ```batch
51
- @echo off
52
- echo ====== OpenClaw - Chrome Debug Mode ======
53
- taskkill /F /IM chrome.exe >nul 2>&1
54
- timeout /t 3 /nobreak >nul
55
- start "" "C:\Program Files\Google\Chrome\Application\chrome.exe" ^
56
- --remote-debugging-port=9222 ^
57
- --remote-allow-origins=* ^
58
- --user-data-dir="%TEMP%\chrome-debug"
59
- timeout /t 4 /nobreak >nul
60
- powershell -Command "try { Invoke-WebRequest -Uri 'http://localhost:9222/json/version' -UseBasicParsing -TimeoutSec 5 | Out-Null; Write-Host 'OK! Chrome Debug Mode dang chay.' -ForegroundColor Green } catch { Write-Host 'LOI: Port 9222 chua mo.' -ForegroundColor Red }"
61
- pause
62
- ```
63
-
64
- </details>
65
-
66
- ---
67
-
68
- ## Bước 2: Tự động bật Chrome khi mở máy (Task Scheduler)
69
-
70
- Chạy script PowerShell bên dưới **1 lần** với **Run as Administrator**:
71
-
72
- ```powershell
73
- $batPath = "$env:USERPROFILE\start-chrome-debug.bat"
74
-
75
- if (-not (Test-Path $batPath)) {
76
- Write-Host "LOI: Không tìm thấy $batPath" -ForegroundColor Red
77
- exit 1
78
- }
79
-
80
- $action = New-ScheduledTaskAction -Execute $batPath
81
- $trigger = New-ScheduledTaskTrigger -AtLogOn
82
- $trigger.Delay = "PT10S"
83
- $settings = New-ScheduledTaskSettingsSet -AllowStartIfOnBatteries -DontStopIfGoingOnBatteries -StartWhenAvailable
84
-
85
- Register-ScheduledTask `
86
- -TaskName "OpenClaw-ChromeDebug" `
87
- -Description "Tu dong bat Chrome Debug Mode cho OpenClaw" `
88
- -Action $action `
89
- -Trigger $trigger `
90
- -Settings $settings `
91
- -Force
92
-
93
- Write-Host "DONE! Chrome sẽ tự bật Debug Mode mỗi khi đăng nhập Windows." -ForegroundColor Green
94
- ```
95
-
96
- ---
97
-
98
- ## Bước 3: Cách bot thao tác trình duyệt
99
-
100
- Bot dùng script nội bộ **`browser-tool.js`** (tự động có trong container) để điều khiển Chrome:
101
-
102
- ```bash
103
- # Kiểm tra kết nối (chạy trong container)
104
- node /root/.openclaw/workspace/browser-tool.js status
105
-
106
- # Mở trang web
107
- node /root/.openclaw/workspace/browser-tool.js open "https://google.com"
108
-
109
- # Đọc nội dung trang
110
- node /root/.openclaw/workspace/browser-tool.js get_text
111
-
112
- # Click vào phần tử (CSS Selector)
113
- node /root/.openclaw/workspace/browser-tool.js click "input[name='q']"
114
-
115
- # Gõ văn bản
116
- node /root/.openclaw/workspace/browser-tool.js fill "input[name='q']" "bàn phím cơ"
117
-
118
- # Nhấn phím
119
- node /root/.openclaw/workspace/browser-tool.js press "Enter"
120
- ```
121
-
122
- Bot tự động dùng các lệnh này khi bạn nhắn **"mở trình duyệt"** hoặc **"dùng browser"**.
123
-
124
- ---
125
-
126
- ## Cách ra lệnh cho bot
127
-
128
- | Lệnh | Bot làm gì |
129
- |------|-----------|
130
- | `"Mở google.com và tìm bàn phím cơ"` | Mở Chrome → search → chụp ảnh → báo cáo |
131
- | `"Dùng browser vào shopee tìm iPhone"` | Mở Shopee → tìm → tổng hợp kết quả |
132
- | `"Mở facebook và đọc tin mới nhất"` | Vào Facebook (đã login sẵn) → đọc feed |
133
- | `"Tìm trên web..."` | ❌ Dùng web_search thay vì browser — hãy nói rõ "browser" |
134
-
135
- > **Tip:** Bot sẽ trả lời ngay khi nhận lệnh, rồi thực hiện và báo cáo kết quả + ảnh chụp màn hình.
136
-
137
- ---
138
-
139
- ## Cấu hình `openclaw.json`
140
-
141
- Phần `browser` trong config **phải có**:
142
-
143
- ```json
144
- "browser": {
145
- "enabled": true,
146
- "noSandbox": true,
147
- "defaultProfile": "host-chrome",
148
- "profiles": {
149
- "host-chrome": {
150
- "cdpUrl": "http://127.0.0.1:9222",
151
- "color": "#4285F4"
152
- }
153
- }
154
- }
155
- ```
156
-
157
- ---
158
-
159
- ## Cấu hình Dockerfile
160
-
161
- Container cần **2 thứ** để browser automation hoạt động:
162
-
163
- ```dockerfile
164
- # 1. Cài socat (bridge cổng từ container ra host Windows)
165
- RUN apt-get update && apt-get install -y socat && rm -rf /var/lib/apt/lists/*
166
-
167
- # 2. Cài Playwright + tạo symlink Google Chrome
168
- RUN npm install -g playwright && npx playwright install chromium --with-deps \
169
- && ln -f -s /root/.cache/ms-playwright/chromium-*/chrome-linux*/chrome /usr/bin/google-chrome
170
-
171
- # 3. Khởi động socat kèm gateway (trong CMD)
172
- CMD sh -c "socat TCP-LISTEN:9222,fork,reuseaddr TCP:host.docker.internal:9222 & openclaw gateway run"
173
- ```
174
-
175
- ---
176
-
177
- ## Lưu ý quan trọng
178
-
179
- | # | Lưu ý |
180
- |---|-------|
181
- | 1 | **Bật `start-chrome-debug.bat` trước** khi Docker chạy |
182
- | 2 | Chrome debug dùng **profile riêng** → phải login lại các trang 1 lần |
183
- | 3 | Port 9222 chỉ bind localhost → **an toàn** |
184
- | 4 | Container thêm **~500MB** do Playwright Chromium |
185
- | 5 | Chỉ hỗ trợ **Chrome/Chromium** |
186
- | 6 | Nếu bot báo "Chrome đang tắt" → chạy lại `start-chrome-debug.bat` |
187
-
188
- ---
189
-
190
- ## Gỡ lỗi thường gặp
191
-
192
- **Bot nói "không kết nối được Chrome":**
193
- → Chạy lại `start-chrome-debug.bat`.
194
-
195
- **Bot phản hồi chậm:**
196
- → Bình thường — bot cần thời gian tải trang. Phần thao tác browser (~5-15s) chậm hơn web_search.
197
-
198
- **Bot không dùng browser dù đã nói "mở trình duyệt":**
199
- → Kiểm tra file `AGENTS.md` trong `.openclaw/workspace/` có hướng dẫn dùng `browser-tool.js` chưa.
200
-
201
- ---
202
-
203
- ## Xóa Task Scheduler (nếu cần)
204
-
205
- ```powershell
206
- Unregister-ScheduledTask -TaskName "OpenClaw-ChromeDebug" -Confirm:$false
207
- ```
package/docs/faq.md DELETED
@@ -1,63 +0,0 @@
1
- # Frequently Asked Questions (FAQ)
2
-
3
- <details>
4
- <summary><b>1. Is OpenClaw free to use?</b></summary>
5
- <br>
6
- Yes, the OpenClaw framework itself is 100% free and open-source (MIT License). Costs will only incur if you connect to paid AI providers (like OpenAI GPT-4o or Anthropic Claude). To run it completely free, we recommend using the integrated **9Router**, **Google Gemini** (Free tier), or running **Ollama** locally.
7
- </details>
8
-
9
- <details>
10
- <summary><b>2. What is 9Router and why is it recommended?</b></summary>
11
- <br>
12
- 9Router is an open-source AI proxy. Instead of managing complex API keys from multiple platforms, 9Router allows you to authenticate once via OAuth. It automatically routes your bot's prompts to the best available free AI models. It works seamlessly out of the box in both Native and Docker deployment modes.
13
- </details>
14
-
15
- <details>
16
- <summary><b>3. When SHOULD and SHOULD NOT I use Docker?</b></summary>
17
- <br>
18
-
19
- * **RECOMMENDED to use Docker (Windows/macOS):** Provides perfect isolation and avoids dependency conflicts. Ideal if you aren't familiar with terminal usage and want a pre-packaged environment easily managed via Docker Desktop.
20
- * **NOT RECOMMENDED to use Docker (Ubuntu/VPS):** If you are deploying on a cheap VPS (e.g. 1GB-2GB RAM) or a personal Ubuntu machine, installing natively (Native mode) managed by `PM2` is the superior method. Native mode saves up to 15% RAM that would otherwise be eaten up by virtualization overhead. OpenClaw is inherently secure, so adding Docker overhead on small servers is unnecessary.
21
-
22
- </details>
23
-
24
- <details>
25
- <summary><b>4. My bot is unresponsive, what should I do?</b></summary>
26
- <br>
27
- Troubleshooting depends on your deployment mode:
28
-
29
- **If running Docker Mode:**
30
- 1. Open your Terminal/PowerShell in your bot's setup folder.
31
- 2. Check container status: `docker compose ps`
32
- 3. Check error logs: `docker compose logs -f`
33
- 4. Soft restart the bot: `docker compose restart`
34
-
35
- **If running Native Mode (via PM2):**
36
- 1. Check process status: `pm2 status`
37
- 2. View error logs: `pm2 logs openclaw-bot`
38
- 3. Restart process: `pm2 restart openclaw-bot`
39
-
40
- *Tip: If you're using 9Router, ensure it's successfully running and authenticated at http://localhost:20128/dashboard.*
41
- </details>
42
-
43
- <details>
44
- <summary><b>5. Does the bot stay online 24/7?</b></summary>
45
- <br>
46
- Both guided setups are configured for resilient automation:
47
- * **With Docker:** Uses the `restart: unless-stopped` directive. The bot resurrects automatically on system reboots or crashes.
48
- * **With Native (PM2):** The generated CLI command runs `pm2 save` automatically to lock your context into the Linux daemon. (Don't forget to execute `pm2 startup` if prompted by the CLI).
49
- *Note: If you run it on your personal laptop, shutting down the OS turns off the bot. Install it on a VPS for true 24/7 uptime.*
50
- </details>
51
-
52
- <details>
53
- <summary><b>6. How can I change my AI Model after the initial setup?</b></summary>
54
- <br>
55
- Simply re-run the command `npx create-openclaw-bot` inside your existing bot directory. The wizard will walk you through the options again and safely overwrite your gateway configuration file without deleting your bot's history or local skills.
56
- </details>
57
-
58
- <details>
59
- <summary><b>7. Docker setup throws a missing plugin error, how to fix?</b></summary>
60
- <br>
61
- If you are on Linux (Ubuntu/Debian) and receive an error mentioning `unknown shorthand flag`, your server is running the legacy Docker V1 engine. OpenClaw requires Docker Compose V2.
62
- Fix this by running the package manager command: `sudo apt-get install docker-compose-plugin`
63
- </details>
package/docs/faq.vi.md DELETED
@@ -1,63 +0,0 @@
1
- # Các Câu Hỏi Thường Gặp (FAQ)
2
-
3
- <details>
4
- <summary><b>1. OpenClaw có miễn phí không?</b></summary>
5
- <br>
6
- Có, toàn bộ mã nguồn của OpenClaw hoàn toàn miễn phí (MIT License). Bạn không phải trả bất kỳ khoản phí nào cho OpenClaw. Tuy nhiên, chi phí sẽ phát sinh nếu bạn sử dụng các AI Provider trả phí (như GPT-4o, Claude 3.5 Sonnet). Để sử dụng miễn phí 100%, hãy chọn **9Router** (được cung cấp sẵn) hoặc **Google Gemini** (Free tier), hoặc chạy **Ollama** cục bộ.
7
- </details>
8
-
9
- <details>
10
- <summary><b>2. 9Router là gì và tại sao lại được khuyến nghị?</b></summary>
11
- <br>
12
- 9Router là một hệ thống AI Proxy mã nguồn mở miễn phí. Thay vì phải chật vật đăng ký và quản lý API Key từ nhiều nền tảng, 9Router cho phép bạn xác thực bằng 1 lần đăng nhập (OAuth). Nó sẽ tự động định tuyến các câu hỏi của bot sang các model AI miễn phí tốt nhất hiện có. Nó hoạt động hoàn hảo cả trên môi trường Native và Docker.
13
- </details>
14
-
15
- <details>
16
- <summary><b>3. Khi nào tôi NÊN và KHÔNG NÊN dùng Docker?</b></summary>
17
- <br>
18
-
19
- * **NÊN dùng Docker (Windows/macOS):** Cung cấp sự cách ly hoàn hảo. Rất lý tưởng nếu bạn không rành về dòng lệnh và muốn mọi thứ được đóng gói tự động chuẩn xác bằng Docker Desktop.
20
- * **KHÔNG NÊN dùng Docker (Ubuntu/VPS):** Nếu bạn thuê VPS giá rẻ (RAM 1GB - 2GB) hoặc cài trên Ubuntu cá nhân, cài thẳng (Native mode) với `PM2` là phương pháp tốt nhất. Nó giúp tiết kiệm tới 15% RAM so với việc bị chạy ảo hóa qua Docker. Bản thân OpenClaw đã rất bảo mật nên không cần bọc thêm Docker trên VPS.
21
-
22
- </details>
23
-
24
- <details>
25
- <summary><b>4. Bot của tôi không phản hồi, tôi phải làm sao?</b></summary>
26
- <br>
27
- Cách xử lý phụ thuộc vào môi trường bạn cài đặt:
28
-
29
- **Trường hợp dùng Docker:**
30
- 1. Mở Terminal/PowerShell tại thư mục cài đặt bot.
31
- 2. Kiểm tra container: `docker compose ps`
32
- 3. Đọc log để xem lỗi: `docker compose logs -f`
33
- 4. Khởi động lại: `docker compose restart`
34
-
35
- **Trường hợp dùng Native (PM2):**
36
- 1. Kiểm tra tiến trình: `pm2 status`
37
- 2. Đọc log để xem lỗi: `pm2 logs openclaw-bot`
38
- 3. Khởi động lại: `pm2 restart openclaw-bot`
39
-
40
- *Mẹo: Nếu bạn dùng 9Router, hãy chắc chắn rằng bạn đã mở http://localhost:20128/dashboard và đăng nhập thành công.*
41
- </details>
42
-
43
- <details>
44
- <summary><b>5. Bot có tự động chạy 24/7 không?</b></summary>
45
- <br>
46
- Cả hai chế độ cài đặt đều được cấu hình để tự động hóa:
47
- * **Với Docker:** Có cờ `restart: unless-stopped`. Bot sẽ tự chạy lại nếu máy khởi động.
48
- * **Với Native (PM2):** Lệnh CLI tạo ra đã bao gồm `pm2 save` để tự chạy lại sau khi reboot cục bộ trên Linux/VPS. (Đừng quên chạy lệnh `pm2 startup` nếu được yêu cầu trên Linux).
49
- *Lưu ý: Nếu bạn cài đặt trên laptop cá nhân, tắt máy thì bot sẽ offline. Để online 24/7, hãy cài đặt lên VPS.*
50
- </details>
51
-
52
- <details>
53
- <summary><b>6. Nếu muốn đổi AI Model sau khi cài, tôi phải làm thế nào?</b></summary>
54
- <br>
55
- Chỉ cần chạy lại lệnh `npx create-openclaw-bot` trong chính thư mục chứa bot của bạn. Trình setup sẽ hỏi lại các tùy chọn và tự động ghi đè an toàn file cấu hình mà không làm mất kỹ năng/lịch sử lưu trữ của bot.
56
- </details>
57
-
58
- <details>
59
- <summary><b>7. Cài đặt Docker báo lỗi thiếu Plugin, tôi phải làm gì?</b></summary>
60
- <br>
61
- Nếu bạn dùng Linux (Ubuntu/Debian) và gặp lỗi liên quan đến thuật ngữ `unknown shorthand flag`, nghĩa là server của bạn chỉ có Docker V1 cũ. OpenClaw yêu cầu Docker Compose V2.
62
- Để khắc phục, hãy chạy lệnh: `sudo apt-get install docker-compose-plugin`
63
- </details>
@@ -1,55 +0,0 @@
1
- # Hardware & RAM Configuration Guide (Gemma 4 / Ollama)
2
-
3
- When running **Local AI Models** (like Google's Gemma 4 via Ollama), your server or machine's hardware determines the speed and capability of the bot.
4
-
5
- OpenClaw supports running local models **without an API Key**. This guide helps you choose the right hardware based on the model tier and deployment mode.
6
-
7
- ---
8
-
9
- ## 💻 1. Gemma 4 Variant Matrix
10
-
11
- Gemma 4 is available in four variants to accommodate different hardware classes. All variants are automatically pulled if you select "Ollama + Gemma" during the Setup Wizard.
12
-
13
- | Gemma 4 Variant | Target Device / VPS | Min RAM (Native) | Min RAM (Docker) | Use Case |
14
- |---|---|---|---|---|
15
- | `gemma4:e2b` | Raspberry Pi, Budget VPS | ~ 4 GB | ~ 5 GB | Lightweight tasks, slow generation |
16
- | `gemma4:e4b` | Standard Laptop, VPS | ~ 8 GB | ~ 9 GB | Good balance for standard chat bots |
17
- | `gemma4` (Base) | Solid Workstation / Gaming PC | ~ 16 GB | ~ 18 GB | **Recommended.** High quality text |
18
- | `gemma4:26b` / `31b` | High-End GPU Server | ~ 32 GB+ | ~ 34 GB+ | Enterprise-grade local processing |
19
-
20
- > [!TIP]
21
- > **Docker Overhead:** Running Ollama inside Docker (Docker Mode) consumes about **10-15% more RAM** compared to running it natively on the host OS. If you are on a strict 8GB VPS constraint, consider using **Native Install Mode**.
22
-
23
- ---
24
-
25
- ## ⚡ 2. Docker vs Native RAM Trade-offs
26
-
27
- ### If using **Docker Mode**:
28
- - **Pros:** Perfect isolation. Ollama sidecar is automatically configured and networked (`http://ollama:11434`) without cluttering your host system.
29
- - **Cons:** Memory penalty. Docker's virtualization layer reserves RAM.
30
- - **Config:** OpenClaw's generated `docker-compose.yml` automatically sets:
31
- - `OLLAMA_NUM_PARALLEL=1` to prevent Ollama from exhausting RAM with concurrent inputs.
32
- - `OLLAMA_KEEP_ALIVE=24h` to keep the model loaded in RAM, preventing long startup times for subsequent chats.
33
-
34
- ### If using **Native Mode**:
35
- - **Pros:** Direct access to host hardware. Maximum RAM efficiency and GPU passthrough (if you have an Nvidia/AMD GPU).
36
- - **Cons:** You must install Ollama manually on your OS.
37
- - **Config:** OpenClaw reads from `http://localhost:11434`.
38
-
39
- ---
40
-
41
- ## 🛠️ 3. How to optimize your VPS
42
-
43
- If setting up on an Ubuntu VPS, you **must enable Swap Space** if your RAM barely meets the minimum.
44
-
45
- **Enable 8GB Swap on Ubuntu (Run as root):**
46
- ```bash
47
- fallocate -l 8G /swapfile
48
- chmod 600 /swapfile
49
- mkswap /swapfile
50
- swapon /swapfile
51
- echo '/swapfile none swap sw 0 0' | sudo tee -a /etc/fstab
52
- ```
53
-
54
- > [!WARNING]
55
- > Swap space uses your Hard Drive/SSD as slow RAM. While it prevents crashes (Out of Memory errors), generation speed will be **drastically slower** if the model drops into swap memory. Always prioritize physical RAM or VRAM when possible.
@@ -1,55 +0,0 @@
1
- # Hướng dẫn chọn cấu hình RAM & Phần cứng (Gemma 4 / Ollama)
2
-
3
- Khi chạy **Model AI Tại Máy (Local)** (như Gemma 4 của Google thông qua Ollama), phần cứng máy tính hoặc VPS của bạn sẽ quyết định tốc độ và độ thông minh của bot.
4
-
5
- OpenClaw hỗ trợ chạy các model local **không cần API Key**. Tài liệu này hướng dẫn bạn chọn cấu hình chuẩn dựa trên dung lượng phân khúc model và chế độ cài đặt.
6
-
7
- ---
8
-
9
- ## 💻 1. Ma trận Phiên bản Gemma 4
10
-
11
- Gemma 4 có sẵn 4 kích thước (variants) phù hợp với đa dạng thiết bị. Khi bạn sử dụng Setup Wizard và chọn "Ollama + Gemma", model tương ứng sẽ được tự động pull về.
12
-
13
- | Phiên bản Gemma 4 | Thiết bị mục tiêu / VPS | RAM tối thiểu (Native) | RAM tối thiểu (Docker) | Mục đích sử dụng |
14
- |---|---|---|---|---|
15
- | `gemma4:e2b` | Raspberry Pi, VPS Giá Rẻ | ~ 4 GB | ~ 5 GB | Tác vụ rất nhẹ nhàng, tốc độ phản hồi chậm |
16
- | `gemma4:e4b` | Laptop phổ thông, VPS chuẩn | ~ 8 GB | ~ 9 GB | Cân bằng tốt cho bot chat thông thường |
17
- | `gemma4` (Base) | PC Khỏe / Workstation | ~ 16 GB | ~ 18 GB | **Khuyên dùng.** Năng lực text chất lượng cao |
18
- | `gemma4:26b` / `31b` | Máy chủ chuyên dụng có GPU | ~ 32 GB+ | ~ 34 GB+ | Cấp doanh nghiệp, xử lý logic phức tạp |
19
-
20
- > [!TIP]
21
- > **Hao phí của Docker:** Chạy Ollama trong Docker (Docker Mode) tiêu tốn thêm khoảng **10-15% RAM** so với chạy thẳng trên hệ điều hành (Native). Nếu VPS của bạn chỉ có đúng 8GB, hãy cân nhắc sử dụng **Chế độ Native Install**.
22
-
23
- ---
24
-
25
- ## ⚡ 2. Được và Mất: Docker vs Native
26
-
27
- ### Nếu chọn **Docker Mode**:
28
- - **Ưu điểm:** Cách ly siêu sạch. Service Ollama được cấu hình mạng nội bộ tự động (`http://ollama:11434`) mà không làm bẩn hệ điều hành của bạn.
29
- - **Nhược điểm:** Phạt bộ nhớ. Lớp ảo hóa của Docker sẽ cắn bớt một phần RAM.
30
- - **Cấu hình:** File `docker-compose.yml` sinh ra từ OpenClaw đã auto-cấu hình:
31
- - `OLLAMA_NUM_PARALLEL=1` để chặn Ollama không bị tràn RAM khi có nhiều người chat cùng lúc.
32
- - `OLLAMA_KEEP_ALIVE=24h` để giữ model luôn nằm trên RAM, tránh tình trạng phản hồi lâu ở các câu hỏi sau.
33
-
34
- ### Nếu chọn **Native Mode**:
35
- - **Ưu điểm:** Khai thác tối đa 100% phần cứng máy chủ. Tận dụng tối đa sức mạnh Native và GPU Passthrough (nếu bạn có card rời Nvidia/AMD).
36
- - **Nhược điểm:** Bạn phải tự cài ứng dụng Ollama trên môi trường OS của bạn.
37
- - **Cấu hình:** OpenClaw sẽ đọc model từ đường dẫn `http://localhost:11434`.
38
-
39
- ---
40
-
41
- ## 🛠️ 3. Mẹo tối ưu cho VPS
42
-
43
- Nếu cài đặt trên Ubuntu VPS, bạn **bắt buộc phải tạo Swap Space (RAM ảo)** nếu RAM vật lý chỉ vừa khít hoặc thiếu hụt.
44
-
45
- **Lệnh tạo 8GB Swap trên Ubuntu (Mở quyền root):**
46
- ```bash
47
- fallocate -l 8G /swapfile
48
- chmod 600 /swapfile
49
- mkswap /swapfile
50
- swapon /swapfile
51
- echo '/swapfile none swap sw 0 0' | sudo tee -a /etc/fstab
52
- ```
53
-
54
- > [!WARNING]
55
- > Swap space lấy ổ cứng Hard Drive/SSD làm RAM cực hãm. Dù nó giúp VPS từ chối tử thần (lỗi Out of Memory - sập nguồn), tốc độ sinh chữ (generation) sẽ **chậm như rùa bò** nếu model rơi vào vùng Swap. Luôn ưu tiên dùng RAM thật (DDR) hoặc VRAM của GPU khi có thể.