let5see/clawdbot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: clarify lingering onboarding notes

Browse Source
This commit is contained in:
Peter Steinberger
2026-01-05 21:19:49 +00:00
parent de153a40d0
commit dbea8eb69e
5 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@@ -6,7 +6,7 @@
### Fixes ### Fixes
- Onboarding: resolve CLI entrypoint when running via `npx` so gateway daemon install works without a build step. - Onboarding: resolve CLI entrypoint when running via `npx` so gateway daemon install works without a build step.
- Linux: prompt to enable systemd lingering when installing/restarting the gateway user service (prevents logout/idle shutdowns). - Linux: auto-attempt lingering during onboarding (try without sudo, fallback to sudo) and prompt on install/restart to keep the gateway alive after logout/idle. Thanks @tobiasbischoff for PR #237.
- TUI: migrate key handling to the updated pi-tui Key matcher API. - TUI: migrate key handling to the updated pi-tui Key matcher API.
- macOS: prefer gateway config reads/writes in local mode (fall back to disk if the gateway is unavailable). - macOS: prefer gateway config reads/writes in local mode (fall back to disk if the gateway is unavailable).
- macOS: local gateway now connects via tailnet IP when bind mode is `tailnet`/`auto`. - macOS: local gateway now connects via tailnet IP when bind mode is `tailnet`/`auto`.

2
docs/faq.md
View File

@@ -471,7 +471,7 @@ codex --full-auto "debug why clawdbot gateway won't start"
Linux installs use a systemd **user** service. By default, systemd stops user Linux installs use a systemd **user** service. By default, systemd stops user
services on logout/idle, which kills the Gateway. services on logout/idle, which kills the Gateway.
Fix: Onboarding attempts to enable lingering; if it’s still off, run:
```bash ```bash
sudo loginctl enable-linger $USER sudo loginctl enable-linger $USER
``` ```

7
docs/gateway.md
View File

@@ -182,7 +182,7 @@ Enable lingering (required so the user service survives logout/idle):
``` ```
sudo loginctl enable-linger youruser sudo loginctl enable-linger youruser
``` ```
Requires sudo (writes `/var/lib/systemd/linger`). Onboarding runs this on Linux (may prompt for sudo; writes `/var/lib/systemd/linger`).
Then enable the service: Then enable the service:
``` ```
systemctl --user enable --now clawdbot-gateway.service systemctl --user enable --now clawdbot-gateway.service
@@ -190,9 +190,10 @@ systemctl --user enable --now clawdbot-gateway.service
**Alternative (system service)** - for always-on or multi-user servers, you can **Alternative (system service)** - for always-on or multi-user servers, you can
install a systemd **system** unit instead of a user unit (no lingering needed). install a systemd **system** unit instead of a user unit (no lingering needed).
Create `/etc/systemd/system/clawdbot-gateway.service`, set `User=` and Create `/etc/systemd/system/clawdbot-gateway.service` (copy the unit above,
`WorkingDirectory=`, then enable with: switch `WantedBy=multi-user.target`, set `User=` + `WorkingDirectory=`), then:
``` ```
sudo systemctl daemon-reload
sudo systemctl enable --now clawdbot-gateway.service sudo systemctl enable --now clawdbot-gateway.service
``` ```

3
docs/setup.md
View File

@@ -112,7 +112,8 @@ pnpm clawdbot health
## Linux (systemd user service) ## Linux (systemd user service)
Linux installs use a systemd **user** service. By default, systemd stops user Linux installs use a systemd **user** service. By default, systemd stops user
services on logout/idle, which kills the Gateway. Enable lingering: services on logout/idle, which kills the Gateway. Onboarding attempts to enable
lingering for you (may prompt for sudo). If it’s still off, run:
```bash ```bash
sudo loginctl enable-linger $USER sudo loginctl enable-linger $USER

4
docs/wizard.md
View File

@@ -74,8 +74,8 @@ It does **not** install or change anything on the remote host.
- macOS: LaunchAgent - macOS: LaunchAgent
- Requires a logged-in user session; for headless, use a custom LaunchDaemon (not shipped). - Requires a logged-in user session; for headless, use a custom LaunchDaemon (not shipped).
- Linux: systemd user unit - Linux: systemd user unit
- Wizard enables lingering via `loginctl enable-linger <user>` so the Gateway stays up after logout. - Wizard attempts to enable lingering via `loginctl enable-linger <user>` so the Gateway stays up after logout.
- Requires sudo (writes `/var/lib/systemd/linger`). - May prompt for sudo (writes `/var/lib/systemd/linger`); it tries without sudo first.
- Windows: Scheduled Task - Windows: Scheduled Task
- Runs on user logon; headless/system services are not configured by default. - Runs on user logon; headless/system services are not configured by default.