harald/zeroclaw
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 3

docs: overhaul docs IA and multilingual navigation

Browse source
This commit is contained in:
Chummy 2026-02-18 16:53:26 +08:00
parent 5e800c38f1
commit 93e5383cb2
40 changed files with 2495 additions and 198 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/network-deployment.md
View file

@ -59,14 +59,14 @@ allowed_users = []
[gateway]
host = "127.0.0.1"
port = 8080
port = 3000
allow_public_bind = false
```
### 2.4 Run Daemon (Local Only)
```bash
zeroclaw daemon --host 127.0.0.1 --port 8080
zeroclaw daemon --host 127.0.0.1 --port 3000
```
- Gateway binds to `127.0.0.1` — not reachable from other machines
@ -84,12 +84,12 @@ To allow other devices on your LAN to hit the gateway (e.g. for pairing or webho
```toml
[gateway]
host = "0.0.0.0"
port = 8080
port = 3000
allow_public_bind = true
```
```bash
zeroclaw daemon --host 0.0.0.0 --port 8080
zeroclaw daemon --host 0.0.0.0 --port 3000
```
**Security:** `allow_public_bind = true` exposes the gateway to your local network. Only use on trusted LANs.
@ -100,7 +100,7 @@ If you need a **public URL** (e.g. WhatsApp webhook, external clients):
1. Run gateway on localhost:
```bash
zeroclaw daemon --host 127.0.0.1 --port 8080
zeroclaw daemon --host 127.0.0.1 --port 3000
```
2. Start a tunnel:
@ -177,13 +177,13 @@ provider = "ngrok"
Or run ngrok manually:
```bash
ngrok http 8080
ngrok http 3000
# Use the HTTPS URL for your webhook
```
### 5.3 Cloudflare Tunnel
Configure Cloudflare Tunnel to forward to `127.0.0.1:8080`, then set your webhook URL to the tunnel's public hostname.
Configure Cloudflare Tunnel to forward to `127.0.0.1:3000`, then set your webhook URL to the tunnel's public hostname.
---
@ -191,7 +191,7 @@ Configure Cloudflare Tunnel to forward to `127.0.0.1:8080`, then set your webhoo
- [ ] Build with `--features hardware` (and `peripheral-rpi` if using native GPIO)
- [ ] Configure `[peripherals]` and `[channels_config.telegram]`
- [ ] Run `zeroclaw daemon --host 127.0.0.1 --port 8080` (Telegram works without 0.0.0.0)
- [ ] Run `zeroclaw daemon --host 127.0.0.1 --port 3000` (Telegram works without 0.0.0.0)
- [ ] For LAN access: `--host 0.0.0.0` + `allow_public_bind = true` in config
- [ ] For webhooks: use Tailscale, ngrok, or Cloudflare tunnel