Enhance documentation for OpenClaw Assistant add-on
- Updated DOCS.md with a comprehensive architecture overview, installation steps, first-time setup guide, and configuration reference. - Added detailed use case guides, including integration with Home Assistant's Assist pipeline and browser automation capabilities. - Introduced SECURITY.md to outline security risks, best practices, and disclaimers associated with the add-on. - Revised README.md to highlight key features and provide links to full documentation and security information.
This commit is contained in:
@@ -6,27 +6,27 @@ This repository contains a Home Assistant add-on that runs **OpenClaw** inside *
|
||||
|
||||
> Upstream rename history (FYI): clawdbot → moltbot → **openclaw** (final).
|
||||
|
||||
## What you get
|
||||
## Key Features
|
||||
|
||||
- An always-on OpenClaw gateway running as a Supervisor-managed add-on.
|
||||
- A reliable **Ingress landing page** inside Home Assistant that includes:
|
||||
- an embedded **web terminal** (ttyd)
|
||||
- a button to open the **Gateway Web UI** in a **separate browser tab** (not embedded)
|
||||
- Persistent state under the add-on config directory (in-container: `/config`).
|
||||
- **AI Gateway** — OpenClaw server with chat, skills, and automation capabilities
|
||||
- **Web Terminal** — browser-based terminal embedded in Home Assistant
|
||||
- **Assist Pipeline** — use OpenClaw as a conversation agent via the OpenAI-compatible API
|
||||
- **Browser Automation** — Chromium included for web scraping and automation skills
|
||||
- **Persistent Storage** — skills, config, and workspace survive add-on updates
|
||||
- **Bundled Tools** — git, vim, nano, bat, fd, ripgrep, curl, jq, python3, pnpm, Homebrew
|
||||
|
||||
## Why the Gateway UI is not embedded in Ingress
|
||||
## Supported Architectures
|
||||
|
||||
The Gateway Web UI requires WebSockets that can be flaky through HA Ingress depending on proxying/mixed-content.
|
||||
So we **don’t embed** it. Instead, the Ingress page gives you a button that opens the Gateway UI directly using
|
||||
`gateway_public_url`.
|
||||
| Architecture | Supported |
|
||||
|---|---|
|
||||
| amd64 | ✅ |
|
||||
| aarch64 (RPi 4/5) | ✅ |
|
||||
| armv7 (RPi 3) | ✅ |
|
||||
|
||||
## Security model (high level)
|
||||
## Documentation
|
||||
|
||||
- The add-on **does not** manage or overwrite OpenClaw’s full config.
|
||||
- OpenClaw is configured via its own interactive tools (`openclaw setup`, `openclaw onboard`, `openclaw configure`) using the terminal.
|
||||
- On first boot only (when config is missing), the add-on bootstraps a minimal config to let the gateway start:
|
||||
- `gateway.mode=local`
|
||||
- `gateway.auth.mode=token` with a generated token
|
||||
- **[Full documentation →](DOCS.md)** — installation, configuration, use cases, troubleshooting, and more
|
||||
- **[Security Risks & Disclaimer →](SECURITY.md)** — important risks to understand before using this add-on
|
||||
|
||||
## Install
|
||||
|
||||
@@ -36,27 +36,6 @@ So we **don’t embed** it. Instead, the Ingress page gives you a button that op
|
||||
- `https://github.com/techartdev/OpenClawHomeAssistant`
|
||||
4. Install **OpenClaw Assistant**
|
||||
|
||||
## First run (recommended)
|
||||
|
||||
1. Open the add-on page (Ingress) and use the embedded terminal.
|
||||
2. Run one of:
|
||||
- `openclaw onboard`
|
||||
- `openclaw configure`
|
||||
3. (Optional, but recommended) Set **gateway_public_url** in add-on options.
|
||||
- Then the Ingress page will show an "Open Gateway Web UI" button.
|
||||
|
||||
See **[DOCS.md](DOCS.md)** for a step-by-step first-time setup guide + troubleshooting.
|
||||
|
||||
## Add-on options (kept intentionally small)
|
||||
|
||||
See `openclaw_assistant/config.yaml` for the authoritative schema.
|
||||
|
||||
- `enable_terminal` (default: **true**) — enables the embedded web terminal.
|
||||
- `gateway_public_url` — only used to build the external Gateway UI link.
|
||||
- `timezone`
|
||||
- `homeassistant_token` (optional) — written to `/config/secrets/homeassistant.token` for local scripts.
|
||||
- `router_ssh_*` (optional) — SSH settings for a router/network device (custom automation).
|
||||
|
||||
## Support / Donations
|
||||
|
||||
If you find this useful and you want to bring me a coffee to make more useful things, or support the project, use the link below:
|
||||
|
||||
Reference in New Issue
Block a user