Improve README with quick install, flow diagram, and operator guidance
This commit is contained in:
29
README.md
29
README.md
@@ -6,6 +6,35 @@ This repo packages the scripts, env example, systemd user units, and skill docum
|
||||
|
||||
`watchdog-b -> notify_watchdog_b.py -> owner_report_producer.py -> owner_report_driver.py -> OpenClaw Discord send -> sent archive`
|
||||
|
||||
## Quick install (shortest path)
|
||||
|
||||
Run from inside this repo:
|
||||
|
||||
```bash
|
||||
./scripts/install_watchdog_bundle.sh --install-env-example
|
||||
mkdir -p ~/.config/openclaw && cp ~/.config/openclaw/watchdog-b.env.example ~/.config/openclaw/watchdog-b.env
|
||||
sed -i 's#^WATCHDOG_B_OWNER_REPORT_TARGET=.*#WATCHDOG_B_OWNER_REPORT_TARGET=channel:YOUR_DISCORD_CHANNEL_ID#' ~/.config/openclaw/watchdog-b.env
|
||||
./scripts/bootstrap_watchdog_bundle.sh && systemctl --user daemon-reload && systemctl --user enable --now openclaw-watchdog-b.timer
|
||||
```
|
||||
|
||||
Replace `YOUR_DISCORD_CHANNEL_ID` with the real target before enabling the timer.
|
||||
|
||||
## Install flow
|
||||
|
||||
```mermaid
|
||||
flowchart TD
|
||||
A[Clone or unpack watchdog-discord-route] --> B[Run install_watchdog_bundle.sh --install-env-example]
|
||||
B --> C[Create ~/.config/openclaw/watchdog-b.env from example]
|
||||
C --> D[Set WATCHDOG_B_OWNER_REPORT_TARGET]
|
||||
D --> E[Run bootstrap_watchdog_bundle.sh]
|
||||
E --> F{Bootstrap passes?}
|
||||
F -- no --> G[Fix config/runtime/path issues and rerun bootstrap]
|
||||
G --> E
|
||||
F -- yes --> H[systemctl --user daemon-reload]
|
||||
H --> I[Enable/start openclaw-watchdog-b.timer]
|
||||
I --> J[Optional: run verify_watchdog_b_e2e.sh]
|
||||
```
|
||||
|
||||
## What this is for
|
||||
|
||||
Use this bundle when you need to:
|
||||
|
||||
Reference in New Issue
Block a user