mirror of
https://github.com/techartdev/OpenClawHomeAssistant.git
synced 2026-08-14 17:02:07 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b0a0cc3f23 | ||
|
|
00df877305 | ||
|
|
a037d8311b | ||
|
|
beb59e8eb6 | ||
|
|
a6af4b78ac | ||
|
|
f658885c59 | ||
|
|
ceb9522648 | ||
|
|
ca2c7cab82 | ||
|
|
99be0ed6e6 | ||
|
|
ec825fa8c5 | ||
|
|
971e4bc8e0 | ||
|
|
c3a926299f | ||
|
|
883f5b8778 | ||
|
|
7608357297 | ||
|
|
9235903ef2 | ||
|
|
d5f3831131 | ||
|
|
b45e665bca | ||
|
|
0b799f5fb1 | ||
|
|
6129b62512 | ||
|
|
fe082864ec | ||
|
|
4d8fa8996a | ||
|
|
45d4066d2a | ||
|
|
28574b28ef | ||
|
|
089594a95b | ||
|
|
08bc68b9e7 | ||
|
|
3a06c4604f | ||
|
|
661085afc3 | ||
|
|
ccde8598d7 | ||
|
|
80f86ae030 | ||
|
|
082c2c74b2 | ||
|
|
d070dbe1e1 | ||
|
|
9824f7c138 | ||
|
|
71e3fbe410 | ||
|
|
c2398c84a4 | ||
|
|
3e5e0877b1 | ||
|
|
c769cb88e1 | ||
|
|
865ca08873 | ||
|
|
f0a465bf7c | ||
|
|
80ef635315 | ||
|
|
2acfc77a3f | ||
|
|
91a2ddd01f | ||
|
|
f66c574611 | ||
|
|
57a8bf3868 | ||
|
|
2b6c875b0e | ||
|
|
ff5e1eba1e | ||
|
|
9a65e66b75 | ||
|
|
9b7b701d5b | ||
|
|
505115e06f | ||
|
|
72495984ad | ||
|
|
ba8fd59571 | ||
|
|
dab02d2e22 | ||
|
|
38e104d663 | ||
|
|
991cc3bcfc | ||
|
|
1a4e23e8c3 | ||
|
|
4f56a16b91 | ||
|
|
6a08c66128 | ||
|
|
02814db080 | ||
|
|
dd6b7eca6c | ||
|
|
c6232b6f5d | ||
|
|
e6cad868ab | ||
|
|
8f91cdc23e | ||
|
|
04ffef8f9f | ||
|
|
60fb692e7d | ||
|
|
7d8f7d524d | ||
|
|
6707c4ed28 | ||
|
|
2c5fa46572 | ||
|
|
31656139c0 | ||
|
|
3aaed98ac0 | ||
|
|
9259ce16a6 | ||
|
|
206cf75889 | ||
|
|
c0e83c3aac | ||
|
|
45bad5f76b | ||
|
|
615ea2f1a4 | ||
|
|
9181b4d22a | ||
|
|
ab07454051 | ||
|
|
a82df8c851 | ||
|
|
90607c867d | ||
|
|
dd14dd0f7d | ||
|
|
55d678c7ef | ||
|
|
b5a3e3ccde | ||
|
|
8d7caf7ad5 | ||
|
|
ec5adcb297 | ||
|
|
f22c273599 | ||
|
|
24ec277043 | ||
|
|
02a4393822 | ||
|
|
6629013d81 | ||
|
|
8bfc304009 | ||
|
|
e014805b4b | ||
|
|
5117d7c561 | ||
|
|
1c2694c526 | ||
|
|
9908db2f99 | ||
|
|
e64a85bb3a | ||
|
|
0dea325473 | ||
|
|
5003263eef | ||
|
|
c16b938674 | ||
|
|
78353c336f | ||
|
|
6eb2e11862 | ||
|
|
22c7d8ff4f | ||
|
|
6990b07d79 | ||
|
|
94fab5b260 | ||
|
|
872a52221e | ||
|
|
b45d2e685a | ||
|
|
47631c1968 | ||
|
|
30d95b8798 | ||
|
|
9b402d3130 | ||
|
|
5086b88a00 | ||
|
|
9d0332a36a | ||
|
|
d118102c11 | ||
|
|
cb71b0faca | ||
|
|
ab33e6702f | ||
|
|
c3ba720d0b | ||
|
|
e33bcf030a | ||
|
|
249f98161a | ||
|
|
b552684b49 | ||
|
|
335a99b88b | ||
|
|
05aff8c766 | ||
|
|
a5363b9cfc | ||
|
|
8d577356b3 | ||
|
|
04a71cbf23 | ||
|
|
6b9699d4cc | ||
|
|
7625d370c4 | ||
|
|
adbfcfee72 | ||
|
|
13417f4439 | ||
|
|
2f01fa2007 | ||
|
|
ff4a5c62eb | ||
|
|
0c4187c119 | ||
|
|
d5fae52ad6 | ||
|
|
7cdf7a2694 | ||
|
|
7118e77913 | ||
|
|
248e0be97f | ||
|
|
437884654e | ||
|
|
0d7b4ff760 | ||
|
|
0596d5b70c | ||
|
|
286afa7f26 | ||
|
|
53772be2bd | ||
|
|
893911d6b6 | ||
|
|
c8e67cb0ba | ||
|
|
2c619ffc7a | ||
|
|
8f172630bc | ||
|
|
2f6ac10f94 | ||
|
|
f23079c4fa | ||
|
|
cbc9f89263 |
@@ -0,0 +1,100 @@
|
||||
name: Bug report
|
||||
description: Report a reproducible problem with the OpenClaw Home Assistant add-on.
|
||||
title: "bug: "
|
||||
labels:
|
||||
- bug
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for reporting this. Please include concrete, reproducible details.
|
||||
|
||||
- type: checkboxes
|
||||
id: checks
|
||||
attributes:
|
||||
label: Pre-flight checks
|
||||
options:
|
||||
- label: I updated to the latest add-on version and restarted it.
|
||||
required: true
|
||||
- label: I checked the docs/troubleshooting section first.
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: summary
|
||||
attributes:
|
||||
label: What happened?
|
||||
description: Short description of the bug.
|
||||
placeholder: Describe the broken behavior.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: What did you expect to happen?
|
||||
placeholder: Describe expected behavior.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Provide exact steps and values.
|
||||
placeholder: |
|
||||
1) Go to ...
|
||||
2) Set ...
|
||||
3) Restart add-on
|
||||
4) Observe ...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: addon_version
|
||||
attributes:
|
||||
label: Add-on version
|
||||
placeholder: e.g. 0.5.52
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: openclaw_version
|
||||
attributes:
|
||||
label: OpenClaw version (if known)
|
||||
placeholder: e.g. 2026.2.22-2
|
||||
|
||||
- type: dropdown
|
||||
id: access_mode
|
||||
attributes:
|
||||
label: Access mode
|
||||
options:
|
||||
- custom
|
||||
- local_only
|
||||
- lan_https
|
||||
- lan_reverse_proxy
|
||||
- tailnet_https
|
||||
- unknown
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: config
|
||||
attributes:
|
||||
label: Relevant add-on configuration (redacted)
|
||||
description: Remove secrets/tokens/passwords.
|
||||
render: yaml
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Add-on logs
|
||||
description: Paste the relevant log section.
|
||||
render: text
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: extra
|
||||
attributes:
|
||||
label: Additional context
|
||||
description: Network/proxy/tailscale setup, screenshots, etc.
|
||||
@@ -0,0 +1,14 @@
|
||||
blank_issues_enabled: false
|
||||
contact_links:
|
||||
- name: OpenClaw Home Assistant Add-on Docs (DOCS.md)
|
||||
url: https://github.com/techartdev/OpenClawHomeAssistant/blob/main/DOCS.md
|
||||
about: Add-on specific installation, configuration, and troubleshooting.
|
||||
- name: OpenClaw Home Assistant Discord
|
||||
url: https://discord.gg/xeHeKu9jYp
|
||||
about: Community support for this Home Assistant add-on.
|
||||
- name: OpenClaw Official Docs
|
||||
url: https://docs.openclaw.ai
|
||||
about: Official OpenClaw platform documentation.
|
||||
- name: OpenClaw Official Community Discord
|
||||
url: https://discord.com/invite/clawd
|
||||
about: Official OpenClaw community server.
|
||||
@@ -0,0 +1,58 @@
|
||||
name: Feature request
|
||||
description: Suggest an improvement for the OpenClaw Home Assistant add-on.
|
||||
title: "feat: "
|
||||
labels:
|
||||
- enhancement
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for the idea. Concrete use-cases help us prioritize.
|
||||
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: What problem are you trying to solve?
|
||||
placeholder: As a user, I struggle with...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: proposal
|
||||
attributes:
|
||||
label: Proposed solution
|
||||
placeholder: Describe what should be added or changed.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Alternatives considered
|
||||
placeholder: Workarounds you've tried, and why they are not enough.
|
||||
|
||||
- type: textarea
|
||||
id: user_flow
|
||||
attributes:
|
||||
label: Suggested UX / configuration flow
|
||||
placeholder: |
|
||||
1) User opens ...
|
||||
2) User sets ...
|
||||
3) Add-on does ...
|
||||
|
||||
- type: textarea
|
||||
id: impact
|
||||
attributes:
|
||||
label: Impact
|
||||
description: Who benefits and how often this would be used.
|
||||
placeholder: This helps users who...
|
||||
|
||||
- type: checkboxes
|
||||
id: scope
|
||||
attributes:
|
||||
label: Scope
|
||||
options:
|
||||
- label: This is specific to the Home Assistant add-on (not upstream OpenClaw core).
|
||||
required: false
|
||||
- label: I can help test this on my setup.
|
||||
required: false
|
||||
@@ -0,0 +1,70 @@
|
||||
name: Question / Help
|
||||
description: Ask for setup help, configuration guidance, or troubleshooting clarification.
|
||||
title: "question: "
|
||||
labels:
|
||||
- question
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Ask your question here. Include enough context so we can help quickly.
|
||||
|
||||
- type: dropdown
|
||||
id: topic
|
||||
attributes:
|
||||
label: Topic
|
||||
options:
|
||||
- Installation
|
||||
- Access mode / HTTPS
|
||||
- Tailscale
|
||||
- Reverse proxy
|
||||
- Telegram / Messaging
|
||||
- Skills / Tools
|
||||
- Assist pipeline
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: addon_version
|
||||
attributes:
|
||||
label: Add-on version
|
||||
placeholder: e.g. 0.5.52
|
||||
|
||||
- type: dropdown
|
||||
id: access_mode
|
||||
attributes:
|
||||
label: Access mode (if relevant)
|
||||
options:
|
||||
- custom
|
||||
- local_only
|
||||
- lan_https
|
||||
- lan_reverse_proxy
|
||||
- tailnet_https
|
||||
- not sure
|
||||
|
||||
- type: textarea
|
||||
id: question
|
||||
attributes:
|
||||
label: Your question
|
||||
placeholder: What are you trying to do, and where are you blocked?
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: what_tried
|
||||
attributes:
|
||||
label: What have you already tried?
|
||||
placeholder: Steps you've tested and results.
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Relevant logs / errors (optional)
|
||||
render: text
|
||||
|
||||
- type: textarea
|
||||
id: extra
|
||||
attributes:
|
||||
label: Extra context (optional)
|
||||
description: Network setup, screenshots, links to docs you followed, etc.
|
||||
@@ -0,0 +1,56 @@
|
||||
# OpenClaw Home Assistant Add-on Patterns
|
||||
|
||||
Always reuse existing logic in `run.sh`, `oc_config_helper.py`, and `render_nginx.py`.
|
||||
Avoid duplicate implementations for config parsing, gateway patching, or template rendering.
|
||||
Respect guidelines in AGENTS.md
|
||||
|
||||
## Stack
|
||||
|
||||
- Home Assistant add-on (Debian Bookworm base)
|
||||
- Bash runtime orchestrator (`run.sh`)
|
||||
- Python helper scripts for config/template work
|
||||
- nginx template rendering
|
||||
- YAML config schema + 6 locale translation files
|
||||
|
||||
## Source of Truth
|
||||
|
||||
- Add-on options/schema: `openclaw_assistant_dev/config.yaml`
|
||||
- Runtime boot logic: `openclaw_assistant_dev/run.sh`
|
||||
- Safe OpenClaw config edits: `openclaw_assistant_dev/oc_config_helper.py`
|
||||
- nginx + landing rendering: `openclaw_assistant_dev/render_nginx.py`
|
||||
- UI text in Home Assistant: `openclaw_assistant_dev/translations/*.yaml`
|
||||
- User-facing docs: `DOCS.md`
|
||||
|
||||
## Required Sync Rules
|
||||
|
||||
When changing add-on options, update in the same PR:
|
||||
|
||||
1. `config.yaml` option default + schema
|
||||
2. All translation files (`en`, `bg`, `de`, `es`, `pl`, `pt-BR`)
|
||||
3. `DOCS.md` config/troubleshooting sections
|
||||
4. `CHANGELOG.md`
|
||||
|
||||
When changing landing/nginx placeholders:
|
||||
- Keep template keys and `render_nginx.py` replacements in sync.
|
||||
|
||||
## Security Rules
|
||||
|
||||
- Do not log secrets/tokens.
|
||||
- For gateway token docs/UI guidance, do not use `openclaw config get gateway.auth.token` (redacted in v2026.2.22+).
|
||||
- Prefer `jq -r '.gateway.auth.token' /config/.openclaw/openclaw.json`.
|
||||
|
||||
## Editing Rules
|
||||
|
||||
- Keep fixes minimal and root-cause focused.
|
||||
- Preserve backward compatibility for existing add-on options unless migration is explicit.
|
||||
- Do not change unrelated behavior while fixing one issue.
|
||||
|
||||
## Validation Commands
|
||||
|
||||
```sh
|
||||
bash -n openclaw_assistant_dev/run.sh
|
||||
python3 -m py_compile openclaw_assistant_dev/oc_config_helper.py
|
||||
python3 -m py_compile openclaw_assistant_dev/render_nginx.py
|
||||
```
|
||||
|
||||
If behavior changes are user-visible, update `openclaw_assistant_dev/CHANGELOG.md`.
|
||||
@@ -0,0 +1,68 @@
|
||||
name: Announce release to Discord
|
||||
|
||||
on:
|
||||
release:
|
||||
types: [published]
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
|
||||
jobs:
|
||||
notify-discord:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Post release announcement to Discord
|
||||
env:
|
||||
DISCORD_WEBHOOK_URL: ${{ secrets.DISCORD_WEBHOOK_URL }}
|
||||
RELEASE_NAME: ${{ github.event.release.name }}
|
||||
RELEASE_TAG: ${{ github.event.release.tag_name }}
|
||||
RELEASE_URL: ${{ github.event.release.html_url }}
|
||||
RELEASE_BODY: ${{ github.event.release.body }}
|
||||
REPO: ${{ github.repository }}
|
||||
run: |
|
||||
if [ -z "$DISCORD_WEBHOOK_URL" ]; then
|
||||
echo "DISCORD_WEBHOOK_URL is not configured; skipping."
|
||||
exit 0
|
||||
fi
|
||||
|
||||
if [ -n "$RELEASE_NAME" ]; then
|
||||
TITLE="$RELEASE_NAME"
|
||||
else
|
||||
TITLE="$RELEASE_TAG"
|
||||
fi
|
||||
|
||||
BODY_CLEAN=$(printf '%s' "$RELEASE_BODY" | sed 's/\r//g')
|
||||
BODY_TRIM=$(printf '%s' "$BODY_CLEAN" | sed '/^[[:space:]]*$/d')
|
||||
|
||||
if [ -n "$BODY_TRIM" ]; then
|
||||
SUMMARY=$(printf '%s' "$BODY_TRIM" | head -c 1400)
|
||||
else
|
||||
SUMMARY="No release notes provided."
|
||||
fi
|
||||
|
||||
PAYLOAD=$(jq -n \
|
||||
--arg title "🚀 New App/Add-on release published: $TITLE" \
|
||||
--arg repo "$REPO" \
|
||||
--arg tag "$RELEASE_TAG" \
|
||||
--arg url "$RELEASE_URL" \
|
||||
--arg summary "$SUMMARY" \
|
||||
'{
|
||||
content: "",
|
||||
embeds: [
|
||||
{
|
||||
title: $title,
|
||||
url: $url,
|
||||
color: 5814783,
|
||||
fields: [
|
||||
{name: "Repository", value: $repo, inline: true},
|
||||
{name: "Tag", value: $tag, inline: true},
|
||||
{name: "Release URL", value: $url, inline: false},
|
||||
{name: "Release notes", value: $summary, inline: false}
|
||||
]
|
||||
}
|
||||
]
|
||||
}')
|
||||
|
||||
curl -sS -X POST "$DISCORD_WEBHOOK_URL" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "$PAYLOAD"
|
||||
Vendored
+9
@@ -0,0 +1,9 @@
|
||||
{
|
||||
"recommendations": [
|
||||
"timonwong.shellcheck",
|
||||
"redhat.vscode-yaml",
|
||||
"ms-python.python",
|
||||
"ms-python.vscode-pylance",
|
||||
"esbenp.prettier-vscode"
|
||||
]
|
||||
}
|
||||
Vendored
+44
@@ -0,0 +1,44 @@
|
||||
{
|
||||
"editor.formatOnSave": true,
|
||||
"files.insertFinalNewline": true,
|
||||
"files.trimFinalNewlines": true,
|
||||
"files.eol": "\n",
|
||||
|
||||
"[shellscript]": {
|
||||
"editor.tabSize": 2,
|
||||
"editor.insertSpaces": true
|
||||
},
|
||||
"[yaml]": {
|
||||
"editor.tabSize": 2,
|
||||
"editor.insertSpaces": true
|
||||
},
|
||||
"[python]": {
|
||||
"editor.tabSize": 4,
|
||||
"editor.insertSpaces": true
|
||||
},
|
||||
"[markdown]": {
|
||||
"editor.wordWrap": "on",
|
||||
"editor.quickSuggestions": {
|
||||
"comments": "off",
|
||||
"strings": "off",
|
||||
"other": "off"
|
||||
}
|
||||
},
|
||||
|
||||
"files.associations": {
|
||||
"*.tpl": "nginx"
|
||||
},
|
||||
|
||||
"yaml.validate": true,
|
||||
"yaml.format.enable": true,
|
||||
|
||||
"shellcheck.enable": true,
|
||||
"shellcheck.run": "onType",
|
||||
|
||||
"python.analysis.typeCheckingMode": "basic",
|
||||
"python.analysis.autoImportCompletions": true,
|
||||
|
||||
"search.exclude": {
|
||||
"**/__pycache__": true
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,108 @@
|
||||
# Repository Guidelines
|
||||
|
||||
## Project Scope
|
||||
|
||||
This repository builds the **OpenClaw Assistant (DEV)** Home Assistant add-on.
|
||||
The add-on packages OpenClaw + nginx + ttyd and manages startup/configuration glue.
|
||||
|
||||
## Architecture at a Glance
|
||||
|
||||
- Add-on root metadata/docs:
|
||||
- `README.md`
|
||||
- `DOCS.md`
|
||||
- `SECURITY.md`
|
||||
- `repository.yaml`
|
||||
- Runtime implementation (all add-on behavior lives here):
|
||||
- `openclaw_assistant_dev/run.sh` (PID 1 orchestrator)
|
||||
- `openclaw_assistant_dev/oc_config_helper.py` (safe JSON config edits)
|
||||
- `openclaw_assistant_dev/render_nginx.py` (template rendering)
|
||||
- `openclaw_assistant_dev/nginx.conf.tpl`
|
||||
- `openclaw_assistant_dev/landing.html.tpl`
|
||||
- `openclaw_assistant_dev/config.yaml` (HA options + schema)
|
||||
- `openclaw_assistant_dev/translations/*.yaml` (all locale UI strings)
|
||||
- `openclaw_assistant_dev/Dockerfile`
|
||||
- `openclaw_assistant_dev/CHANGELOG.md`
|
||||
|
||||
## Core Rules
|
||||
|
||||
- Fix root causes, not symptoms.
|
||||
- Keep edits surgical; do not refactor unrelated code.
|
||||
- Never introduce insecure defaults.
|
||||
- Never log secrets or auth tokens.
|
||||
- Keep behavior backward-compatible unless the change explicitly requires a migration.
|
||||
|
||||
## Add-on Config Coupling Rules (Critical)
|
||||
|
||||
When adding/changing any add-on option, update **all** of the following in one change:
|
||||
|
||||
1. `openclaw_assistant_dev/config.yaml`
|
||||
- `options:` default
|
||||
- `schema:` validation entry
|
||||
- comments/help text
|
||||
2. `openclaw_assistant_dev/translations/en.yaml`
|
||||
3. `openclaw_assistant_dev/translations/bg.yaml`
|
||||
4. `openclaw_assistant_dev/translations/de.yaml`
|
||||
5. `openclaw_assistant_dev/translations/es.yaml`
|
||||
6. `openclaw_assistant_dev/translations/pl.yaml`
|
||||
7. `openclaw_assistant_dev/translations/pt-BR.yaml`
|
||||
8. `DOCS.md` configuration reference / troubleshooting if user-facing
|
||||
9. `openclaw_assistant_dev/CHANGELOG.md`
|
||||
|
||||
If any of these are skipped, the UX becomes inconsistent in HA.
|
||||
|
||||
## Runtime Safety Rules
|
||||
|
||||
- `run.sh` runs with `set -euo pipefail`; avoid constructs that fail unexpectedly under `set -e`.
|
||||
- Validate all user-provided values from `/data/options.json` before injecting into shell/nginx/openclaw config.
|
||||
- Keep `run.sh` idempotent on restart (multiple starts must not corrupt state).
|
||||
- Treat `/config/` as persistent state; never wipe user data unless explicitly requested.
|
||||
|
||||
## Gateway/Auth/Security Rules
|
||||
|
||||
- OpenClaw v2026.2.22+ redacts sensitive values in `openclaw config get`.
|
||||
- For token retrieval guidance, prefer: `jq -r '.gateway.auth.token' /config/.openclaw/openclaw.json`.
|
||||
- `trusted-proxy` mode may reject direct local CLI WS calls (`trusted_proxy_user_missing`); document this clearly instead of hiding it.
|
||||
- For `lan_https` certificate logic, keep SAN generation deterministic and regeneration-triggered on SAN/IP changes.
|
||||
|
||||
## Template Coupling Rules
|
||||
|
||||
- If adding placeholders in `landing.html.tpl` or `nginx.conf.tpl`, update `render_nginx.py` in the same change.
|
||||
- If landing-page guidance changes (commands/errors), sync corresponding troubleshooting text in `DOCS.md`.
|
||||
|
||||
## Versioning and Changelog
|
||||
|
||||
- User-visible changes should update:
|
||||
- `openclaw_assistant_dev/CHANGELOG.md`
|
||||
- `openclaw_assistant_dev/config.yaml` version
|
||||
- Keep changelog entries user-facing and action-oriented.
|
||||
|
||||
## Coding Style
|
||||
|
||||
- Shell: POSIX-friendly Bash, explicit quoting, descriptive variable names.
|
||||
- Python: small focused helpers, explicit error handling, no hidden side effects.
|
||||
- YAML/Markdown: preserve existing style and structure.
|
||||
- Avoid adding dependencies unless necessary.
|
||||
|
||||
## Validation Checklist (Run After Relevant Changes)
|
||||
|
||||
From repo root:
|
||||
|
||||
```sh
|
||||
bash -n openclaw_assistant_dev/run.sh
|
||||
python3 -m py_compile openclaw_assistant_dev/oc_config_helper.py
|
||||
python3 -m py_compile openclaw_assistant_dev/render_nginx.py
|
||||
```
|
||||
|
||||
For option changes:
|
||||
- verify `config.yaml` option + schema + all translations exist
|
||||
- verify `DOCS.md` matches current behavior
|
||||
|
||||
For startup/auth/proxy/cert changes:
|
||||
- verify log messages remain clear and actionable
|
||||
- verify `landing.html.tpl` instructions match actual commands
|
||||
|
||||
## Commit Scope
|
||||
|
||||
- Group related changes only.
|
||||
- Do not include unrelated formatting churn.
|
||||
- Do not edit generated/cache folders (`__pycache__`, temporary outputs).
|
||||
@@ -29,7 +29,7 @@ The add-on container runs three services:
|
||||
| Service | Port | Purpose |
|
||||
|---|---|---|
|
||||
| **OpenClaw Gateway** | 18789 (configurable) | The AI agent server — handles skills, chat, automations |
|
||||
| **nginx** (Ingress proxy) | 8099 (fixed) | Serves the landing page inside Home Assistant |
|
||||
| **nginx** (Ingress proxy) | 48099 (fixed) | Serves the landing page inside Home Assistant |
|
||||
| **ttyd** (Web terminal) | 7681 (configurable) | Provides a browser-based terminal for setup and management |
|
||||
|
||||
When you open the add-on page in Home Assistant, nginx serves a landing page with:
|
||||
@@ -43,9 +43,11 @@ When you open the add-on page in Home Assistant, nginx serves a landing page wit
|
||||
| `/config/` | Yes | All user data — survives add-on updates and rebuilds |
|
||||
| `/config/.openclaw/` | Yes | OpenClaw configuration (`openclaw.json`), skills, agent data |
|
||||
| `/config/clawd/` | Yes | Agent workspace (ClawHub-installed skills, files) |
|
||||
| `/config/.node_global/` | Yes | User-installed npm packages (skills installed via dashboard) |
|
||||
| `/config/.node_global/` | Optional | User-installed npm packages when `persist_node_global=true` |
|
||||
| `/config/secrets/` | Yes | Tokens (e.g., `homeassistant.token`) |
|
||||
| `/config/keys/` | Yes | SSH keys (e.g., router SSH key) |
|
||||
| `/config/.linuxbrew/` | Optional | Homebrew install and brew-installed CLI tools when `persist_brew_tools=true` |
|
||||
| `/config/gogcli/` | Yes | gog OAuth credentials for Google APIs |
|
||||
| `/usr/lib/node_modules/openclaw/` | No | OpenClaw installation (rebuilt with each image update) |
|
||||
|
||||
> **Important**: Everything under `/config/` persists across add-on updates. The container filesystem (`/usr/`, `/opt/`, etc.) is rebuilt each time the image changes.
|
||||
@@ -87,6 +89,8 @@ openclaw onboard
|
||||
|
||||
This interactive wizard walks you through connecting your AI providers (OpenAI, Google, Anthropic, etc.) and basic configuration.
|
||||
|
||||
> **Note (v0.5.54+)**: If onboarding triggers a gateway runtime restart, the add-on now keeps nginx/terminal alive and auto-recovers the runtime instead of restarting the whole container.
|
||||
|
||||
Alternatively, for more granular control:
|
||||
|
||||
```sh
|
||||
@@ -98,17 +102,20 @@ openclaw configure
|
||||
The gateway requires a token for authentication. To retrieve it:
|
||||
|
||||
```sh
|
||||
openclaw config get gateway.auth.token
|
||||
jq -r '.gateway.auth.token' /config/.openclaw/openclaw.json
|
||||
```
|
||||
|
||||
> **Note**: Since OpenClaw v2026.2.22+ `openclaw config get` redacts sensitive values (returns `openclaw_redacted`). Read the token directly from the config file with `jq` as shown above.
|
||||
|
||||
Save this token — you'll need it to access the Gateway Web UI and for API integrations.
|
||||
|
||||
### Step 3 — Verify everything works
|
||||
|
||||
1. In the terminal, confirm the gateway is running:
|
||||
```sh
|
||||
openclaw gateway status
|
||||
oc-gateway status
|
||||
```
|
||||
> In this add-on, the gateway is supervised by `run.sh` (not systemd), so `openclaw gateway status` can show misleading service-manager warnings.
|
||||
2. Click the **Open Gateway Web UI** button on the landing page
|
||||
3. If prompted for a token, paste the one from Step 2 or go to the Overview tab, paste the token in the 'Gateway Token' field and press Connect.
|
||||
|
||||
@@ -118,39 +125,70 @@ Save this token — you'll need it to access the Gateway Web UI and for API inte
|
||||
|
||||
The Gateway Web UI (Control UI) is OpenClaw's main web interface. It opens in a **separate browser tab** because Home Assistant's Ingress proxy has WebSocket limitations.
|
||||
|
||||
### Setting up the "Open Gateway Web UI" button
|
||||
> **Important (v2026.2.21+):** OpenClaw now requires a **secure context** (HTTPS or localhost) for the Control UI. Plain HTTP over LAN is no longer accepted. The add-on's `access_mode` option makes this easy — see below.
|
||||
>
|
||||
> **v2026.2.22 note:** The gateway now emits a startup security warning when `dangerouslyDisableDeviceAuth` is active (used by `lan_https` mode). This warning is **expected and safe to ignore** — token authentication is still enforced.
|
||||
|
||||
Set `gateway_public_url` in the add-on configuration to the URL where the gateway is reachable from your browser.
|
||||
### Choosing an access mode
|
||||
|
||||
**Examples**:
|
||||
- LAN: `http://192.168.1.119:18789`
|
||||
- Public HTTPS: `https://example.duckdns.org:12345`
|
||||
Set `access_mode` in **Settings → Add-ons → OpenClaw Assistant → Configuration**:
|
||||
|
||||
The button opens: `<gateway_public_url>/?token=<your_token>`
|
||||
| Mode | Best for | What it does |
|
||||
|---|---|---|
|
||||
| **`lan_https`** | Phones, tablets, LAN browsers | Adds a built-in HTTPS proxy inside the add-on. No external setup needed. |
|
||||
| **`lan_reverse_proxy`** | Users with NPM / Caddy / Traefik | Binds gateway to LAN; your proxy terminates TLS. |
|
||||
| **`tailnet_https`** | Tailscale users | Binds to Tailscale interface; use Tailscale HTTPS certs. |
|
||||
| **`local_only`** | Terminal/Ingress only | Loopback — gateway not reachable from other devices. |
|
||||
| **`custom`** | Advanced / backward compat | Uses the individual `gateway_bind_mode` / `gateway_auth_mode` settings. |
|
||||
|
||||
### How to make the Gateway reachable
|
||||
### Method A — Built-in HTTPS proxy (`lan_https` — recommended)
|
||||
|
||||
Choose the method that fits your setup:
|
||||
|
||||
#### Method A — HTTPS via reverse proxy (recommended)
|
||||
|
||||
If you use a reverse proxy (e.g., Nginx Proxy Manager, Caddy, Traefik, Cloudflare Tunnel), configure it to also forward the gateway port (default 18789) with HTTPS. This is the most secure option and avoids browser security warnings.
|
||||
|
||||
> **Note**: Nabu Casa remote access only proxies the Home Assistant UI (port 8123) — it cannot forward custom ports like 18789. The add-on's Ingress page (landing + terminal) works through Nabu Casa, but the Gateway Web UI requires a reverse proxy or LAN access.
|
||||
|
||||
#### Method B — LAN HTTP access (most common)
|
||||
|
||||
Enable LAN access via the add-on configuration:
|
||||
This is the simplest way to get secure LAN access, especially for phones and tablets.
|
||||
|
||||
1. Go to **Settings → Add-ons → OpenClaw Assistant → Configuration**
|
||||
2. Set:
|
||||
- `gateway_bind_mode`: **lan**
|
||||
- `gateway_port`: **18789** (or your preferred port)
|
||||
- `allow_insecure_auth`: **true** (required for HTTP — see below)
|
||||
- `gateway_public_url`: `http://<your-ha-ip>:18789`
|
||||
2. Set `access_mode`: **lan_https**
|
||||
3. Restart the add-on
|
||||
|
||||
#### Method C — SSH port forwarding (secure, no config changes)
|
||||
**What happens automatically:**
|
||||
- The add-on generates a local CA certificate and a TLS server certificate
|
||||
- nginx listens on the gateway port (default 18789) with HTTPS on all interfaces
|
||||
- The gateway process itself binds to loopback on an internal port (gateway_port + 1)
|
||||
- The landing page shows a **Download CA Certificate** button
|
||||
|
||||
**Phone/tablet setup (one-time):**
|
||||
1. Open the add-on page in HA and click **Download CA Certificate**
|
||||
2. Install the certificate on your device:
|
||||
- **Android**: Settings → Security → Install certificate → CA certificate → select file
|
||||
- **iOS**: Open the `.crt` file → Install Profile → Settings → General → About → Certificate Trust Settings → enable the OpenClaw CA
|
||||
3. After installing the CA, your browser will trust the gateway without warnings
|
||||
|
||||
> **Note**: If you skip CA installation, you can still access the gateway — just accept the browser's certificate warning once.
|
||||
|
||||
### Method B — HTTPS via external reverse proxy (tested recipe: NPM)
|
||||
|
||||
Use this when you already run Nginx Proxy Manager (or Caddy/Traefik).
|
||||
|
||||
**OpenClaw add-on settings**
|
||||
1. Set `access_mode`: **lan_reverse_proxy**
|
||||
2. Set `gateway_trusted_proxies` to your proxy source CIDR/IP.
|
||||
- Example for NPM add-on network: `172.30.0.0/16`
|
||||
- Or strict single IP: `172.30.x.y/32`
|
||||
3. Set `gateway_public_url` to your final HTTPS URL (example: `https://openclaw.example.com`)
|
||||
4. Restart OpenClaw add-on
|
||||
|
||||
**NPM host config (known-good pattern)**
|
||||
1. Create Proxy Host: `openclaw.example.com`
|
||||
2. Forward to: `http://<HA-LAN-IP>:18789`
|
||||
3. Enable **Websockets Support**
|
||||
4. SSL tab: request/attach certificate, enable **Force SSL**
|
||||
5. Add custom header for trusted-proxy auth:
|
||||
- `X-Forwarded-User: openclaw`
|
||||
|
||||
Then open `https://openclaw.example.com`.
|
||||
|
||||
> **Important**: Nabu Casa remote access only proxies port 8123. It does not expose custom add-on ports directly.
|
||||
|
||||
### Method C — SSH port forwarding (secure, no config changes)
|
||||
|
||||
Forward the gateway port from your HA host to your local machine:
|
||||
|
||||
@@ -158,27 +196,60 @@ Forward the gateway port from your HA host to your local machine:
|
||||
ssh -L 18789:127.0.0.1:18789 your-user@your-ha-ip
|
||||
```
|
||||
|
||||
Then open `http://localhost:18789` in your browser. No need to change `gateway_bind_mode` or `allow_insecure_auth`.
|
||||
Then open `http://localhost:18789` in your browser. `localhost` counts as a secure context.
|
||||
|
||||
> **Limitation**: SSH forwarding doesn't work on phones/tablets. Use `lan_https` for mobile access.
|
||||
|
||||
### Method D — Tailnet flow (tested with HA Tailscale add-on + NPM)
|
||||
|
||||
This is the practical flow users report as stable in HAOS.
|
||||
|
||||
1. In **Tailscale add-on**:
|
||||
- Disable `userspace_networking` (must be `false` so other add-ons can reach tailnet interface)
|
||||
2. In **OpenClaw add-on**:
|
||||
- Preferred: set `access_mode` to **tailnet_https**
|
||||
- Alternative (equivalent): `gateway_bind_mode: tailnet`, token auth
|
||||
3. In **NPM**:
|
||||
- Forward target to `http://<HA-TAILNET-IP>:18789`
|
||||
- Enable websockets
|
||||
- Configure TLS cert on the public host
|
||||
4. Set `gateway_public_url` to the final HTTPS URL and restart OpenClaw
|
||||
|
||||
> **Why this flow**: `tailnet_https` in this add-on is a bind/auth preset. It does not automatically run `tailscale serve` inside OpenClaw.
|
||||
|
||||
### Setting up the "Open Gateway Web UI" button
|
||||
|
||||
Set `gateway_public_url` in the add-on configuration to the URL where the gateway is reachable from your browser.
|
||||
|
||||
**Examples**:
|
||||
- LAN HTTPS (built-in): `https://192.168.1.119:18789`
|
||||
- External HTTPS: `https://openclaw.example.com`
|
||||
- Tailscale: `https://ha-machine.ts.net:18789`
|
||||
|
||||
> **Tip**: In `lan_https` mode, if you leave `gateway_public_url` empty, the add-on auto-constructs it from the detected LAN IP.
|
||||
|
||||
### Browser security: "requires HTTPS or localhost"
|
||||
|
||||
Modern browsers block certain features on plain HTTP (non-localhost). If you see this error:
|
||||
If you see:
|
||||
|
||||
> control ui requires HTTPS or localhost (secure context)
|
||||
> disconnected (1008): control ui requires device identity
|
||||
|
||||
**Solutions** (pick one):
|
||||
- **Use HTTPS** (Method A above) — best long-term
|
||||
- **Use SSH port forwarding** (Method C above) — `localhost` counts as secure
|
||||
- **Enable `allow_insecure_auth`** — quick workaround for LAN HTTP access
|
||||
This means the browser is connecting over plain HTTP. **Solutions**:
|
||||
- Set `access_mode` to **lan_https** (easiest — no external setup)
|
||||
- Set `access_mode` to **lan_reverse_proxy** and use an HTTPS reverse proxy
|
||||
- Use SSH port forwarding to `localhost` (desktop only)
|
||||
|
||||
### Unauthorized error
|
||||
|
||||
If the Gateway UI shows **Unauthorized**, re-check your token:
|
||||
|
||||
```sh
|
||||
openclaw config get gateway.auth.token
|
||||
jq -r '.gateway.auth.token' /config/.openclaw/openclaw.json
|
||||
```
|
||||
|
||||
> **Note**: Since OpenClaw v2026.2.22+ `openclaw config get` redacts sensitive values — use `jq` to read directly from the config file.
|
||||
|
||||
---
|
||||
|
||||
## 5. Configuration Reference
|
||||
@@ -196,11 +267,21 @@ All options are set via **Settings → Apps/Add-ons → OpenClaw Assistant → C
|
||||
| Option | Type | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `gateway_mode` | `local` / `remote` | `local` | **local**: run gateway in this add-on. **remote**: connect to an external gateway |
|
||||
| `gateway_bind_mode` | `loopback` / `lan` | `loopback` | **loopback**: 127.0.0.1 only (secure). **lan**: all interfaces (LAN-accessible). Only applies when `gateway_mode` is `local` |
|
||||
| `gateway_remote_url` | string | _(empty)_ | Remote gateway WebSocket URL used when `gateway_mode: remote` (example: `ws://192.168.1.20:18789` or `wss://gateway.example.com:443`) |
|
||||
| `gateway_bind_mode` | `loopback` / `lan` / `tailnet` | `loopback` | **loopback**: 127.0.0.1 only (secure). **lan**: all interfaces (LAN-accessible). **tailnet**: Tailscale interface only. Only applies when `gateway_mode` is `local` |
|
||||
| `gateway_port` | int | `18789` | Port for the gateway. Only applies when `gateway_mode` is `local` |
|
||||
| `gateway_public_url` | string | _(empty)_ | Public URL for the "Open Gateway Web UI" button. Example: `http://192.168.1.119:18789` |
|
||||
| `access_mode` | `custom` / `local_only` / `lan_https` / `lan_reverse_proxy` / `tailnet_https` | `custom` | **Simplifies secure access setup.** `custom`: use individual settings (backward-compatible). `lan_https`: built-in HTTPS proxy for LAN (recommended for phones). `lan_reverse_proxy`: external reverse proxy. `tailnet_https`: Tailscale. `local_only`: Ingress only. See [Accessing the Gateway Web UI](#4-accessing-the-gateway-web-ui) |
|
||||
| `gateway_public_url` | string | _(empty)_ | Public URL for the "Open Gateway Web UI" button. Auto-constructed in `lan_https` mode if empty. Example: `https://192.168.1.119:18789`. In newer versions this origin is also merged into `gateway.controlUi.allowedOrigins` to reduce reverse-proxy origin errors. |
|
||||
| `enable_openai_api` | bool | `false` | Enable the OpenAI-compatible `/v1/chat/completions` endpoint. Required for [Assist pipeline integration](#6c-assist-pipeline-integration-openai-api) |
|
||||
| `allow_insecure_auth` | bool | `false` | Allow HTTP (non-HTTPS) authentication on LAN. **Required** for browser access over plain HTTP |
|
||||
| `gateway_auth_mode` | `token` / `trusted-proxy` | `token` | Gateway auth mode. Use `trusted-proxy` when terminating HTTPS in a reverse proxy and forwarding trusted auth headers. |
|
||||
| `gateway_trusted_proxies` | string | _(empty)_ | Comma-separated trusted proxy IP/CIDR list used with `gateway_auth_mode: trusted-proxy`. |
|
||||
| `gateway_additional_allowed_origins` | string | _(empty)_ | Comma-separated additional origins merged into `gateway.controlUi.allowedOrigins` in `lan_https` mode (example: `https://ha.example.com:8443,capacitor://localhost`). |
|
||||
| `controlui_disable_device_auth` | bool | `true` | Controls `gateway.controlUi.dangerouslyDisableDeviceAuth` in `lan_https` mode. **ON (recommended):** skip per-device pairing approval, avoid error 1008 on LAN HTTPS, token auth still required. **OFF:** enforce per-device pairing prompts (stricter, but more friction). |
|
||||
| `force_ipv4_dns` | bool | `true` | Force IPv4-first DNS ordering for Node network calls. **Recommended ON** — most HAOS VMs lack IPv6 egress, causing `web_fetch` and Telegram timeouts. Set to `false` only if your network has working IPv6. |
|
||||
| `gateway_env_vars` | list of `{name, value}` | `[]` | Environment variables exported to the gateway process at startup. UI format: list entries with `name` and `value` (example: `name=OPENAI_API_KEY`, `value=sk-...`). Limits: max 50 vars, key length 255, value length 10000. Reserved runtime keys are blocked (for example `PATH`, `HOME`, `NODE_OPTIONS`, `NODE_PATH`, `OPENCLAW_*`, proxy vars). Legacy string/object formats are still accepted for backward compatibility. |
|
||||
| `nginx_log_level` | `full` / `minimal` | `minimal` | Nginx access log verbosity. `minimal` suppresses repetitive Home Assistant health-check and polling requests (`GET /`, `GET /v1/models`). `full` logs everything. |
|
||||
|
||||
When `gateway_auth_mode: trusted-proxy` is used, the add-on sets `gateway.auth.trustedProxy.userHeader` to `x-forwarded-user` by default.
|
||||
|
||||
### Terminal
|
||||
|
||||
@@ -214,6 +295,7 @@ All options are set via **Settings → Apps/Add-ons → OpenClaw Assistant → C
|
||||
| Option | Type | Default | Description |
|
||||
|---|---|---|---|
|
||||
| `homeassistant_token` | string | _(empty)_ | Optional HA long-lived access token (use at own risk, can be very unsecure but very powerful). Saved to `/config/secrets/homeassistant.token` for use by scripts/skills |
|
||||
| `http_proxy` | string | _(empty)_ | Optional outbound proxy URL for HTTP/HTTPS requests from OpenClaw and Node tools. Example: `http://192.168.2.1:3128` |
|
||||
|
||||
### Router SSH
|
||||
|
||||
@@ -233,43 +315,55 @@ To provide the SSH key: place the private key file in the add-on config director
|
||||
|---|---|---|---|
|
||||
| `clean_session_locks_on_start` | bool | `true` | Remove stale session lock files on startup (safe — only removes locks when gateway isn't running) |
|
||||
| `clean_session_locks_on_exit` | bool | `true` | Remove session lock files on clean shutdown |
|
||||
|
||||
| `persist_node_global` | bool | `false` | Persist user-installed npm global skills/packages in `/config/.node_global/`. Turn on only if you want those installs to survive add-on rebuilds. |
|
||||
| `persist_brew_tools` | bool | `false` | Persist Homebrew and brew-installed CLI tools in `/config/.linuxbrew/`. Turn on only if you want those installs to survive add-on rebuilds. |
|
||||
| `auto_configure_mcp` | bool | `false` | Auto-register Home Assistant as an MCP server on startup (requires `homeassistant_token`) |
|
||||
---
|
||||
|
||||
## 6. Use Case Guides
|
||||
|
||||
### 6a. LAN Access Setup
|
||||
|
||||
This is the most common setup — accessing the Gateway Web UI from a browser on your local network.
|
||||
This is the most common setup — accessing the Gateway Web UI from a browser on your local network (including phones and tablets).
|
||||
|
||||
> **Since OpenClaw v2026.2.21**, the Control UI requires a secure context (HTTPS or localhost). Use the `access_mode` option for easy setup.
|
||||
|
||||
#### Option 1 — Built-in HTTPS proxy (recommended)
|
||||
|
||||
1. Go to **Settings → Add-ons → OpenClaw Assistant → Configuration**
|
||||
2. Set `access_mode`: **lan_https**
|
||||
3. Restart the add-on
|
||||
4. Click the **Open Gateway Web UI** button — it uses HTTPS automatically
|
||||
|
||||
**Phone/tablet (one-time):** Click **Download CA Certificate** on the landing page, then install it on your device for trusted access without browser warnings.
|
||||
|
||||
#### Option 2 — External reverse proxy
|
||||
|
||||
1. Go to **Settings → Add-ons → OpenClaw Assistant → Configuration**
|
||||
2. Set these options:
|
||||
|
||||
| Option | Value |
|
||||
|---|---|
|
||||
| `gateway_bind_mode` | **lan** |
|
||||
| `gateway_port` | **18789** |
|
||||
| `allow_insecure_auth` | **true** |
|
||||
| `gateway_public_url` | `http://<your-ha-ip>:18789` |
|
||||
| `access_mode` | **lan_reverse_proxy** |
|
||||
| `gateway_trusted_proxies` | **127.0.0.1,192.168.88.0/24** |
|
||||
| `gateway_public_url` | `https://<your-domain>` |
|
||||
|
||||
3. Restart the add-on
|
||||
4. Open the **Open Gateway Web UI** button — it should now work from any device on your LAN
|
||||
3. Configure your reverse proxy to forward HTTPS to `<HA-IP>:18789`
|
||||
4. Restart the add-on
|
||||
|
||||
**Security note**: `allow_insecure_auth` allows authentication over plain HTTP. This is fine on a trusted home network but should not be used over the internet. For public access, use HTTPS.
|
||||
**Security note**: Always use HTTPS for Control UI access. The `lan_https` mode handles this automatically; for reverse proxy setups, ensure your proxy terminates TLS.
|
||||
|
||||
### 6b. Remote Gateway Mode
|
||||
|
||||
If you have an OpenClaw gateway running on a different machine (e.g., a more powerful server), you can configure this add-on to connect to it instead of running its own.
|
||||
|
||||
1. Set `gateway_mode`: **remote**
|
||||
2. In the add-on terminal, configure the remote gateway URL:
|
||||
```sh
|
||||
openclaw config set gateway.url <remote-gateway-url>
|
||||
```
|
||||
2. Set `gateway_remote_url` in add-on configuration (example: `wss://gateway.example.com:443`)
|
||||
3. Restart the add-on
|
||||
|
||||
When `gateway_mode` is `remote`:
|
||||
- The add-on does **not** start a local gateway process
|
||||
- The add-on writes `gateway.remote.url` from `gateway_remote_url` on startup
|
||||
- `gateway_bind_mode` and `gateway_port` are ignored
|
||||
- The terminal and landing page still work normally
|
||||
- You still need the remote gateway's auth token
|
||||
@@ -278,12 +372,15 @@ When `gateway_mode` is `remote`:
|
||||
|
||||
OpenClaw's Gateway exposes an **OpenAI-compatible Chat Completions endpoint** (`POST /v1/chat/completions`). This lets you use OpenClaw as a **conversation agent** in Home Assistant's Assist pipeline — enabling voice control, automations, and smart home commands.
|
||||
|
||||
#### Prerequisites
|
||||
There are two ways to connect it to Home Assistant:
|
||||
|
||||
- [HACS](https://hacs.xyz/) installed on your Home Assistant
|
||||
- [Extended OpenAI Conversation](https://github.com/jekalmin/extended_openai_conversation) integration
|
||||
---
|
||||
|
||||
#### Step 1 — Enable the endpoint
|
||||
#### Option 1 — OpenClaw Integration (recommended)
|
||||
|
||||
The **native OpenClaw integration** provides auto-discovery, a Lovelace chat card, voice mode, tool invocation services, and status sensors — all in one package.
|
||||
|
||||
**Step 1 — Enable the endpoint**
|
||||
|
||||
In the add-on configuration, set `enable_openai_api`: **true**, then restart.
|
||||
|
||||
@@ -292,19 +389,77 @@ Or via terminal:
|
||||
openclaw config set gateway.http.endpoints.chatCompletions.enabled true
|
||||
```
|
||||
|
||||
#### Step 2 — Install Extended OpenAI Conversation
|
||||
**Step 2 — Install the OpenClaw integration**
|
||||
|
||||
Via HACS:
|
||||
1. In HACS, add as a custom repository:
|
||||
- Repository: `https://github.com/techartdev/OpenClawHomeAssistantIntegration`
|
||||
- Category: **Integration**
|
||||
2. Install and restart Home Assistant
|
||||
|
||||
Or manually: copy `custom_components/openclaw` from the repo into your HA config directory.
|
||||
|
||||
**Step 3 — Add the integration**
|
||||
|
||||
1. Go to **Settings → Devices & Services → Add Integration**
|
||||
2. Search for **OpenClaw**
|
||||
3. If the addon is running locally, it will be **auto-discovered** — just click Submit
|
||||
4. If connecting to a remote instance, fill in host, port, token, and SSL settings manually
|
||||
|
||||
> **`lan_https` mode**: The integration auto-detects this and connects to the internal gateway port on loopback — no certificate setup needed for local addons.
|
||||
|
||||
**Step 4 — Set as conversation agent**
|
||||
|
||||
1. Go to **Settings → Voice Assistants**
|
||||
2. Edit your assistant (or create a new one)
|
||||
3. Under **Conversation agent**, select **OpenClaw**
|
||||
|
||||
**Step 5 — Expose entities**
|
||||
|
||||
Go to **Settings → Voice Assistants → Expose** and toggle on the entities you want OpenClaw to control.
|
||||
|
||||
**Step 6 — Add the chat card (optional)**
|
||||
|
||||
The integration auto-registers a Lovelace card. Add it to any dashboard:
|
||||
```yaml
|
||||
type: custom:openclaw-chat-card
|
||||
```
|
||||
|
||||
The card includes message history, typing indicator, voice input, wake-word support, and TTS responses.
|
||||
|
||||
> **Works with standalone OpenClaw too.** The integration doesn't require the HA addon — it connects to any reachable OpenClaw gateway over HTTP/HTTPS. See the [integration README](https://github.com/techartdev/OpenClawHomeAssistantIntegration) for remote connection details.
|
||||
|
||||
---
|
||||
|
||||
#### Option 2 — Extended OpenAI Conversation (alternative)
|
||||
|
||||
If you prefer to use the [Extended OpenAI Conversation](https://github.com/jekalmin/extended_openai_conversation) integration instead:
|
||||
|
||||
**Prerequisites:**
|
||||
- [HACS](https://hacs.xyz/) installed on your Home Assistant
|
||||
|
||||
**Step 1 — Enable the endpoint**
|
||||
|
||||
In the add-on configuration, set `enable_openai_api`: **true**, then restart.
|
||||
|
||||
Or via terminal:
|
||||
```sh
|
||||
openclaw config set gateway.http.endpoints.chatCompletions.enabled true
|
||||
```
|
||||
|
||||
**Step 2 — Install Extended OpenAI Conversation**
|
||||
|
||||
1. In HACS, add as a custom repository:
|
||||
- Repository: `https://github.com/jekalmin/extended_openai_conversation`
|
||||
- Category: **Integration**
|
||||
2. Install and restart Home Assistant
|
||||
|
||||
#### Step 3 — Configure the integration
|
||||
**Step 3 — Configure the integration**
|
||||
|
||||
1. Go to **Settings → Devices & Services → Add Integration**
|
||||
2. Search for **Extended OpenAI Conversation**
|
||||
3. Configure:
|
||||
- **API Key**: your gateway token (`openclaw config get gateway.auth.token`)
|
||||
- **API Key**: your gateway token — run `jq -r '.gateway.auth.token' /config/.openclaw/openclaw.json` in the terminal
|
||||
- **Base URL**: `http://127.0.0.1:18789/v1`
|
||||
- **API Version**: leave empty
|
||||
- **Organization**: leave empty
|
||||
@@ -312,13 +467,13 @@ openclaw config set gateway.http.endpoints.chatCompletions.enabled true
|
||||
|
||||
> If using `gateway_bind_mode: lan`, you can also use `http://<your-ha-ip>:18789/v1` — this allows other HA instances on your network to connect too.
|
||||
|
||||
#### Step 4 — Set as conversation agent
|
||||
**Step 4 — Set as conversation agent**
|
||||
|
||||
1. Go to **Settings → Voice Assistants**
|
||||
2. Edit your assistant (or create a new one)
|
||||
3. Under **Conversation agent**, select **Extended OpenAI Conversation**
|
||||
|
||||
#### Step 5 — Expose entities
|
||||
**Step 5 — Expose entities**
|
||||
|
||||
Go to **Settings → Voice Assistants → Expose** and toggle on the entities you want OpenClaw to control.
|
||||
|
||||
@@ -328,6 +483,71 @@ You can now use Assist (voice or text) and OpenClaw will handle conversations, c
|
||||
|
||||
The add-on includes **Chromium** for browser-based automation tasks. OpenClaw can use it for web scraping, form filling, website testing, and other browser automation skills.
|
||||
|
||||
### 6d-mcp. MCP Integration (Home Assistant Control)
|
||||
|
||||
The **Model Context Protocol (MCP)** lets OpenClaw communicate directly with Home Assistant — reading entity states, calling services, creating automations, and more. This is the recommended way to give OpenClaw full control over your smart home.
|
||||
|
||||
#### Automatic setup (recommended)
|
||||
|
||||
1. Create a **long-lived access token** in Home Assistant:
|
||||
- Go to your HA profile page (click your user avatar at the bottom of the sidebar)
|
||||
- Scroll to **Long-Lived Access Tokens** → **Create Token**
|
||||
- Give it a name (e.g. "OpenClaw") and copy the token
|
||||
2. Paste the token into the add-on option **Home Assistant Token** (`homeassistant_token`) in **Settings → Add-ons → OpenClaw Assistant → Configuration**
|
||||
3. Set **Auto-Configure MCP for Home Assistant** (`auto_configure_mcp`) to **ON**
|
||||
4. Restart the add-on
|
||||
|
||||
The add-on bundles `mcporter` and automatically registers Home Assistant as an MCP server named `HA`. It auto-detects the HA API URL (supervisor proxy when available, otherwise `localhost:8123`). Check the logs for:
|
||||
```
|
||||
INFO: MCP server 'HA' registered — OpenClaw can now control Home Assistant
|
||||
```
|
||||
|
||||
On subsequent restarts, the configuration is skipped if the token hasn’t changed.
|
||||
|
||||
#### Manual setup
|
||||
|
||||
If you prefer to configure MCP manually (or `auto_configure_mcp` is off), run this in the add-on terminal:
|
||||
|
||||
```sh
|
||||
mcporter config add HA "http://localhost:8123/api/mcp" \
|
||||
--header "Authorization=Bearer YOUR_LONG_LIVED_TOKEN" \
|
||||
--scope home
|
||||
```
|
||||
|
||||
Replace `YOUR_LONG_LIVED_TOKEN` with your HA long-lived access token.
|
||||
|
||||
#### Verifying MCP works
|
||||
|
||||
After setup, ask OpenClaw something like:
|
||||
- _"Turn off the living room lights"_
|
||||
- _"What’s the temperature of the bedroom sensor?"_
|
||||
- _"List all entities in the kitchen"_
|
||||
|
||||
If OpenClaw can execute HA actions, MCP is working.
|
||||
|
||||
#### Refreshing HA context after upgrades
|
||||
|
||||
If OpenClaw has stale or missing Home Assistant data after an upgrade, run:
|
||||
|
||||
```sh
|
||||
mcporter call home-assistant.GetLiveContext
|
||||
```
|
||||
|
||||
This refreshes the entity/service metadata that OpenClaw uses.
|
||||
|
||||
#### Model requirements
|
||||
|
||||
MCP setup requires an AI model that understands tool/skill invocation. Budget models (e.g. Gemini 2.5 Flash) may struggle with the initial MCP discovery. For the **first-time setup**, use a capable model (e.g. Gemini 3.1 Pro, Claude Sonnet 4, GPT-4.1). After MCP is configured, you can switch back to a cheaper model for daily use.
|
||||
|
||||
#### Troubleshooting MCP
|
||||
|
||||
| Symptom | Fix |
|
||||
|---|---|
|
||||
| `mcporter: command not found` | Upgrade to add-on `0.5.84` or newer. Older builds did not bundle `mcporter`; as a temporary workaround, install it manually in the add-on terminal and restart. |
|
||||
| MCP add fails with auth error | Verify your long-lived token is valid and not expired |
|
||||
| OpenClaw doesn’t see HA entities | Run `mcporter call home-assistant.GetLiveContext` to refresh |
|
||||
| Model says “what’s MCP?” | Switch to a more capable model for the initial session (see above) |
|
||||
|
||||
To enable it, add to `/config/.openclaw/openclaw.json`:
|
||||
|
||||
```json
|
||||
@@ -366,6 +586,59 @@ If you have skills or scripts that need SSH access to a router, firewall, or oth
|
||||
|
||||
The connection details are also saved to `/config/CONNECTION_NOTES.txt` for reference by scripts.
|
||||
|
||||
### 6f. Google Sheets / Google APIs (gog OAuth)
|
||||
|
||||
Some OpenClaw skills use [gog](https://github.com/deftdawg/gog) to interact with Google APIs (Sheets, Drive, etc.). Because the add-on runs inside a container, the standard browser-based OAuth flow won't work — the localhost redirect can't reach your PC. Use the **manual** flow instead.
|
||||
|
||||
#### Step 1 — Prepare OAuth credentials
|
||||
|
||||
1. Go to [Google Cloud Console](https://console.cloud.google.com/) → **APIs & Services → Credentials**
|
||||
2. Create an **OAuth 2.0 Client ID** (type: **Web application**) or use an existing one
|
||||
3. In the client's **Authorized redirect URIs**, add: `http://localhost:1`
|
||||
4. Download the client JSON file and copy it into the add-on:
|
||||
```sh
|
||||
# From your PC, copy the file to the HA config directory
|
||||
# Then in the add-on terminal:
|
||||
mkdir -p /config/secrets
|
||||
# Place the downloaded JSON as:
|
||||
/config/secrets/gmail_oauth_client.json
|
||||
```
|
||||
|
||||
#### Step 2 — Register credentials with gog
|
||||
|
||||
```sh
|
||||
gog auth credentials /config/secrets/gmail_oauth_client.json
|
||||
```
|
||||
|
||||
This tells gog where to find your OAuth client configuration.
|
||||
|
||||
#### Step 3 — Authorize with `--manual`
|
||||
|
||||
```sh
|
||||
gog auth add your-email@gmail.com --services sheets --manual
|
||||
```
|
||||
|
||||
The `--manual` flag avoids the localhost redirect problem. gog will:
|
||||
|
||||
1. Print an authorization URL — **open it in your PC's browser**
|
||||
2. Sign in with your Google account and grant access
|
||||
3. You'll be redirected to a URL starting with `http://localhost:1?...` — the page will fail to load, **that's expected**
|
||||
4. **Copy the full URL** from your browser's address bar
|
||||
5. Paste it back into the add-on terminal when prompted
|
||||
6. If prompted for a **passphrase**, enter one to encrypt the stored token (remember it — you'll need it if gog asks again)
|
||||
|
||||
#### Step 4 — Verify
|
||||
|
||||
```sh
|
||||
gog auth list
|
||||
```
|
||||
|
||||
You should see your account listed with the `sheets` service.
|
||||
|
||||
> **Why `--manual`?** The default OAuth flow starts a temporary HTTP server on localhost to receive the callback. Since the add-on runs on your HA device (not your PC), the browser redirect to `localhost` can't reach the add-on's server. The `--manual` flag skips the local server and lets you paste the redirect URL directly.
|
||||
|
||||
> **Persistence**: gog stores credentials under `/config/gogcli/` which is persistent storage — your auth survives add-on updates.
|
||||
|
||||
---
|
||||
|
||||
## 7. Data Persistence & Skills
|
||||
@@ -378,10 +651,12 @@ The connection details are also saved to `/config/CONNECTION_NOTES.txt` for refe
|
||||
| Built-in skills | `/config/.openclaw/skills/` | Yes |
|
||||
| Agent sessions & data | `/config/.openclaw/agents/` | Yes |
|
||||
| ClawHub workspace | `/config/clawd/` | Yes |
|
||||
| User-installed npm skills | `/config/.node_global/` | Yes |
|
||||
| User-installed npm skills | `/config/.node_global/` | Optional (`persist_node_global=true`) |
|
||||
| SSH keys | `/config/keys/` | Yes |
|
||||
| Tokens | `/config/secrets/` | Yes |
|
||||
| Homebrew-installed tools | `/home/linuxbrew/` | **No** — container filesystem |
|
||||
| Homebrew & brew-installed tools | `/config/.linuxbrew/` | Optional (`persist_brew_tools=true`) |
|
||||
| gog OAuth credentials | `/config/gogcli/` | Yes |
|
||||
| TLS certificates (lan_https) | `/config/certs/` | Yes (CA persists; server cert regenerated if IP changes) |
|
||||
| OpenClaw binary | `/usr/lib/node_modules/openclaw/` | **No** — reinstalled from image |
|
||||
|
||||
### How built-in skills work
|
||||
@@ -396,13 +671,21 @@ This means built-in skills survive image rebuilds, and any customizations you ma
|
||||
|
||||
### How user-installed skills work
|
||||
|
||||
When you install a skill via the OpenClaw dashboard or `npm install -g`, the add-on redirects global npm installs to `/config/.node_global/`. This directory persists across updates.
|
||||
By default, user-installed npm skills and global packages are **ephemeral** to keep Home Assistant backups small.
|
||||
|
||||
The add-on also configures `pnpm` global directory to persistent storage at `/config/.node_global/pnpm/`.
|
||||
If you enable `persist_node_global`, the add-on redirects global npm installs to `/config/.node_global/` so dashboard-installed skills survive add-on rebuilds. The add-on also configures the pnpm global directory at `/config/.node_global/pnpm/` in that mode.
|
||||
|
||||
### Homebrew-installed tools
|
||||
|
||||
Some skills depend on CLI tools installed via Homebrew (e.g., `gemini`, `aider`). These are installed into `/home/linuxbrew/` which is **not persistent** — they are lost on image rebuild. Skills will typically reinstall their dependencies automatically when needed.
|
||||
By default, Homebrew (Linuxbrew) and brew-installed CLI tools are **ephemeral** to keep Home Assistant backups small.
|
||||
|
||||
If you enable `persist_brew_tools`, the add-on:
|
||||
|
||||
1. Syncs the image's Homebrew install to `/config/.linuxbrew/`
|
||||
2. Creates a symlink from `/home/linuxbrew/.linuxbrew/` to the persistent copy
|
||||
3. On subsequent boots, only newer files are synced (user-installed packages are preserved)
|
||||
|
||||
This means `brew install` packages survive image rebuilds only when persistence is enabled.
|
||||
|
||||
---
|
||||
|
||||
@@ -427,6 +710,27 @@ The add-on image includes these tools, available in the terminal:
|
||||
| Homebrew | `brew` | Package manager (optional — may not be available on all CPUs) |
|
||||
| Chromium | `chromium` | Headless browser for automation |
|
||||
| SSH | `ssh` | Remote access |
|
||||
| oc-cleanup | `oc-cleanup` | Interactive disk space monitor & cache cleanup helper |
|
||||
| oc-gateway | `oc-gateway status` / `oc-gateway restart` | Add-on-native gateway status/restart helper (`run.sh` supervised, no systemd) |
|
||||
|
||||
### oc-cleanup
|
||||
|
||||
Run `oc-cleanup` from the add-on terminal to see an overview of disk usage and
|
||||
selectively clear caches that accumulate over time:
|
||||
|
||||
```
|
||||
$ oc-cleanup
|
||||
```
|
||||
|
||||
The tool displays:
|
||||
|
||||
- **Disk usage** — total, used, available, and percentage for the overlay filesystem.
|
||||
- **Cache sizes** — npm global cache, pnpm content store, OpenClaw data, Homebrew cellar, workspace, Python `__pycache__`, and `/tmp`.
|
||||
- **Cleanup menu** — choose which caches to purge (npm, pnpm, pycache, tmp, all at once).
|
||||
|
||||
> **Note:** The add-on cannot prune Docker images directly. If disk space is
|
||||
> critically low due to old Docker layers, SSH into the host and run
|
||||
> `docker image prune -a` or `docker system prune`.
|
||||
|
||||
---
|
||||
|
||||
@@ -443,7 +747,7 @@ Home Assistant checks for add-on updates automatically. When an update is availa
|
||||
**What happens during an update**:
|
||||
- The container is destroyed and recreated from the new image
|
||||
- Everything under `/config/` is preserved (config, skills, workspace, keys)
|
||||
- Homebrew packages are lost (reinstalled by skills on demand)
|
||||
- Homebrew and npm global packages are preserved only if you explicitly enable `persist_brew_tools` / `persist_node_global`
|
||||
- The OpenClaw binary is updated to the version in the new image
|
||||
|
||||
### Checking your version
|
||||
@@ -456,7 +760,20 @@ openclaw --version
|
||||
|
||||
### Backup
|
||||
|
||||
Home Assistant's built-in backup system automatically includes add-on configuration data (`/config/`). This covers all persistent data: OpenClaw config, skills, workspace, keys, and tokens.
|
||||
Home Assistant's built-in backup system automatically includes add-on configuration data (`/config/`). By default this covers the important user state: OpenClaw config, skills, workspace, keys, and tokens — without large optional toolchains.
|
||||
|
||||
### Backup-friendly defaults (v0.5.75+)
|
||||
|
||||
Starting with v0.5.75, the add-on keeps large optional toolchains out of backups by default:
|
||||
|
||||
- `persist_node_global: false` → `/config/.node_global/` is not used unless you opt in
|
||||
- `persist_brew_tools: false` → `/config/.linuxbrew/` is not used unless you opt in
|
||||
|
||||
Turn these on only if you specifically want user-installed npm global skills or brew-installed CLI tools to survive add-on rebuilds.
|
||||
|
||||
### Migration note for older installs
|
||||
|
||||
If you used an older add-on version, you may already have legacy directories such as `/config/.node_global/` or `/config/.linuxbrew/` from previous persistent behavior. Disabling persistence stops future growth, but those directories still count toward backup size until you remove or archive them manually.
|
||||
|
||||
**To create a backup**: Go to **Settings → System → Backups → Create Backup**
|
||||
|
||||
@@ -465,7 +782,8 @@ Home Assistant's built-in backup system automatically includes add-on configurat
|
||||
# Key paths to back up:
|
||||
# /config/.openclaw/ - OpenClaw config, skills, agent data
|
||||
# /config/clawd/ - ClawHub workspace
|
||||
# /config/.node_global/ - User-installed npm skills
|
||||
# /config/.node_global/ - User-installed npm skills (only if persist_node_global=true)
|
||||
# /config/.linuxbrew/ - Homebrew tools (only if persist_brew_tools=true)
|
||||
# /config/keys/ - SSH keys
|
||||
# /config/secrets/ - Tokens
|
||||
```
|
||||
@@ -475,12 +793,12 @@ Home Assistant's built-in backup system automatically includes add-on configurat
|
||||
To reset the add-on to a clean state, remove the persistent data:
|
||||
|
||||
```sh
|
||||
rm -rf /config/.openclaw /config/clawd /config/.node_global
|
||||
rm -rf /config/.openclaw /config/clawd /config/.node_global /config/.linuxbrew
|
||||
```
|
||||
|
||||
Then restart the add-on. It will re-bootstrap a fresh configuration.
|
||||
|
||||
> **Warning**: This deletes all your OpenClaw configuration, skills, and workspace data. Back up first if needed.
|
||||
> **Warning**: This deletes all your OpenClaw configuration, skills, workspace data, and any optionally persisted tool installations. Back up first if needed.
|
||||
|
||||
---
|
||||
|
||||
@@ -490,9 +808,9 @@ Then restart the add-on. It will re-bootstrap a fresh configuration.
|
||||
|
||||
Go to **Settings → Add-ons → OpenClaw Assistant → Log** tab. Logs show startup messages, errors, and service status.
|
||||
|
||||
### Port 8099 conflict (add-on page won't load)
|
||||
### Port 48099 conflict (add-on page won't load)
|
||||
|
||||
**Symptom**: `bind() to 0.0.0.0:8099 failed (98: Address already in use)` in logs.
|
||||
**Symptom**: `bind() to 0.0.0.0:48099 failed (98: Address already in use)` in logs.
|
||||
|
||||
**Cause**: A stale nginx process from a previous run is still holding the port. This can happen after a crash or unclean restart.
|
||||
|
||||
@@ -509,34 +827,147 @@ Go to **Settings → Add-ons → OpenClaw Assistant → Log** tab. Logs show sta
|
||||
**Symptom**: Browser shows connection refused when opening the Gateway Web UI.
|
||||
|
||||
**Checks**:
|
||||
1. Is the gateway running? In the terminal: `openclaw gateway status`
|
||||
2. Is the bind mode correct? `openclaw config get gateway.bind` — must be `lan` for LAN access
|
||||
1. Is the gateway running? In the terminal: `oc-gateway status`
|
||||
2. Is the bind mode correct? `openclaw config get gateway.bind` — must be `lan` for direct LAN access, or `loopback` if using `lan_https` mode
|
||||
3. Is the port correct? `openclaw config get gateway.port`
|
||||
4. Is the firewall blocking the port? Check your HA host firewall rules
|
||||
|
||||
### Gateway restart loop: `web_search provider is not available: brave`
|
||||
|
||||
**Symptom**: Logs repeat `Invalid config at /config/.openclaw/openclaw.json` and `tools.web.search.provider: web_search provider is not available: brave`.
|
||||
|
||||
**Cause**: The persisted OpenClaw config selects the Brave web search provider, but that provider plugin is not currently installed or enabled in the add-on runtime.
|
||||
|
||||
**Fix**: In v0.5.72+ the add-on clears that unavailable provider automatically during startup. On older versions, run this in the add-on terminal, then restart:
|
||||
|
||||
```sh
|
||||
jq 'del(.tools.web.search.provider)' /config/.openclaw/openclaw.json > /tmp/openclaw.json && mv /tmp/openclaw.json /config/.openclaw/openclaw.json
|
||||
```
|
||||
|
||||
### "disconnected (1008): control ui requires device identity" / "requires HTTPS or localhost"
|
||||
|
||||
**Symptom**: Gateway UI shows error 1008 or "requires secure context / device identity".
|
||||
|
||||
**Cause**: OpenClaw v2026.2.21+ requires HTTPS or localhost. Plain HTTP over LAN is blocked. (v2026.2.22 further hardens this by defaulting remote onboarding to `wss://` and rejecting insecure non-loopback targets.)
|
||||
|
||||
**Fix** (pick one):
|
||||
1. **Easiest**: Set `access_mode` to **lan_https** in add-on Configuration → restart. This adds a built-in HTTPS proxy with zero external setup.
|
||||
2. **External proxy**: Set `access_mode` to **lan_reverse_proxy** and configure NPM/Caddy/Traefik with TLS.
|
||||
3. **SSH tunnel** (desktop only): `ssh -L 18789:127.0.0.1:18789 user@ha-ip` then open `http://localhost:18789`.
|
||||
|
||||
### "disconnected (1008): origin not allowed"
|
||||
|
||||
**Symptom**: Gateway UI shows `origin not allowed (open the Control UI from the gateway host or allow it in gateway.controlUi.allowedOrigins)`.
|
||||
|
||||
**Cause**: OpenClaw v2026.2.21+ checks the browser's `Origin` header against an allow-list. When using the built-in HTTPS proxy (`lan_https`), the origin (`https://<ip>:<port>`) must be registered in `gateway.controlUi.allowedOrigins`.
|
||||
|
||||
**Fix**: In **v0.5.50+** defaults are configured automatically on startup. In **v0.5.54+**, the add-on now merges defaults with existing values and user extras.
|
||||
1. Restart the add-on (the startup script detects LAN IP and updates origins).
|
||||
2. If needed, set `gateway_additional_allowed_origins` in add-on configuration (comma-separated), then restart.
|
||||
3. If the IP has changed since you last started, restart again — the cert and defaults are refreshed.
|
||||
4. **Manual override** (advanced, from the add-on terminal):
|
||||
```sh
|
||||
openclaw config set gateway.controlUi.allowedOrigins '["https://192.168.1.10:18789"]'
|
||||
```
|
||||
Then restart the add-on to re-merge defaults + extras.
|
||||
|
||||
### "disconnected (1008): pairing required"
|
||||
|
||||
**Symptom**: Gateway UI loads over HTTPS but shows `pairing required` and the status is Offline.
|
||||
|
||||
**Cause**: OpenClaw v2026.2.21+ requires new devices to complete a pairing handshake before the Control UI WebSocket is accepted. Loopback connections are auto-approved (v2026.2.22 further improves this with loopback scope-upgrade auto-approval), but LAN connections (including those through the HTTPS proxy) require explicit approval.
|
||||
|
||||
**Fix**: In **v0.5.50+** the add-on configures `gateway.controlUi.dangerouslyDisableDeviceAuth` in `lan_https` mode. By default it is enabled (`controlui_disable_device_auth: true`) to bypass per-device pairing while still enforcing token auth. If you prefer stricter behavior, set `controlui_disable_device_auth: false` and approve new devices manually.
|
||||
|
||||
> **v2026.2.22 note:** The gateway now logs a security warning on startup when this flag is active. The warning is expected and harmless — run `openclaw security audit` for details.
|
||||
|
||||
1. **Restart the add-on** — the startup script writes the config before launching the gateway.
|
||||
2. If the error persists, set it manually:
|
||||
```sh
|
||||
nano /config/.openclaw/openclaw.json
|
||||
```
|
||||
Ensure `gateway.controlUi` contains:
|
||||
```json
|
||||
"controlUi": {
|
||||
"dangerouslyDisableDeviceAuth": true,
|
||||
"allowedOrigins": ["https://YOUR_IP:18789"]
|
||||
}
|
||||
```
|
||||
Then restart only the gateway process: `oc-gateway restart`
|
||||
3. Alternatively, approve devices individually without disabling auth:
|
||||
```sh
|
||||
openclaw devices list # show pending pairing requests
|
||||
openclaw devices approve <requestId>
|
||||
```
|
||||
|
||||
### Gateway UI shows "Unauthorized"
|
||||
|
||||
**Fix**: Get the correct token and use it:
|
||||
|
||||
```sh
|
||||
openclaw config get gateway.auth.token
|
||||
jq -r '.gateway.auth.token' /config/.openclaw/openclaw.json
|
||||
```
|
||||
|
||||
> **Note**: Since OpenClaw v2026.2.22+ `openclaw config get` redacts sensitive values (returns `openclaw_redacted`). Use `jq` to read the token directly from the config file.
|
||||
|
||||
Paste this token when the UI prompts for authentication, or append it to the URL: `http://<ip>:18789/?token=<your-token>`
|
||||
|
||||
### CLI shows unauthorized with `trusted_proxy_user_missing`
|
||||
|
||||
**Symptom**: In add-on terminal, commands that open direct gateway WebSocket (for example some `openclaw status`/gateway probes) fail with unauthorized and logs mention `trusted_proxy_user_missing`.
|
||||
|
||||
**Cause**: `gateway_auth_mode: trusted-proxy` expects identity headers from your reverse proxy. Direct local CLI connections are not proxied, so they may be rejected.
|
||||
|
||||
**What to do**:
|
||||
- Keep `trusted-proxy` for browser traffic via your reverse proxy.
|
||||
- For local terminal workflows that require direct gateway auth, temporarily switch to `gateway_auth_mode: token` (or run via proxy path that injects trusted headers), then switch back if needed.
|
||||
|
||||
### Terminal not visible
|
||||
|
||||
1. Check that `enable_terminal` is **true** in the add-on configuration
|
||||
2. Check logs for `Starting web terminal (ttyd)` — if missing, the terminal is disabled
|
||||
3. If you see a port conflict error, change `terminal_port` to a different value
|
||||
|
||||
### `web_fetch failed: fetch failed` / HTTP tool calls time out
|
||||
|
||||
**Symptom**: OpenClaw's `web_fetch` tool (or any outbound HTTP call from a skill) fails with `fetch failed`.
|
||||
|
||||
**Cause**: Node 22 uses `autoSelectFamily` which tries IPv6 first. Most HAOS VMs have IPv6 DNS resolution but no IPv6 egress, so connections time out before falling back to IPv4.
|
||||
|
||||
**Fix**: Ensure `force_ipv4_dns` is **true** (default since v0.5.51). If you upgraded from an older version, the option may still be set to `false` — change it to `true` in **Settings → Add-ons → OpenClaw Assistant → Configuration** and restart.
|
||||
|
||||
### Telegram network errors (`TypeError: fetch failed` / `getUpdates` fails)
|
||||
|
||||
If Telegram is configured but polling fails with network fetch errors:
|
||||
|
||||
1. In add-on terminal, test IPv4 vs IPv6 explicitly:
|
||||
```sh
|
||||
curl -4 https://api.telegram.org/bot<token>/getMe
|
||||
curl -6 https://api.telegram.org/bot<token>/getMe
|
||||
```
|
||||
2. If IPv4 works but default/IPv6 fails, ensure add-on option `force_ipv4_dns` is `true` (default) and restart.
|
||||
3. Keep `channels.telegram.network.autoSelectFamily: false` (default on Node 22).
|
||||
4. If still failing, check host/VM IPv6 routing and DNS configuration.
|
||||
|
||||
### Outbound proxy not applied
|
||||
|
||||
**Symptom**: External API/network calls still fail in restricted networks even after setting proxy.
|
||||
|
||||
**Checks**:
|
||||
1. Set add-on option `http_proxy` with full URL format: `http://host:port` (example: `http://192.168.2.1:3128`).
|
||||
2. Restart the add-on after changing configuration.
|
||||
3. Check logs for `INFO: Outbound HTTP/HTTPS proxy enabled from add-on configuration.`
|
||||
4. If you see `WARN: Invalid http_proxy value`, fix the URL format and restart.
|
||||
|
||||
When proxy is enabled, add-on startup also applies default bypass ranges via `NO_PROXY`/`no_proxy` for localhost and private network ranges.
|
||||
|
||||
### Skills disappearing after update
|
||||
|
||||
Built-in skills are synced to persistent storage on each startup. If skills are missing:
|
||||
|
||||
1. Check logs for `INFO: Synced built-in skills to persistent storage` — this confirms the sync ran
|
||||
2. If you see `WARN: Built-in skills directory not found`, the OpenClaw installation may be corrupted. Try reinstalling the add-on.
|
||||
3. User-installed skills (via dashboard) are stored in `/config/.node_global/` and should survive updates
|
||||
3. User-installed skills (via dashboard) survive updates only when `persist_node_global` is enabled. With the default backup-friendly setting (`false`), they are ephemeral and may need to be reinstalled after an add-on rebuild.
|
||||
|
||||
### Homebrew errors / CPU compatibility
|
||||
|
||||
@@ -571,6 +1002,40 @@ rm /config/.openclaw/openclaw.json
|
||||
|
||||
Restart the add-on — it will generate a fresh config. You'll need to run `openclaw onboard` again.
|
||||
|
||||
### Disk space running low / "no space left on device"
|
||||
|
||||
**Symptom**: Build or startup fails, or the landing page shows a red disk-usage indicator.
|
||||
|
||||
**Cause**: Old Docker images and container layers accumulate on the host. Each add-on rebuild (~1–2 GB) keeps the previous image until pruned.
|
||||
|
||||
**Fix (from inside the add-on)**:
|
||||
1. Open the terminal and run `oc-cleanup` to clear npm/pnpm caches, pycache, and temp files.
|
||||
|
||||
**Fix (from the host)** — you need a **root shell on the HAOS host**, not the `ha` CLI
|
||||
(the `ha docker` command does **not** support `prune`):
|
||||
|
||||
*Option A — Advanced SSH & Web Terminal add-on (easiest):*
|
||||
1. Install the **Advanced SSH & Web Terminal** add-on from the HA store.
|
||||
2. In its Configuration, **disable Protection Mode** (required for host-level access).
|
||||
3. Open the terminal and run:
|
||||
```sh
|
||||
docker image prune -a # remove all unused images
|
||||
docker builder prune -a # remove build cache
|
||||
```
|
||||
|
||||
*Option B — HAOS debug console (VirtualBox / physical):*
|
||||
1. On the HAOS console (keyboard/VirtualBox window), type `login` to get a root shell.
|
||||
2. Run the same `docker image prune -a` and `docker builder prune -a` commands.
|
||||
|
||||
> **Note:** The `ha docker` CLI (shown by `ha docker --help`) only exposes `info`,
|
||||
> `options`, and `registries` — it cannot prune images. You must use the raw `docker`
|
||||
> command from a host root shell.
|
||||
|
||||
**Prevention**: If running HAOS in VirtualBox, resize the VDI to at least 64 GB:
|
||||
```
|
||||
VBoxManage modifymedium disk haos.vdi --resize 64000
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 11. FAQ
|
||||
@@ -582,13 +1047,15 @@ Yes. The add-on supports aarch64 (Raspberry Pi 4/5) and armv7 (Raspberry Pi 3).
|
||||
OpenClaw supports multiple agent profiles. Configure them via `openclaw configure` or by editing `/config/.openclaw/openclaw.json`. The gateway serves all configured agents.
|
||||
|
||||
**Can I use a remote gateway?**
|
||||
Yes. Set `gateway_mode` to `remote` and configure the remote gateway URL via `openclaw config set gateway.url <url>`. See [Remote Gateway Mode](#6b-remote-gateway-mode).
|
||||
Yes. Set `gateway_mode` to `remote` and set `gateway_remote_url` in add-on configuration. The add-on syncs it into OpenClaw config automatically. See [Remote Gateway Mode](#6b-remote-gateway-mode).
|
||||
|
||||
**How do I change the AI model or provider?**
|
||||
Run `openclaw configure` in the terminal to reconfigure your AI providers, or edit `/config/.openclaw/openclaw.json` directly. You can use OpenAI, Google (Gemini), Anthropic (Claude), local models, and more.
|
||||
|
||||
**Can other devices on my network use the OpenClaw API?**
|
||||
Yes, if you set `gateway_bind_mode` to `lan`. Any device on your network can connect to `http://<ha-ip>:18789`. Use the gateway token for authentication. This also enables the [Assist pipeline integration](#6c-assist-pipeline-integration-openai-api) from other HA instances.
|
||||
Yes. Set `access_mode` to `lan_https` (recommended) or `lan_reverse_proxy`. Any device on your network can connect to `https://<ha-ip>:18789`. Use the gateway token for authentication. This also enables the [Assist pipeline integration](#6c-assist-pipeline-integration-openai-api) from other HA instances or standalone OpenClaw integrations.
|
||||
|
||||
**Where is my data stored on the host?**
|
||||
The add-on's `/config/` directory maps to `/addon_configs/<slug>/` on the Home Assistant host. This is included in HA backups automatically.
|
||||
|
||||
The add-on also mounts Home Assistant `/share` and `/media` as writable paths inside the container (`/share`, `/media`) for file access workflows. These are separate from OpenClaw's default persistent workspace under `/config`.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2026 Vanyo (techartdev)
|
||||
Copyright (c) 2026 Vanyo Vanev (techartdev)
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
@@ -1,7 +1,11 @@
|
||||
# OpenClaw Assistant – Home Assistant Add-on
|
||||
# OpenClaw Assistant – Home Assistant App/Add-on
|
||||
|
||||
## [Join our Discord Server!](https://discord.gg/Nx4H3XmY)
|
||||

|
||||
## [Join our Discord Server!](https://discord.gg/xeHeKu9jYp)
|
||||
<img width="1038" height="597" alt="image" src="https://github.com/user-attachments/assets/6dae3918-7bad-4e89-9695-c7f549e8abda" />
|
||||
<img width="1536" height="542" alt="ChatGPT Image Feb 25, 2026, 11_37_02 PM" src="https://github.com/user-attachments/assets/ea662d87-5414-4c01-ac48-cb8f731a4988" />
|
||||
|
||||
|
||||
### OpenClaw Home Assistant integration is available now! https://github.com/techartdev/OpenClawHomeAssistantIntegration
|
||||
|
||||
This repository contains a Home Assistant add-on that runs **OpenClaw** inside **Home Assistant OS (HAOS)**.
|
||||
|
||||
@@ -13,6 +17,7 @@ This repository contains a Home Assistant add-on that runs **OpenClaw** inside *
|
||||
- **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
|
||||
- **Proxy Support** — optional outbound `http_proxy` setting for HTTP/HTTPS traffic
|
||||
- **Persistent Storage** — skills, config, and workspace survive add-on updates
|
||||
- **Bundled Tools** — git, vim, nano, bat, fd, ripgrep, curl, jq, python3, pnpm, Homebrew
|
||||
|
||||
@@ -37,6 +42,10 @@ This repository contains a Home Assistant add-on that runs **OpenClaw** inside *
|
||||
- `https://github.com/techartdev/OpenClawHomeAssistant`
|
||||
4. Install **OpenClaw Assistant**
|
||||
|
||||
## Star History
|
||||
|
||||
[](https://www.star-history.com/#techartdev/OpenClawHomeAssistant&type=date&legend=top-left)
|
||||
|
||||
## 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:
|
||||
|
||||
+5
-1
@@ -42,6 +42,8 @@ OpenClaw is an **agentic AI assistant** — it can plan, reason, and execute act
|
||||
|
||||
When `gateway_bind_mode` is set to `lan`, the gateway is accessible to **all devices on your local network**. When exposed to the internet (via port forwarding or reverse proxy), it becomes accessible to **anyone**.
|
||||
|
||||
When `gateway_bind_mode` is set to `tailnet`, the gateway is exposed only on your Tailscale network. This significantly reduces exposure compared with `lan`, but all authenticated tailnet peers can still reach it.
|
||||
|
||||
**Risks**:
|
||||
- Unauthorized users could interact with your AI agent
|
||||
- API tokens could be intercepted over plain HTTP
|
||||
@@ -51,6 +53,7 @@ When `gateway_bind_mode` is set to `lan`, the gateway is accessible to **all dev
|
||||
- Use HTTPS whenever possible (reverse proxy with TLS)
|
||||
- Never expose the gateway port directly to the internet without authentication and encryption
|
||||
- Use `gateway_bind_mode: loopback` if you only need local access
|
||||
- Prefer `gateway_bind_mode: tailnet` over `lan` when you need remote/private-network access
|
||||
- Keep your gateway auth token secret
|
||||
|
||||
### 3. Plain HTTP Authentication (`allow_insecure_auth`)
|
||||
@@ -147,7 +150,8 @@ AI agents that process external content (web pages, documents, emails) are vulne
|
||||
| Practice | Priority |
|
||||
|---|---|
|
||||
| Use HTTPS for remote access | High |
|
||||
| Keep `gateway_bind_mode: loopback` unless LAN access is needed | High |
|
||||
| Keep `gateway_bind_mode: loopback` unless network access is needed | High |
|
||||
| Prefer `gateway_bind_mode: tailnet` over `lan` for remote/private access | High |
|
||||
| Only install skills from trusted sources | High |
|
||||
| Review exposed entities in Assist pipeline | High |
|
||||
| Keep the add-on updated | High |
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 65 KiB After Width: | Height: | Size: 68 KiB |
@@ -0,0 +1,385 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to the OpenClaw Assistant Home Assistant Add-on will be documented in this file.
|
||||
|
||||
## [0.5.87] - 2026-08-10
|
||||
|
||||
### Fixed
|
||||
- Correct the bundled OpenClaw npm package version in the Docker image build for add-on `0.5.86`, fixing failed installs that requested the nonexistent `openclaw@2026.7.1-2-2`.
|
||||
|
||||
## [0.5.85] - 2026-07-21
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to `2026.7.1-2`.
|
||||
|
||||
## [0.5.84] - 2026-07-17
|
||||
|
||||
### Changed
|
||||
- Bundle `mcporter@0.12.3` in the add-on image so `auto_configure_mcp` can register Home Assistant out of the box on fresh installs without a manual global install workaround.
|
||||
- Replace the misleading startup hint that told users to run `openclaw onboard` when `mcporter` was missing. The message now correctly points to a broken image state instead.
|
||||
|
||||
## [0.5.82] - 2026-07-15
|
||||
|
||||
### Fixed
|
||||
- Repair add-on startup automatically when the bundled OpenClaw CLI is older than the persisted `/config/.openclaw/openclaw.json` format version. On mismatch, the add-on now restores the newer runtime before launching the gateway instead of silently coming up broken after a Home Assistant OS update or add-on rebuild.
|
||||
- Regenerate malformed `lan_https` CA/server certificates with proper X.509 extensions (`basicConstraints`, `keyUsage`, `extendedKeyUsage`) so Python/OpenSSL strict verification accepts the built-in HTTPS proxy certificates.
|
||||
|
||||
## [0.5.81] - 2026-07-14
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to `2026.7.1`.
|
||||
|
||||
## [0.5.80] - 2026-06-26
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to `2026.6.10`.
|
||||
|
||||
## [0.5.78] - 2026-06-16
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw through the `2026.5.28` and `2026.6.6` upstream releases.
|
||||
|
||||
## [0.5.76] - 2026-05-29
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to `2026.5.27`.
|
||||
|
||||
## [0.5.75] - 2026-05-28
|
||||
|
||||
### Changed
|
||||
- **Backup-friendly persistence defaults**: new add-on options `persist_node_global` and `persist_brew_tools`, both defaulting to `false` so large optional toolchains are no longer persisted into Home Assistant backups unless users explicitly opt in.
|
||||
- `run.sh` now keeps npm global installs and Homebrew ephemeral by default, while preserving the old rebuild-survival behavior when the new toggles are enabled.
|
||||
|
||||
### Added
|
||||
- Migration notes and documentation for older installs that already have legacy `/config/.node_global/` or `/config/.linuxbrew/` directories contributing to backup size.
|
||||
|
||||
## [0.5.74] - 2026-05-27
|
||||
|
||||
### Fixed
|
||||
- Bundle `node-llama-cpp` inside the add-on image so the default local memory/embeddings provider works in HAOS without manual package installs.
|
||||
- Add `cmake` to the image so `node-llama-cpp` can fall back to a source build when a prebuilt binary is unavailable for the target architecture.
|
||||
|
||||
## [0.5.73] - 2026-05-26
|
||||
|
||||
### Added
|
||||
- New add-on-native `oc-gateway` helper for container-supervised runtime management:
|
||||
- `oc-gateway status` shows gateway state in the HA add-on model (`run.sh` supervisor, not systemd)
|
||||
- `oc-gateway restart` requests gateway self-restart via `SIGUSR1` without full add-on restart
|
||||
|
||||
### Changed
|
||||
- Troubleshooting and setup docs now use `oc-gateway status` / `oc-gateway restart` in add-on contexts to avoid confusing systemd-related CLI output.
|
||||
|
||||
## [0.5.72] - 2026-05-04
|
||||
|
||||
### Fixed
|
||||
- Repair startup when a persisted OpenClaw config still selects the unavailable `tools.web.search.provider=brave` provider. The add-on now clears that provider before launching the gateway so OpenClaw can start; users can reinstall/enable the Brave provider later if they want web search through Brave.
|
||||
|
||||
## [0.5.71] - 2026-05-03
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw through the 2026.4.29 and 2026.5.2 upstream releases.
|
||||
|
||||
## [0.5.70] - 2026-04-30
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to 2026.4.27.
|
||||
|
||||
## [0.5.69] - 2026-04-27
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw through the 2026.4.23 and 2026.4.24 upstream releases.
|
||||
|
||||
## [0.5.68] - 2026-04-25
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw through the 2026.4.14, 2026.4.15, 2026.4.21, and 2026.4.22 upstream releases.
|
||||
|
||||
## [0.5.67] - 2026-04-25
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw through the 2026.4.5, 2026.4.8, 2026.4.9, 2026.4.10, 2026.4.11, and 2026.4.12 upstream releases.
|
||||
|
||||
## [0.5.66] - 2026-04-04
|
||||
|
||||
### Fixed
|
||||
- **"Open Gateway Web UI" button missing token on first boot / post-onboard** (issue #102): the gateway token was read once at startup, before `openclaw onboard` had a chance to write `openclaw.json`. The landing page now re-renders automatically in the background (up to ~2 min after startup) once the token appears in `openclaw.json`, and nginx is reloaded with SIGHUP — no add-on restart required. Existing installs with a token already present are unaffected.
|
||||
|
||||
## [0.5.65] - 2026-04-04
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to 2026.4.2.
|
||||
|
||||
## [0.5.63] - 2026-03-14
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to 2026.3.13.
|
||||
|
||||
## [0.5.62] - 2026-03-10
|
||||
|
||||
### Fixed
|
||||
- **Gateway restart loop** (issue #95): `openclaw gateway run` is a thin wrapper that spawns `openclaw-gateway` as a long-running daemon then exits immediately. On self-restart (SIGUSR1 / `openclaw gateway restart`), the old daemon forks a new one and exits — the new PID is not a child of run.sh. The supervisor now uses a 3-tier daemon detection function (`find_gateway_daemon_pid`): (1) port ownership via `ss -tlnp`, (2) process title via `pgrep -f "openclaw-gateway"`, (3) `/proc/*/cmdline` scan for "openclaw" (catches the daemon immediately after fork, even before process.title or port bind — critical on Pi/eMMC where initialization takes 20-30 s). Detection retries up to 10 times with a final port-occupancy guard before any supervisor-initiated restart. Non-child PIDs are monitored with `kill -0` polling instead of `wait`. The loopback relay (tailnet mode) is stopped/restarted around gateway restarts to prevent port conflicts.
|
||||
|
||||
## [0.5.61] - 2026-03-10
|
||||
|
||||
### Fixed
|
||||
- **Gateway restart loop** (issue #95): stop the tailnet loopback relay before supervisor-initiated gateway restarts and start it again after the new daemon is launched, preventing the relay from holding the local port and trapping the add-on in an `already listening` restart loop.
|
||||
|
||||
## [0.5.60] - 2026-03-10
|
||||
|
||||
### Fixed
|
||||
- **Session lock cleanup ignored non-default agents**: `cleanup_session_locks` was hardcoded to `agents/main/sessions`, skipping stale locks for any agent with a custom `forcedAgentId`. Stale locks could block the gateway from opening sessions for those agents, causing silent fallback to `main`. Cleanup now scans all `agents/*/sessions/` directories.
|
||||
|
||||
## [0.5.59] - 2026-03-10
|
||||
|
||||
- **Remote mode URL not propagated** (issue #93): `start_openclaw_runtime` was reading `gateway.remote.url` back via `openclaw config get`, which can time out (2 s limit at startup) or return an empty/redacted result. The function now uses `$GATEWAY_REMOTE_URL` directly from the already-parsed add-on options, which is the same value the config helper writes to `openclaw.json`.
|
||||
- **Terminal CLI unreachable in tailnet mode** (issue #90): when `gateway_bind_mode=tailnet` (or `access_mode=tailnet_https`), the gateway binds only to the Tailscale IP. The local CLI always connects via `ws://127.0.0.1:PORT`, causing "Gateway not running" inside the add-on terminal. A lightweight loopback relay (Node.js) is now started automatically to forward `127.0.0.1:PORT → TAILSCALE_IP:PORT`, making all terminal CLI commands work normally. Token auth is still enforced end-to-end by the gateway.
|
||||
- **Session lock cleanup ignored non-default agents**: `cleanup_session_locks` was hardcoded to `agents/main/sessions`, skipping stale locks for any agent with a custom `forcedAgentId`. Stale locks could block the gateway from opening sessions for those agents, causing silent fallback to `main`. Cleanup now scans all `agents/*/sessions/` directories.
|
||||
|
||||
### Added
|
||||
- **MCP auto-configuration for Home Assistant**: new option `auto_configure_mcp` (default: `false`). When enabled and `homeassistant_token` is set, the add-on automatically registers Home Assistant as an MCP server (`mcporter config add HA ...`) on startup. Auto-detects the HA API URL (supervisor proxy or localhost:8123). Re-configures only when the token changes.
|
||||
- Landing page: new collapsible **MCP setup** section with automatic and manual setup instructions, post-upgrade refresh command, and model tips.
|
||||
- DOCS: new **MCP Integration** guide covering automatic/manual setup, verification, model requirements, and troubleshooting.
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to 2026.3.9.
|
||||
|
||||
## [0.5.58] - 2026-03-08
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to 2026.3.7.
|
||||
|
||||
## [0.5.57] - 2026-03-07
|
||||
|
||||
### Added
|
||||
- New add-on option `controlui_disable_device_auth` (default: `true`) to control whether `gateway.controlUi.dangerouslyDisableDeviceAuth` is enabled in `lan_https` mode.
|
||||
|
||||
### Changed
|
||||
- `set-control-ui-origins` helper now accepts an explicit device-auth toggle and applies `dangerouslyDisableDeviceAuth` accordingly instead of forcing it on.
|
||||
- `run.sh` now forwards the add-on option to the config helper.
|
||||
- Control UI guidance text and docs were updated to explain when device-pairing bypass should be ON vs OFF.
|
||||
|
||||
### Fixed
|
||||
- Docker build stability: replaced NodeSource `setup_22.x | bash` installer with explicit keyring + apt source configuration for Node.js 22, avoiding intermittent `apt-get install nodejs` exit code 100 failures.
|
||||
|
||||
### Translations
|
||||
- Added `controlui_disable_device_auth` labels/descriptions to: `en`, `bg`, `de`, `es`, `pl`, `pt-BR`.
|
||||
|
||||
## [0.5.55] - 2026-03-04
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to 2026.3.2.
|
||||
|
||||
## [0.5.54] - 2026-02-25
|
||||
|
||||
### Changed
|
||||
- Added startup guidance when `gateway_auth_mode=trusted-proxy` is enabled to clarify why direct local CLI gateway calls can show `trusted_proxy_user_missing`/unauthorized.
|
||||
- Bump OpenClaw to 2026.2.24.
|
||||
|
||||
### Added
|
||||
- New add-on option `gateway_additional_allowed_origins` for extra Control UI origins in `lan_https` mode.
|
||||
- **Custom SANs in TLS certificate** (`lan_https` mode): hostnames and IPs from `gateway_additional_allowed_origins` and `gateway_public_url` are now included in the server certificate's Subject Alternative Name. The certificate auto-regenerates when SANs change.
|
||||
|
||||
### Fixed
|
||||
- **Gateway token on landing page**: read token directly from `openclaw.json` instead of via `openclaw config get` which redacts secrets since OpenClaw v2026.2.22+ (fixes "Open Gateway Web UI" button sending `openclaw_redacted` as the token).
|
||||
- **Token retrieval instructions**: all "get your token" references in the landing page and DOCS now use `jq -r '.gateway.auth.token' /config/.openclaw/openclaw.json` with a note explaining why the old `openclaw config get` command no longer works.
|
||||
- `lan_https` startup no longer overwrites `gateway.controlUi.allowedOrigins` with defaults only.
|
||||
- Control UI origins are now merged as: built-in defaults + existing config values + `gateway_additional_allowed_origins` (deduplicated).
|
||||
- In `lan_reverse_proxy` and other non-`lan_https` setups, Control UI origins now also include the origin derived from `gateway_public_url`.
|
||||
- `gateway.controlUi.allowedOrigins` configuration is now consistently applied via merge logic (defaults + existing values + user extras), reducing manual `openclaw.json` edits after upgrades.
|
||||
- Add-on no longer exits/restarts when OpenClaw runtime process is restarted during onboarding or config changes.
|
||||
- `run.sh` now supervises the OpenClaw runtime (`openclaw gateway run` / `openclaw node run`) and auto-restarts it while keeping nginx + terminal alive.
|
||||
|
||||
## [0.5.53] - 2026-02-24
|
||||
- Bump OpenClaw to 2026.2.23.
|
||||
|
||||
## [0.5.52] - 2026-02-23
|
||||
|
||||
### Added
|
||||
- New add-on option `gateway_env_vars` that accepts a list of `{name, value}` objects from Home Assistant UI and safely injects values into the gateway process at startup (max 50 vars, key <=255 chars, value <=10000 chars).
|
||||
- Guard `gateway_env_vars` from overriding reserved runtime/proxy/`OPENCLAW_*` keys.
|
||||
- Keep legacy string/object input formats for backward compatibility.
|
||||
|
||||
## [0.5.51] - 2026-02-23
|
||||
|
||||
### Fixed
|
||||
- **`web_fetch failed: fetch failed`**: changed `force_ipv4_dns` default to **true**. Node 22 tries IPv6 first; most HAOS VMs lack IPv6 egress, causing outbound `web_fetch` / HTTP tool calls to time out.
|
||||
|
||||
### Added
|
||||
- **`nginx_log_level` option** (`minimal` / `full`, default `minimal`): suppresses repetitive Home Assistant health-check and polling requests (`GET /`, `GET /v1/models`, `POST /tools/invoke`) from the nginx access log.
|
||||
|
||||
## [0.5.50] - 2026-02-23
|
||||
|
||||
**[!WARNING!]**
|
||||
This update contains lots of changes. It is adviced to backup before installing!
|
||||
|
||||
### Changed
|
||||
- **Upgraded OpenClaw to v2026.2.22-2** — includes major gateway/auth/pairing fixes and security hardening.
|
||||
- Precreate `$OPENCLAW_CONFIG_DIR/identity` on startup to prevent `EACCES` errors on CLI commands that need device identity.
|
||||
- Gateway token is auto-constructed from detected LAN IP when `lan_https` is active and `gateway_public_url` is empty.
|
||||
- Config helper now receives the effective internal port (gateway_port + 1 in lan_https mode).
|
||||
|
||||
### Notes — v2026.2.22 impact on this add-on
|
||||
- **Pairing fixes (loopback)**: v2026.2.22 auto-approves loopback scope-upgrade pairing requests, includes `operator.read`/`operator.write` in default scope bundles, and treats `operator.admin` as satisfying other scopes. This greatly improves `local_only` mode reliability.
|
||||
- **`dangerouslyDisableDeviceAuth` security warning**: v2026.2.22 now emits a startup warning when this flag is active. The warning is **expected and harmless** for `lan_https` mode — the flag is still required because LAN browser connections through the HTTPS proxy are not considered loopback by the gateway. Token auth remains enforced.
|
||||
- **Gateway lock improvements**: stale-lock detection now uses port reachability, reducing false "already running" errors after unclean restarts.
|
||||
- **Log file size cap**: new `logging.maxFileBytes` default (500 MB) prevents disk exhaustion from log storms.
|
||||
- **`wss://` default for remote onboarding**: validates our HTTPS proxy approach as the correct direction.
|
||||
|
||||
### Added
|
||||
- **Disk-space monitoring on the landing page** — shows total / used / available with colour-coded indicator (🟢 / 🟡 / 🔴).
|
||||
- **Low-disk warning banner** appears automatically when usage exceeds 90 %.
|
||||
- **`oc-cleanup` terminal command** — interactive helper that shows cache sizes (npm, pnpm, OpenClaw, Homebrew, pycache, tmp) and lets users reclaim space with a menu-driven cleanup.
|
||||
- Startup disk-space check with log warnings when the overlay is above 75 % or 90 %.
|
||||
- **`access_mode` preset option** — simplifies secure access configuration with one setting:
|
||||
- `custom` (default, backward-compatible): use individual gateway settings
|
||||
- `local_only`: loopback + token (Ingress/terminal only)
|
||||
- `lan_https`: **built-in HTTPS reverse proxy for LAN access** (recommended for phones/tablets)
|
||||
- `lan_reverse_proxy`: LAN bind + trusted-proxy for external reverse proxy (NPM, Caddy, Traefik)
|
||||
- `tailnet_https`: Tailscale interface bind + token auth
|
||||
- **Built-in TLS certificate generation** (`lan_https` mode):
|
||||
- Auto-generates a local CA + server certificate on first startup
|
||||
- Server cert is regenerated automatically when LAN IP changes
|
||||
- CA certificate downloadable from the landing page for one-tap phone trust
|
||||
- nginx HTTPS server block terminates TLS and proxies to the loopback gateway
|
||||
- **Overhauled landing page** with:
|
||||
- Real-time status cards (gateway health, secure context, access mode)
|
||||
- Access wizard with step-by-step guidance per mode
|
||||
- Error translation — maps raw errors like `1008: requires device identity` to friendly messages with fixes
|
||||
- CA certificate download button (lan_https mode)
|
||||
- Migration banner for users on `custom` mode recommending a preset
|
||||
- Collapsible reverse-proxy recipes (NPM / Caddy / Traefik / Tailscale)
|
||||
- Added `openssl` to Docker image for TLS certificate generation.
|
||||
- Translations for `access_mode` in all 6 languages (EN, BG, DE, ES, PL, PT-BR).
|
||||
|
||||
### Fixed
|
||||
- **`lan_https` — error 1008 "pairing required"**: auto-set `gateway.controlUi.dangerouslyDisableDeviceAuth: true` to skip interactive device pairing (token auth remains enforced). Replaces the invalid `pairingMode` key that caused `Unrecognized key` config errors.
|
||||
- Config helper now removes stale/invalid keys (e.g. `pairingMode`) from `controlUi` on startup.
|
||||
- Landing page error translation now covers "pairing required" and "origin not allowed" errors with correct fix guidance.
|
||||
- Dropdown translations for `access_mode`, `gateway_mode`, `gateway_bind_mode`, and `gateway_auth_mode` now show human-readable labels in all 6 languages.
|
||||
- **`lan_https` — error 1008 "origin not allowed"**: auto-configure `gateway.controlUi.allowedOrigins` with the HTTPS proxy origins (LAN IP, `homeassistant.local`, `homeassistant`) so the Control UI WebSocket is accepted.
|
||||
|
||||
## [0.5.49] - 2026-02-22
|
||||
|
||||
### Added
|
||||
- New add-on option `http_proxy` for configuring outbound HTTP/HTTPS proxy from Home Assistant settings.
|
||||
|
||||
### Changed
|
||||
- Export `HTTP_PROXY`, `HTTPS_PROXY`, `http_proxy`, and `https_proxy` from add-on config at startup.
|
||||
- Add translations for the new `http_proxy` option.
|
||||
- Document proxy configuration in README and DOCS.
|
||||
|
||||
## [0.5.48] - 2026-02-22
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to 2026.2.21-2.
|
||||
- Add Home Assistant `share` and `media` mounts to the add-on (`map: share:rw, media:rw`).
|
||||
- Keep official OpenClaw npm release and add startup proxy shim for `HTTP_PROXY/HTTPS_PROXY` support in undici fetch.
|
||||
|
||||
## [0.5.47] - 2026-02-21
|
||||
|
||||
### Added
|
||||
- Add new `gateway_bind_mode` values: `auto` and `tailnet`.
|
||||
|
||||
### Changed
|
||||
- Update startup helper validation and CLI usage to support `auto|loopback|lan|tailnet` bind modes.
|
||||
- Update add-on translations and docs for the expanded gateway bind mode options.
|
||||
|
||||
## [0.5.46] - 2026-02-18
|
||||
|
||||
### Added
|
||||
- New add-on option `force_ipv4_dns` to enable IPv4-first DNS ordering for Node network calls (`NODE_OPTIONS=--dns-result-order=ipv4first`), helping Telegram connectivity on IPv6-broken networks.
|
||||
|
||||
### Changed
|
||||
- Added translations for `force_ipv4_dns` option.
|
||||
- Updated docs with `force_ipv4_dns` configuration and Telegram network troubleshooting note.
|
||||
- Bump OpenClaw to 2026.2.17
|
||||
|
||||
## [0.5.45] - 2026-02-16
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to 2026.2.15
|
||||
|
||||
## [0.5.44] - 2026-02-14
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to 2026.2.13
|
||||
|
||||
## [0.5.43] - 2026-02-13
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to 2026.2.12
|
||||
|
||||
### Added
|
||||
- Portuguese (Brazil) translation (`pt-BR.yaml`) by medeirosiago
|
||||
|
||||
## [0.5.42] - 2026-02-12
|
||||
|
||||
### Changed
|
||||
- Change nginx ingress port from 8099 to 48099 to avoid conflicts with NextCloud and other services
|
||||
- Persist Homebrew and brew-installed packages across container rebuilds (symlink to `/config/.linuxbrew/`)
|
||||
|
||||
### Added
|
||||
- SECURITY.md with risk documentation and disclaimer
|
||||
|
||||
### Improved
|
||||
- Comprehensive DOCS.md overhaul (architecture, use cases, persistence, troubleshooting, FAQ)
|
||||
- README.md rewritten as concise landing page with quick start guide
|
||||
- New branding assets (icon.png, logo.png)
|
||||
- Added Discord server link to README
|
||||
|
||||
## [0.5.41] - 2026-02-11
|
||||
|
||||
### Changed
|
||||
- Update Dockerfile, config.yaml, and run.sh for enhancements
|
||||
- Update icon and logo images for improved quality
|
||||
|
||||
## [0.5.40] - 2026-02-11
|
||||
|
||||
### Added
|
||||
- Additional tools in Dockerfile
|
||||
|
||||
### Changed
|
||||
- Improved nginx process management in run.sh
|
||||
|
||||
## [0.5.39] - 2026-02-10
|
||||
|
||||
### Fixed
|
||||
- Fix OpenClaw installation command in Dockerfile
|
||||
|
||||
## [0.5.38] - 2026-02-10
|
||||
|
||||
### Changed
|
||||
- Bump OpenClaw to 2026.2.9
|
||||
|
||||
## [0.5.37] - 2026-02-09
|
||||
|
||||
### Added
|
||||
- OpenAI API integration for Home Assistant Assist pipeline
|
||||
- Updated translations
|
||||
|
||||
## [0.5.36] - 2026-02-08
|
||||
|
||||
### Changed
|
||||
- Documentation updates
|
||||
|
||||
## [0.5.35] - 2026-02-08
|
||||
|
||||
### Changed
|
||||
- Update Dockerfile for Homebrew installation improvements
|
||||
|
||||
## [0.5.34] - 2026-02-08
|
||||
|
||||
### Added
|
||||
- Install pnpm globally
|
||||
|
||||
### Changed
|
||||
- Upgrade OpenClaw version to 2026.2.6-3
|
||||
|
||||
## [0.5.33] - 2026-02-06
|
||||
|
||||
### Changed
|
||||
- Enhanced README with images and updated setup instructions
|
||||
|
||||
---
|
||||
|
||||
For the full commit history, see [GitHub commits](https://github.com/techartdev/OpenClawHomeAssistant/commits/main).
|
||||
@@ -4,7 +4,7 @@ FROM ${BUILD_FROM}
|
||||
# Base image is Debian Bookworm (glibc). This avoids musl-related native module issues
|
||||
# that occur on Alpine (e.g. clipboard, node-llama-cpp).
|
||||
|
||||
# Install base packages (without nodejs/npm - we'll get Node 22 from NodeSource)
|
||||
# Install base packages (without nodejs/npm - we'll get Node 24 from NodeSource)
|
||||
# build-essential provides gcc/cc needed by Homebrew for OpenClaw's brew-managed dependencies
|
||||
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
bash \
|
||||
@@ -18,6 +18,7 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
xz-utils \
|
||||
file \
|
||||
python3 \
|
||||
cmake \
|
||||
nginx \
|
||||
gnupg \
|
||||
build-essential \
|
||||
@@ -29,22 +30,36 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
rsync \
|
||||
bat \
|
||||
less \
|
||||
&& apt-get clean \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
openssl \
|
||||
&& apt-get clean \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Install Node.js 22 LTS from NodeSource (Debian Bookworm ships Node 18, but OpenClaw requires 20+)
|
||||
RUN curl -fsSL https://deb.nodesource.com/setup_22.x | bash - \
|
||||
&& apt-get install -y nodejs \
|
||||
&& apt-get clean \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
# Install Node.js 24 LTS from NodeSource.
|
||||
# OpenClaw supports Node >=24.15.0, and this keeps the image compatible with the
|
||||
# current mcporter releases without relying on an older pinned CLI line.
|
||||
# Use explicit keyring + apt source instead of setup_24.x pipe script for deterministic builds.
|
||||
RUN mkdir -p /etc/apt/keyrings \
|
||||
&& curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key \
|
||||
| gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg \
|
||||
&& chmod 644 /etc/apt/keyrings/nodesource.gpg \
|
||||
&& echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_24.x nodistro main" \
|
||||
> /etc/apt/sources.list.d/nodesource.list \
|
||||
&& apt-get update \
|
||||
&& apt-get install -y --no-install-recommends nodejs \
|
||||
&& NODE_VERSION="$(node -v)" \
|
||||
&& echo "$NODE_VERSION" \
|
||||
&& echo "$NODE_VERSION" | grep -E '^v24\.' \
|
||||
&& rm -f /etc/apt/sources.list.d/nodesource.list /etc/apt/keyrings/nodesource.gpg \
|
||||
&& apt-get clean \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Install ttyd (web terminal) - not in Debian repos, download binary
|
||||
# Docker TARGETARCH: amd64, arm64, arm/v7 → ttyd filenames: x86_64, aarch64, armhf
|
||||
ARG TARGETARCH
|
||||
RUN ARCH=$(echo ${TARGETARCH:-$(dpkg --print-architecture)} | sed 's|arm64|aarch64|;s|arm/v7|armhf|;s|armv7|armhf|;s|amd64|x86_64|') \
|
||||
&& echo "Downloading ttyd for arch: ${ARCH}" \
|
||||
&& curl -fsSL "https://github.com/tsl0922/ttyd/releases/download/1.7.7/ttyd.${ARCH}" -o /usr/local/bin/ttyd \
|
||||
&& chmod +x /usr/local/bin/ttyd
|
||||
&& echo "Downloading ttyd for arch: ${ARCH}" \
|
||||
&& curl -fsSL "https://github.com/tsl0922/ttyd/releases/download/1.7.7/ttyd.${ARCH}" -o /usr/local/bin/ttyd \
|
||||
&& chmod +x /usr/local/bin/ttyd
|
||||
|
||||
RUN node -v && npm -v
|
||||
|
||||
@@ -56,8 +71,8 @@ RUN npm install -g pnpm && pnpm -v
|
||||
RUN apt-get update && apt-get install -y --no-install-recommends \
|
||||
chromium \
|
||||
chromium-driver \
|
||||
&& apt-get clean \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
&& apt-get clean \
|
||||
&& rm -rf /var/lib/apt/lists/*
|
||||
|
||||
# Install Homebrew (Linuxbrew) for OpenClaw skill dependencies
|
||||
# Homebrew is optional - some skills need CLI tools like gemini, aider, etc.
|
||||
@@ -68,16 +83,16 @@ ENV HOMEBREW_NO_AUTO_UPDATE=1 \
|
||||
HOMEBREW_NO_ANALYTICS=1
|
||||
|
||||
RUN useradd -m -s /bin/bash linuxbrew \
|
||||
&& mkdir -p /home/linuxbrew/.linuxbrew \
|
||||
&& chown -R linuxbrew:linuxbrew /home/linuxbrew
|
||||
&& mkdir -p /home/linuxbrew/.linuxbrew \
|
||||
&& chown -R linuxbrew:linuxbrew /home/linuxbrew
|
||||
|
||||
USER linuxbrew
|
||||
RUN /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)" || \
|
||||
(echo "WARNING: Homebrew installation failed (likely unsupported CPU - requires SSSE3). Some skills may not work." && exit 0)
|
||||
RUN if [ -d /home/linuxbrew/.linuxbrew/Homebrew ]; then \
|
||||
cd /home/linuxbrew/.linuxbrew/Homebrew && \
|
||||
git config --global --add safe.directory /home/linuxbrew/.linuxbrew/Homebrew && \
|
||||
/home/linuxbrew/.linuxbrew/bin/brew update --force || true; \
|
||||
cd /home/linuxbrew/.linuxbrew/Homebrew && \
|
||||
git config --global --add safe.directory /home/linuxbrew/.linuxbrew/Homebrew && \
|
||||
/home/linuxbrew/.linuxbrew/bin/brew update --force || true; \
|
||||
fi
|
||||
USER root
|
||||
|
||||
@@ -93,16 +108,20 @@ RUN chmod +x /usr/local/bin/brew
|
||||
# Skip if brew installation failed
|
||||
USER linuxbrew
|
||||
RUN if [ -x /home/linuxbrew/.linuxbrew/bin/brew ]; then \
|
||||
/home/linuxbrew/.linuxbrew/bin/brew --version && \
|
||||
/home/linuxbrew/.linuxbrew/bin/brew install gcc || true; \
|
||||
/home/linuxbrew/.linuxbrew/bin/brew --version && \
|
||||
/home/linuxbrew/.linuxbrew/bin/brew install gcc || true; \
|
||||
else \
|
||||
echo "Skipping gcc installation - Homebrew not available"; \
|
||||
echo "Skipping gcc installation - Homebrew not available"; \
|
||||
fi
|
||||
USER root
|
||||
|
||||
# Install OpenClaw globally
|
||||
# Install OpenClaw globally.
|
||||
# Bundle node-llama-cpp so the default local memory/embeddings provider works
|
||||
# in HAOS without requiring manual npm installs in /usr/lib.
|
||||
# Bundle mcporter so Home Assistant MCP auto-configuration works out of the box.
|
||||
# The image now ships Node 24, so use the current mcporter line.
|
||||
RUN npm config set fund false && npm config set audit false \
|
||||
&& npm install -g openclaw@2026.2.9
|
||||
&& npm install -g openclaw@2026.7.1-2 node-llama-cpp@3.18.1 mcporter@0.12.3
|
||||
|
||||
# Shell aliases and color options for interactive use
|
||||
RUN tee -a /etc/bash.bashrc <<'EOF'
|
||||
@@ -124,9 +143,13 @@ fi
|
||||
EOF
|
||||
COPY run.sh /run.sh
|
||||
COPY oc_config_helper.py /oc_config_helper.py
|
||||
COPY render_nginx.py /render_nginx.py
|
||||
COPY oc-cleanup.sh /usr/local/bin/oc-cleanup
|
||||
COPY oc-gateway /usr/local/bin/oc-gateway
|
||||
COPY openclaw-proxy-shim.cjs /usr/local/lib/openclaw-proxy-shim.cjs
|
||||
COPY nginx.conf.tpl /etc/nginx/nginx.conf.tpl
|
||||
COPY landing.html.tpl /etc/nginx/landing.html.tpl
|
||||
RUN chmod +x /run.sh /oc_config_helper.py \
|
||||
&& mkdir -p /run/nginx
|
||||
RUN chmod +x /run.sh /oc_config_helper.py /render_nginx.py /usr/local/bin/oc-cleanup /usr/local/bin/oc-gateway \
|
||||
&& mkdir -p /run/nginx
|
||||
|
||||
CMD [ "/run.sh" ]
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
name: OpenClaw Assistant
|
||||
version: "0.5.41"
|
||||
version: "0.5.87"
|
||||
slug: openclaw_assistant
|
||||
description: Run OpenClaw Assistant (OpenClaw-compatible) as a Home Assistant add-on.
|
||||
url: https://github.com/techartdev/OpenClawHomeAssistant
|
||||
@@ -16,12 +16,14 @@ host_network: true
|
||||
|
||||
# Home Assistant Ingress (UI inside the add-on page)
|
||||
ingress: true
|
||||
ingress_port: 8099
|
||||
ingress_port: 48099
|
||||
panel_title: OpenClaw Assistant
|
||||
panel_icon: mdi:robot
|
||||
|
||||
map:
|
||||
- addon_config:rw
|
||||
- share:rw
|
||||
- media:rw
|
||||
options:
|
||||
timezone: "Europe/Sofia"
|
||||
|
||||
@@ -39,6 +41,10 @@ options:
|
||||
# Optional: Home Assistant long-lived token (for local HA API scripts/tools)
|
||||
homeassistant_token: ""
|
||||
|
||||
# Optional: outbound HTTP/HTTPS proxy for OpenClaw network access.
|
||||
# Example: "http://192.168.2.1:3128"
|
||||
http_proxy: ""
|
||||
|
||||
# Optional: Router SSH defaults (leave empty if you don't need router automation)
|
||||
# This is a generic SSH configuration intended for a router/firewall or any network device
|
||||
# reachable from inside the HA host LAN.
|
||||
@@ -50,30 +56,92 @@ options:
|
||||
clean_session_locks_on_start: true
|
||||
clean_session_locks_on_exit: true
|
||||
|
||||
# Persist heavy optional tooling across add-on rebuilds.
|
||||
# Disabled by default to keep Home Assistant backups small.
|
||||
persist_node_global: false
|
||||
persist_brew_tools: false
|
||||
|
||||
# Gateway mode:
|
||||
# - local: Run gateway locally (recommended for most users)
|
||||
# - remote: Connect to a remote gateway
|
||||
# Default is local.
|
||||
gateway_mode: local
|
||||
|
||||
# Remote gateway URL (used when gateway_mode=remote)
|
||||
# Example: "ws://192.168.1.20:18789" or "wss://gateway.example.com:443"
|
||||
gateway_remote_url: ""
|
||||
|
||||
# Gateway network bind mode:
|
||||
# - loopback: bind to 127.0.0.1 only (local access only, more secure)
|
||||
# - loopback: bind to 127.0.0.1 only (local access only, most secure)
|
||||
# - lan: bind to all interfaces (accessible from local network)
|
||||
# - tailnet: bind to Tailscale IP only (accessible only via Tailscale — recommended for remote access)
|
||||
# Default is loopback for security.
|
||||
gateway_bind_mode: loopback
|
||||
|
||||
# Gateway port to listen on
|
||||
gateway_port: 18789
|
||||
|
||||
# Access mode preset — simplifies secure access configuration.
|
||||
# custom: use individual gateway_bind_mode / auth_mode settings (backward compatible)
|
||||
# local_only: loopback + token auth (Ingress / terminal only, most secure)
|
||||
# lan_https: Built-in HTTPS reverse proxy for LAN access (recommended for phones/tablets)
|
||||
# lan_reverse_proxy: LAN bind + trusted-proxy for an external reverse proxy (NPM, Caddy, …)
|
||||
# tailnet_https: Tailscale interface bind + token auth
|
||||
access_mode: custom
|
||||
|
||||
# Gateway authentication mode:
|
||||
# - token: standard token auth (default)
|
||||
# - trusted-proxy: trust auth headers from configured reverse proxies
|
||||
gateway_auth_mode: token
|
||||
|
||||
# Comma-separated trusted proxy IP/CIDR list for trusted-proxy mode.
|
||||
# Example: "127.0.0.1,192.168.88.0/24"
|
||||
gateway_trusted_proxies: ""
|
||||
|
||||
# Additional allowed origins for gateway.controlUi.allowedOrigins.
|
||||
# Merged with built-in defaults and existing configured origins.
|
||||
# In lan_https mode, hostnames/IPs from these origins are also added to the
|
||||
# TLS certificate SAN so the cert is valid for custom domains.
|
||||
# Example: "https://ha.example.com:8443,capacitor://localhost"
|
||||
gateway_additional_allowed_origins: ""
|
||||
|
||||
# In lan_https mode, disable per-device Control UI auth ceremony.
|
||||
# Default true (recommended) to avoid interactive pairing error 1008 on LAN.
|
||||
# Set false only if you explicitly want strict per-device approvals.
|
||||
controlui_disable_device_auth: true
|
||||
|
||||
# Enable OpenAI-compatible Chat Completions API endpoint
|
||||
# When enabled, OpenClaw can be used as a conversation agent in HA Assist pipeline
|
||||
# via Extended OpenAI Conversation (HACS) or any OpenAI-compatible client
|
||||
enable_openai_api: false
|
||||
|
||||
# Allow insecure HTTP authentication (required for HTTP gateway access on LAN)
|
||||
# WARNING: Only enable if you're using HTTP (not HTTPS) for gateway_public_url
|
||||
# Default is false for security.
|
||||
allow_insecure_auth: false
|
||||
# Force IPv4-first DNS result ordering for Node fetch/network calls.
|
||||
# Most HAOS VMs lack IPv6 egress, causing web_fetch / Telegram timeouts.
|
||||
# Default: true (recommended). Set to false only if you need IPv6.
|
||||
force_ipv4_dns: true
|
||||
|
||||
# Nginx access log verbosity:
|
||||
# full: log all requests (useful for debugging)
|
||||
# minimal: suppress repetitive HA health-check and polling requests (default)
|
||||
nginx_log_level: minimal
|
||||
|
||||
# Environment variables to pass to the gateway process at startup.
|
||||
# Format: list of objects with name/value fields.
|
||||
# Example:
|
||||
# gateway_env_vars:
|
||||
# - name: OPENAI_API_KEY
|
||||
# value: "sk-abc123"
|
||||
# - name: LOG_LEVEL
|
||||
# value: "debug"
|
||||
# Reserved keys are blocked to protect runtime/security
|
||||
# (e.g. PATH, HOME, NODE_OPTIONS, NODE_PATH, OPENCLAW_*, proxy vars).
|
||||
# Limits: max 50 variables, max key length 255 chars, max value length 10000 chars
|
||||
gateway_env_vars: []
|
||||
|
||||
# Auto-configure MCP (Model Context Protocol) for Home Assistant.
|
||||
# When enabled and homeassistant_token is set, automatically registers HA as an
|
||||
# MCP server in OpenClaw so the AI can control Home Assistant entities/services.
|
||||
auto_configure_mcp: false
|
||||
|
||||
|
||||
schema:
|
||||
@@ -82,6 +150,7 @@ schema:
|
||||
terminal_port: int(1024,65535)?
|
||||
gateway_public_url: str?
|
||||
homeassistant_token: str?
|
||||
http_proxy: str?
|
||||
|
||||
router_ssh_host: str
|
||||
router_ssh_user: str
|
||||
@@ -89,9 +158,21 @@ schema:
|
||||
|
||||
clean_session_locks_on_start: bool?
|
||||
clean_session_locks_on_exit: bool?
|
||||
persist_node_global: bool?
|
||||
persist_brew_tools: bool?
|
||||
gateway_mode: list(local|remote)?
|
||||
gateway_bind_mode: list(loopback|lan)?
|
||||
gateway_remote_url: str?
|
||||
gateway_bind_mode: list(loopback|lan|tailnet)?
|
||||
gateway_port: int(1,65535)?
|
||||
access_mode: list(custom|local_only|lan_https|lan_reverse_proxy|tailnet_https)?
|
||||
gateway_auth_mode: list(token|trusted-proxy)?
|
||||
gateway_trusted_proxies: str?
|
||||
gateway_additional_allowed_origins: str?
|
||||
controlui_disable_device_auth: bool?
|
||||
enable_openai_api: bool?
|
||||
allow_insecure_auth: bool?
|
||||
|
||||
force_ipv4_dns: bool?
|
||||
gateway_env_vars:
|
||||
- name: "match(^[A-Z_][A-Z0-9_]*$)"
|
||||
value: str
|
||||
nginx_log_level: list(full|minimal)?
|
||||
auto_configure_mcp: bool?
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 62 KiB |
@@ -9,36 +9,353 @@
|
||||
a,button{font:inherit}
|
||||
.card{max-width:1100px;margin:0 auto;background:#111827;border:1px solid #1f2937;border-radius:12px;padding:16px}
|
||||
.row{display:flex;gap:12px;flex-wrap:wrap;align-items:center}
|
||||
.btn{background:#2563eb;color:white;border:0;border-radius:10px;padding:10px 14px;cursor:pointer;text-decoration:none;display:inline-block}
|
||||
.btn{background:#2563eb;color:white;border:0;border-radius:10px;padding:10px 14px;cursor:pointer;text-decoration:none;display:inline-block;font-size:14px}
|
||||
.btn.secondary{background:#334155}
|
||||
.btn.green{background:#059669}
|
||||
.btn.amber{background:#d97706}
|
||||
.btn:hover{filter:brightness(1.15)}
|
||||
.muted{color:#9ca3af;font-size:14px}
|
||||
.term{margin-top:14px;height:70vh;min-height:420px;border:1px solid #1f2937;border-radius:10px;overflow:hidden}
|
||||
.term{margin-top:14px;height:60vh;min-height:360px;border:1px solid #1f2937;border-radius:10px;overflow:hidden}
|
||||
iframe{width:100%;height:100%;border:0;background:black}
|
||||
code{background:#0b1220;padding:2px 6px;border-radius:6px}
|
||||
code{background:#0b1220;padding:2px 6px;border-radius:6px;font-size:13px}
|
||||
.status-grid{display:grid;grid-template-columns:repeat(auto-fit,minmax(220px,1fr));gap:10px;margin:12px 0}
|
||||
.status-item{padding:10px 14px;border-radius:10px;background:#0d1117;border:1px solid #1f2937;font-size:14px;display:flex;align-items:center;gap:8px}
|
||||
.status-item .icon{font-size:18px;flex-shrink:0}
|
||||
.banner{padding:12px 16px;border-radius:10px;margin:10px 0;font-size:14px;line-height:1.5}
|
||||
.banner.info{background:#1e3a5f;border:1px solid #2563eb}
|
||||
.banner.warn{background:#422006;border:1px solid #d97706}
|
||||
.banner.error{background:#3b0d0d;border:1px solid #dc2626}
|
||||
.banner.success{background:#052e16;border:1px solid #059669}
|
||||
.wizard{background:#0d1117;border:1px solid #1f2937;border-radius:10px;padding:14px;margin:12px 0}
|
||||
.wizard h3{margin:0 0 8px;font-size:15px}
|
||||
.wizard ol{margin:6px 0;padding-left:22px;font-size:14px;line-height:1.8}
|
||||
.wizard code{font-size:12px}
|
||||
details{margin:8px 0}
|
||||
details>summary{cursor:pointer;font-size:14px;color:#60a5fa;font-weight:500}
|
||||
details>summary:hover{text-decoration:underline}
|
||||
.hidden{display:none}
|
||||
.badge{display:inline-block;padding:2px 8px;border-radius:6px;font-size:12px;font-weight:600;vertical-align:middle}
|
||||
.badge.secure{background:#059669;color:#fff}
|
||||
.badge.insecure{background:#dc2626;color:#fff}
|
||||
.badge.mode{background:#2563eb;color:#fff}
|
||||
</style>
|
||||
</head>
|
||||
<body>
|
||||
<div class="card">
|
||||
<h2 style="margin:0 0 8px 0">OpenClaw Assistant</h2>
|
||||
<h2 style="margin:0 0 4px 0">OpenClaw Assistant</h2>
|
||||
<div style="margin-bottom:10px">
|
||||
<span class="badge mode" id="modeBadge">__ACCESS_MODE__</span>
|
||||
<span class="badge" id="secureBadge"></span>
|
||||
</div>
|
||||
|
||||
<!-- ==================== STATUS GRID ==================== -->
|
||||
<div class="status-grid">
|
||||
<div class="status-item" id="statusGateway">
|
||||
<span class="icon">⏳</span>
|
||||
<span>Gateway: checking…</span>
|
||||
</div>
|
||||
<div class="status-item" id="statusSecure">
|
||||
<span class="icon">🔒</span>
|
||||
<span>Secure context: checking…</span>
|
||||
</div>
|
||||
<div class="status-item" id="statusAccess">
|
||||
<span class="icon">📡</span>
|
||||
<span>Access mode: <b>__ACCESS_MODE__</b></span>
|
||||
</div>
|
||||
<div class="status-item" id="statusDisk">
|
||||
<span class="icon" id="diskIcon">💾</span>
|
||||
<span id="diskText">Disk: __DISK_USED__ / __DISK_TOTAL__ (__DISK_PCT__) — __DISK_AVAIL__ free</span>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- ==================== ACTION BUTTONS ==================== -->
|
||||
<div class="row" style="margin-bottom:6px">
|
||||
<a class="btn" id="gwbtn" href="__GATEWAY_PUBLIC_URL____GW_PUBLIC_URL_PATH__?token=__GATEWAY_TOKEN__" target="_blank" rel="noopener noreferrer">Open Gateway Web UI</a>
|
||||
<a class="btn secondary" href="./terminal/" target="_self">Open Terminal (full page)</a>
|
||||
<a class="btn green hidden" id="certBtn" href="" target="_blank" rel="noopener noreferrer">Download CA Certificate</a>
|
||||
</div>
|
||||
|
||||
<div class="muted">
|
||||
Tip: The gateway UI is intentionally opened outside of Ingress to avoid websocket/proxy issues.
|
||||
Set <code>gateway_public_url</code> in the add-on options.
|
||||
<!-- ==================== MIGRATION BANNER ==================== -->
|
||||
<div class="banner warn hidden" id="migrationBanner">
|
||||
<b>⚠️ Migration notice:</b> OpenClaw v2026.2.21+ requires HTTPS or localhost for Control UI.
|
||||
Plain HTTP LAN access no longer works. Switch <code>access_mode</code> to <b>lan_https</b>
|
||||
in add-on Configuration for one-click secure LAN access, then restart.
|
||||
</div>
|
||||
|
||||
<div class="muted" style="margin-top:8px">
|
||||
If the Gateway UI says <b>Unauthorized</b>, you need the token. In the terminal run:
|
||||
<code>openclaw config get gateway.auth.token</code>
|
||||
<!-- ==================== LOW DISK SPACE BANNER ==================== -->
|
||||
<div class="banner warn hidden" id="diskBanner">
|
||||
<b>⚠️ Low disk space:</b> <span id="diskBannerText"></span><br>
|
||||
Add-on updates and Docker builds may fail. Open the terminal and run <code>oc-cleanup</code> to free space.
|
||||
For Docker-level cleanup, open a <strong>host root shell</strong> (Advanced SSH add-on with Protection Mode off, or type <code>login</code> at the HAOS console) and run <code>docker image prune -a</code>.
|
||||
</div>
|
||||
|
||||
<!-- ==================== ERROR BANNER (populated by JS) ==================== -->
|
||||
<div class="banner error hidden" id="errorBanner"></div>
|
||||
|
||||
<!-- ==================== SUCCESS BANNER ==================== -->
|
||||
<div class="banner success hidden" id="successBanner"></div>
|
||||
|
||||
<!-- ==================== ACCESS WIZARD ==================== -->
|
||||
<div class="wizard hidden" id="wizard">
|
||||
<h3>🧭 Quick-Start: Secure LAN Access</h3>
|
||||
<div id="wizardContent"></div>
|
||||
</div>
|
||||
|
||||
<!-- ==================== TIPS ==================== -->
|
||||
<details>
|
||||
<summary>Tips & token help</summary>
|
||||
<div class="muted" style="margin-top:6px">
|
||||
The gateway UI opens in a separate tab to avoid websocket/proxy issues with Ingress.
|
||||
Set <code>gateway_public_url</code> in add-on options if the button URL is wrong.
|
||||
</div>
|
||||
<div class="muted" style="margin-top:6px">
|
||||
If the Gateway UI says <b>Unauthorized</b>, get your token from the terminal:<br>
|
||||
<code>jq -r '.gateway.auth.token' /config/.openclaw/openclaw.json</code><br>
|
||||
<small style="color:#6b7280">(Since OpenClaw v2026.2.22+, <code>openclaw config get</code> redacts secrets — read the file directly instead.)</small>
|
||||
</div>
|
||||
</details>
|
||||
|
||||
<!-- ==================== PROXY RECIPES ==================== -->
|
||||
<details>
|
||||
<summary>MCP setup (Home Assistant control)</summary>
|
||||
<div style="margin-top:8px;font-size:13px;color:#9ca3af;line-height:1.7">
|
||||
<p><b>MCP (Model Context Protocol)</b> lets OpenClaw control Home Assistant entities, services, and automations directly.</p>
|
||||
|
||||
<b>Automatic (recommended)</b>
|
||||
<ol style="margin:4px 0;padding-left:22px;line-height:1.8">
|
||||
<li>Create a <b>Long-Lived Access Token</b> in HA: click your profile avatar → scroll to <b>Long-Lived Access Tokens</b> → <b>Create Token</b></li>
|
||||
<li>Paste it into add-on option <code>homeassistant_token</code> in <b>Settings → Add-ons → Configuration</b></li>
|
||||
<li>Set <code>auto_configure_mcp</code> to <b>ON</b> in add-on Configuration</li>
|
||||
<li>Restart the add-on — MCP is configured automatically</li>
|
||||
</ol>
|
||||
|
||||
<b>Manual (terminal)</b>
|
||||
<pre style="background:#0b1220;padding:8px;border-radius:6px;overflow-x:auto;font-size:12px">mcporter config add HA "http://localhost:8123/api/mcp" \
|
||||
--header "Authorization=Bearer YOUR_LONG_LIVED_TOKEN" \
|
||||
--scope home</pre>
|
||||
|
||||
<b>After upgrades</b> — if OpenClaw has stale HA data:
|
||||
<pre style="background:#0b1220;padding:8px;border-radius:6px;overflow-x:auto;font-size:12px">mcporter call home-assistant.GetLiveContext</pre>
|
||||
|
||||
<p><b>Tip:</b> The first MCP session needs a capable model (Gemini 3.1 Pro, Claude Sonnet 4, GPT-4.1). After setup, cheaper models work fine.</p>
|
||||
</div>
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>Reverse-proxy recipes (NPM / Caddy / Traefik / Tailscale)</summary>
|
||||
<div style="margin-top:8px;font-size:13px;color:#9ca3af;line-height:1.7">
|
||||
|
||||
<b>Nginx Proxy Manager (NPM)</b>
|
||||
<pre style="background:#0b1220;padding:8px;border-radius:6px;overflow-x:auto;font-size:12px">Scheme: https
|
||||
Forward: <HA-IP>:18789
|
||||
WS: ON
|
||||
SSL tab: Request a new SSL certificate (Let's Encrypt or custom)</pre>
|
||||
|
||||
<b>Caddy</b>
|
||||
<pre style="background:#0b1220;padding:8px;border-radius:6px;overflow-x:auto;font-size:12px">openclaw.example.com {
|
||||
reverse_proxy <HA-IP>:18789
|
||||
}</pre>
|
||||
|
||||
<b>Traefik (docker labels)</b>
|
||||
<pre style="background:#0b1220;padding:8px;border-radius:6px;overflow-x:auto;font-size:12px">- "traefik.http.routers.openclaw.rule=Host(`openclaw.example.com`)"
|
||||
- "traefik.http.routers.openclaw.tls.certresolver=le"
|
||||
- "traefik.http.services.openclaw.loadbalancer.server.port=18789"</pre>
|
||||
|
||||
<b>Tailscale HTTPS</b>
|
||||
<pre style="background:#0b1220;padding:8px;border-radius:6px;overflow-x:auto;font-size:12px"># 1. Set access_mode to tailnet_https in add-on configuration
|
||||
# 2. Enable Tailscale HTTPS in your Tailnet admin: DNS → HTTPS Certificates
|
||||
# 3. On the HA host: tailscale cert <machine-name>.ts.net
|
||||
# 4. Set gateway_public_url to https://<machine-name>.ts.net:18789</pre>
|
||||
</div>
|
||||
</details>
|
||||
|
||||
<!-- ==================== TERMINAL ==================== -->
|
||||
<div class="term">
|
||||
<iframe src="./terminal/" title="Terminal"></iframe>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- ==================== CLIENT-SIDE LOGIC ==================== -->
|
||||
<script>
|
||||
(function() {
|
||||
const ACCESS_MODE = '__ACCESS_MODE__';
|
||||
const HTTPS_PORT = '__HTTPS_PORT__';
|
||||
const GW_PUBLIC_URL = '__GATEWAY_PUBLIC_URL__';
|
||||
const GW_TOKEN = '__GATEWAY_TOKEN__';
|
||||
const DISK_PCT = '__DISK_PCT__';
|
||||
const DISK_AVAIL = '__DISK_AVAIL__';
|
||||
const DISK_USED = '__DISK_USED__';
|
||||
const DISK_TOTAL = '__DISK_TOTAL__';
|
||||
|
||||
const $ = id => document.getElementById(id);
|
||||
|
||||
// ---------- Secure context detection ----------
|
||||
const isSecure = window.isSecureContext;
|
||||
const secureBadge = $('secureBadge');
|
||||
const statusSecure = $('statusSecure');
|
||||
if (isSecure) {
|
||||
secureBadge.textContent = 'secure';
|
||||
secureBadge.className = 'badge secure';
|
||||
statusSecure.innerHTML = '<span class="icon">✅</span><span>Secure context: <b>yes</b></span>';
|
||||
} else {
|
||||
secureBadge.textContent = 'not secure';
|
||||
secureBadge.className = 'badge insecure';
|
||||
statusSecure.innerHTML = '<span class="icon">❌</span><span>Secure context: <b>no</b> — HTTPS required for Control UI</span>';
|
||||
}
|
||||
|
||||
// ---------- Gateway health check ----------
|
||||
(async function checkGateway() {
|
||||
const statusEl = $('statusGateway');
|
||||
try {
|
||||
const url = GW_PUBLIC_URL
|
||||
? GW_PUBLIC_URL.replace(/\/$/, '') + '/api/health'
|
||||
: '/api/health'; // fallback to relative (only works if proxied)
|
||||
const r = await fetch(url, { mode: 'no-cors', cache: 'no-store' }).catch(() => null);
|
||||
if (r && (r.ok || r.type === 'opaque')) {
|
||||
statusEl.innerHTML = '<span class="icon">✅</span><span>Gateway: <b>running</b></span>';
|
||||
} else {
|
||||
statusEl.innerHTML = '<span class="icon">⚠️</span><span>Gateway: <b>unreachable</b> (may still be starting)</span>';
|
||||
}
|
||||
} catch {
|
||||
statusEl.innerHTML = '<span class="icon">❌</span><span>Gateway: <b>unreachable</b></span>';
|
||||
}
|
||||
})();
|
||||
|
||||
// ---------- Error translation ----------
|
||||
const ERROR_MAP = {
|
||||
'control ui requires device identity': {
|
||||
friendly: 'The Gateway UI requires HTTPS or localhost (secure context). Plain HTTP over LAN is blocked since OpenClaw v2026.2.21.',
|
||||
fix: ACCESS_MODE === 'lan_https'
|
||||
? 'Your add-on is configured for lan_https. Open the gateway via the HTTPS URL above and install the CA certificate on your device.'
|
||||
: 'Switch <code>access_mode</code> to <b>lan_https</b> in add-on Configuration, then restart. This enables a built-in HTTPS proxy for LAN access.'
|
||||
},
|
||||
'requires secure context': {
|
||||
friendly: 'The browser is not in a secure context. HTTPS or localhost is required.',
|
||||
fix: 'Use the HTTPS URL provided by the add-on, or set up a reverse proxy with TLS.'
|
||||
},
|
||||
'pairing required': {
|
||||
friendly: 'The Gateway requires device pairing before the Control UI can connect.',
|
||||
fix: ACCESS_MODE === 'lan_https'
|
||||
? 'Restart the add-on — by default it sets <code>controlUi.dangerouslyDisableDeviceAuth: true</code> to skip pairing (token auth is still enforced). You can change this via <code>controlui_disable_device_auth</code> in add-on options. <br><small>Note: v2026.2.22+ shows an <em>expected</em> security warning for this flag in the gateway logs — it is safe to ignore.</small>'
|
||||
: 'Set <code>access_mode</code> to <b>lan_https</b> and restart. Or from the terminal: edit <code>/config/.openclaw/openclaw.json</code> and set <code>gateway.controlUi.dangerouslyDisableDeviceAuth: true</code>, then restart the gateway.'
|
||||
},
|
||||
'origin not allowed': {
|
||||
friendly: 'The Gateway rejected the browser origin. The Control UI URL is not in the allow-list.',
|
||||
fix: ACCESS_MODE === 'lan_https'
|
||||
? 'Restart the add-on — it auto-adds HTTPS origins to <code>controlUi.allowedOrigins</code>. If you changed your LAN IP, a restart regenerates the config.'
|
||||
: 'Manually add your origin: <code>openclaw config set gateway.controlUi.allowedOrigins \'["https://YOUR_IP:18789"]\' </code>'
|
||||
},
|
||||
'1008': {
|
||||
friendly: 'WebSocket disconnected (1008).',
|
||||
fix: 'Ensure you are connecting over HTTPS. Check the add-on logs for the specific sub-error (device identity / origin / pairing).'
|
||||
}
|
||||
};
|
||||
|
||||
// Expose for manual use: translateError('1008')
|
||||
window.translateError = function(rawError) {
|
||||
const lower = (rawError || '').toLowerCase();
|
||||
for (const [pattern, info] of Object.entries(ERROR_MAP)) {
|
||||
if (lower.includes(pattern)) {
|
||||
return info;
|
||||
}
|
||||
}
|
||||
return null;
|
||||
};
|
||||
|
||||
// ---------- Migration banner ----------
|
||||
if (ACCESS_MODE === 'custom') {
|
||||
$('migrationBanner').classList.remove('hidden');
|
||||
}
|
||||
|
||||
// ---------- Disk space monitoring ----------
|
||||
if (DISK_PCT) {
|
||||
const pctNum = parseInt(DISK_PCT, 10);
|
||||
const diskIcon = $('diskIcon');
|
||||
const statusDisk = $('statusDisk');
|
||||
if (pctNum >= 90) {
|
||||
diskIcon.textContent = '🔴';
|
||||
statusDisk.style.borderColor = '#dc2626';
|
||||
$('diskBanner').classList.remove('hidden');
|
||||
$('diskBannerText').textContent =
|
||||
`Disk is ${DISK_PCT} full (${DISK_AVAIL} free of ${DISK_TOTAL}).`;
|
||||
} else if (pctNum >= 75) {
|
||||
diskIcon.textContent = '🟡';
|
||||
statusDisk.style.borderColor = '#d97706';
|
||||
$('diskBanner').classList.remove('hidden');
|
||||
$('diskBannerText').textContent =
|
||||
`Disk is ${DISK_PCT} full (${DISK_AVAIL} free of ${DISK_TOTAL}). Consider cleaning up soon.`;
|
||||
} else {
|
||||
diskIcon.textContent = '🟢';
|
||||
}
|
||||
}
|
||||
|
||||
// ---------- CA certificate download ----------
|
||||
if (ACCESS_MODE === 'lan_https' && HTTPS_PORT) {
|
||||
const certBtn = $('certBtn');
|
||||
// Build cert URL relative to the gateway's HTTPS port
|
||||
const host = window.location.hostname || 'homeassistant.local';
|
||||
certBtn.href = 'https://' + host + ':' + HTTPS_PORT + '/cert/ca.crt';
|
||||
certBtn.classList.remove('hidden');
|
||||
}
|
||||
|
||||
// ---------- Access wizard ----------
|
||||
const wizardEl = $('wizard');
|
||||
const wizardContent = $('wizardContent');
|
||||
|
||||
if (ACCESS_MODE === 'lan_https') {
|
||||
wizardEl.classList.remove('hidden');
|
||||
wizardContent.innerHTML = `
|
||||
<div class="banner success">✅ Built-in HTTPS proxy is active on port <b>${HTTPS_PORT}</b>.</div>
|
||||
<ol>
|
||||
<li>Click <b>Open Gateway Web UI</b> above — it will use HTTPS automatically.</li>
|
||||
<li>Your browser may show a certificate warning the first time. Click <b>Advanced → Proceed</b> to continue.</li>
|
||||
<li><b>For phones/tablets (one-time):</b> Click <b>Download CA Certificate</b>, then install it:
|
||||
<ul style="margin:4px 0;padding-left:18px">
|
||||
<li><b>Android:</b> Settings → Security → Install certificate → CA certificate → select the file</li>
|
||||
<li><b>iOS:</b> Open the .crt file → Install Profile → Settings → General → About → Certificate Trust Settings → enable</li>
|
||||
</ul>
|
||||
After installing the CA, the browser will trust the gateway without warnings.
|
||||
</li>
|
||||
</ol>`;
|
||||
} else if (ACCESS_MODE === 'lan_reverse_proxy') {
|
||||
wizardEl.classList.remove('hidden');
|
||||
wizardContent.innerHTML = `
|
||||
<ol>
|
||||
<li>Configure your reverse proxy (NPM / Caddy / Traefik) to forward HTTPS to <code><HA-IP>:${GW_PUBLIC_URL ? new URL(GW_PUBLIC_URL).port || '18789' : '18789'}</code>.</li>
|
||||
<li>Set <code>gateway_public_url</code> to your HTTPS URL (e.g. <code>https://openclaw.example.com</code>).</li>
|
||||
<li>Set <code>gateway_trusted_proxies</code> to your proxy's IP/CIDR.</li>
|
||||
<li>Restart the add-on. See <b>Reverse-proxy recipes</b> below for copy-paste configs.</li>
|
||||
</ol>`;
|
||||
} else if (ACCESS_MODE === 'tailnet_https') {
|
||||
wizardEl.classList.remove('hidden');
|
||||
wizardContent.innerHTML = `
|
||||
<ol>
|
||||
<li>Ensure Tailscale is installed on the HA host and this device.</li>
|
||||
<li>Enable HTTPS certificates in Tailnet admin: <b>DNS → HTTPS Certificates</b>.</li>
|
||||
<li>On the HA host: <code>tailscale cert <machine-name>.ts.net</code></li>
|
||||
<li>Set <code>gateway_public_url</code> to <code>https://<machine-name>.ts.net:18789</code></li>
|
||||
<li>Restart the add-on.</li>
|
||||
</ol>`;
|
||||
} else if (ACCESS_MODE === 'local_only') {
|
||||
wizardEl.classList.remove('hidden');
|
||||
wizardContent.innerHTML = `
|
||||
<div class="banner info">Gateway is bound to localhost only. Use the embedded terminal or Ingress.</div>
|
||||
<p style="font-size:14px;">To access from phones or other devices, switch <code>access_mode</code> to <b>lan_https</b> in add-on Configuration.</p>`;
|
||||
} else if (ACCESS_MODE === 'custom' && !isSecure) {
|
||||
wizardEl.classList.remove('hidden');
|
||||
wizardContent.innerHTML = `
|
||||
<div class="banner warn">You are using custom settings and this page is not in a secure context.
|
||||
The Gateway Control UI will reject connections over plain HTTP.</div>
|
||||
<p style="font-size:14px"><b>Recommended:</b> Go to <b>Settings → Add-ons → OpenClaw Assistant → Configuration</b>
|
||||
and set <code>access_mode</code> to one of:</p>
|
||||
<ul style="font-size:14px;line-height:1.8;padding-left:22px">
|
||||
<li><b>lan_https</b> — easiest, adds built-in HTTPS proxy (no external setup needed)</li>
|
||||
<li><b>lan_reverse_proxy</b> — if you already have NPM / Caddy / Traefik</li>
|
||||
<li><b>tailnet_https</b> — if you use Tailscale</li>
|
||||
</ul>`;
|
||||
}
|
||||
|
||||
})();
|
||||
</script>
|
||||
</body>
|
||||
</html>
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 40 KiB After Width: | Height: | Size: 62 KiB |
@@ -9,8 +9,8 @@ http {
|
||||
include /etc/nginx/mime.types;
|
||||
default_type application/octet-stream;
|
||||
|
||||
# Log to stdout/stderr (container-friendly)
|
||||
access_log /dev/stdout;
|
||||
# Logging (configurable via nginx_log_level option)
|
||||
__NGINX_ACCESS_LOG__
|
||||
error_log /dev/stderr notice;
|
||||
|
||||
sendfile on;
|
||||
@@ -19,7 +19,7 @@ http {
|
||||
# Ingress note: keep redirects relative so we stay under HA Ingress.
|
||||
|
||||
server {
|
||||
listen 8099;
|
||||
listen 48099;
|
||||
|
||||
# Web terminal (ttyd)
|
||||
# ttyd base-path is configured as /terminal (no trailing slash).
|
||||
@@ -59,4 +59,6 @@ http {
|
||||
return 404;
|
||||
}
|
||||
}
|
||||
|
||||
__HTTPS_GATEWAY_BLOCK__
|
||||
}
|
||||
|
||||
@@ -0,0 +1,144 @@
|
||||
#!/usr/bin/env bash
|
||||
# ──────────────────────────────────────────────────────────────
|
||||
# oc-cleanup — Disk space monitor & cleanup helper for OpenClaw
|
||||
# Run from the add-on terminal: oc-cleanup
|
||||
# ──────────────────────────────────────────────────────────────
|
||||
set -euo pipefail
|
||||
|
||||
BOLD="\033[1m"
|
||||
RED="\033[91m"
|
||||
GREEN="\033[92m"
|
||||
YELLOW="\033[93m"
|
||||
CYAN="\033[96m"
|
||||
RESET="\033[0m"
|
||||
|
||||
echo -e "${BOLD}${CYAN}═══════════════════════════════════════════${RESET}"
|
||||
echo -e "${BOLD}${CYAN} OpenClaw Disk Space Monitor & Cleanup${RESET}"
|
||||
echo -e "${BOLD}${CYAN}═══════════════════════════════════════════${RESET}"
|
||||
echo ""
|
||||
|
||||
# ── Disk usage ───────────────────────────────────────────────
|
||||
DATA_MOUNT="/config"
|
||||
if df -h "$DATA_MOUNT" >/dev/null 2>&1; then
|
||||
DISK_TOTAL=$(df -h "$DATA_MOUNT" | awk 'NR==2{print $2}')
|
||||
DISK_USED=$(df -h "$DATA_MOUNT" | awk 'NR==2{print $3}')
|
||||
DISK_AVAIL=$(df -h "$DATA_MOUNT" | awk 'NR==2{print $4}')
|
||||
DISK_PCT=$(df -h "$DATA_MOUNT" | awk 'NR==2{print $5}')
|
||||
DISK_PCT_NUM=${DISK_PCT//%/}
|
||||
|
||||
echo -e "${BOLD}Disk usage (data partition):${RESET}"
|
||||
echo -e " Total: ${DISK_TOTAL}"
|
||||
echo -e " Used: ${DISK_USED} (${DISK_PCT})"
|
||||
echo -e " Available: ${DISK_AVAIL}"
|
||||
echo ""
|
||||
|
||||
if [ "$DISK_PCT_NUM" -ge 90 ]; then
|
||||
echo -e "${RED}${BOLD}⚠ CRITICAL: Disk is ${DISK_PCT} full!${RESET}"
|
||||
echo -e "${RED} Add-on updates and Docker builds may fail.${RESET}"
|
||||
echo ""
|
||||
elif [ "$DISK_PCT_NUM" -ge 75 ]; then
|
||||
echo -e "${YELLOW}${BOLD}⚠ WARNING: Disk is ${DISK_PCT} full.${RESET}"
|
||||
echo -e "${YELLOW} Consider cleaning up to avoid future build failures.${RESET}"
|
||||
echo ""
|
||||
else
|
||||
echo -e "${GREEN}✓ Disk usage looks healthy.${RESET}"
|
||||
echo ""
|
||||
fi
|
||||
fi
|
||||
|
||||
# ── Add-on cache sizes ──────────────────────────────────────
|
||||
echo -e "${BOLD}Add-on cache sizes:${RESET}"
|
||||
|
||||
show_size() {
|
||||
local label="$1" path="$2"
|
||||
if [ -d "$path" ]; then
|
||||
local size
|
||||
size=$(du -sh "$path" 2>/dev/null | cut -f1)
|
||||
printf " %-30s %s\n" "$label" "$size"
|
||||
fi
|
||||
}
|
||||
|
||||
show_size "npm cache" "/config/.npm"
|
||||
show_size "npm global packages" "/config/.node_global"
|
||||
show_size "pnpm store" "/config/.node_global/pnpm"
|
||||
show_size "OpenClaw config + skills" "/config/.openclaw"
|
||||
show_size "Homebrew" "/config/.linuxbrew"
|
||||
show_size "Agent workspace" "/config/clawd"
|
||||
show_size "Python __pycache__" "/config/.openclaw/__pycache__"
|
||||
show_size "Temp files (/tmp)" "/tmp"
|
||||
echo ""
|
||||
|
||||
# ── Cleanup menu ────────────────────────────────────────────
|
||||
echo -e "${BOLD}What can be cleaned from inside the add-on:${RESET}"
|
||||
echo " 1) npm cache (safe — rebuilds on demand)"
|
||||
echo " 2) pnpm store cache (safe — rebuilds on demand)"
|
||||
echo " 3) Python __pycache__ (safe — regenerated automatically)"
|
||||
echo " 4) /tmp files (safe — transient data)"
|
||||
echo " 5) All of the above"
|
||||
echo " 6) Show Docker prune commands (must run from HA host SSH)"
|
||||
echo " q) Quit"
|
||||
echo ""
|
||||
read -r -p "Choose [1-6/q]: " choice
|
||||
|
||||
cleanup_npm() {
|
||||
echo -e "${CYAN}Cleaning npm cache...${RESET}"
|
||||
npm cache clean --force 2>/dev/null || true
|
||||
rm -rf /config/.npm/_cacache 2>/dev/null || true
|
||||
echo " Done."
|
||||
}
|
||||
|
||||
cleanup_pnpm() {
|
||||
echo -e "${CYAN}Cleaning pnpm store...${RESET}"
|
||||
pnpm store prune 2>/dev/null || true
|
||||
echo " Done."
|
||||
}
|
||||
|
||||
cleanup_pycache() {
|
||||
echo -e "${CYAN}Cleaning Python __pycache__...${RESET}"
|
||||
find /config -type d -name __pycache__ -exec rm -rf {} + 2>/dev/null || true
|
||||
echo " Done."
|
||||
}
|
||||
|
||||
cleanup_tmp() {
|
||||
echo -e "${CYAN}Cleaning /tmp...${RESET}"
|
||||
rm -rf /tmp/* 2>/dev/null || true
|
||||
echo " Done."
|
||||
}
|
||||
|
||||
show_docker_commands() {
|
||||
echo ""
|
||||
echo -e "${BOLD}${YELLOW}Run these from a HOST root shell (not this add-on terminal):${RESET}"
|
||||
echo ""
|
||||
echo -e " ${BOLD}Option A — Advanced SSH & Web Terminal add-on:${RESET}"
|
||||
echo " Install it, disable Protection Mode, then open its terminal."
|
||||
echo ""
|
||||
echo -e " ${BOLD}Option B — HAOS console (VirtualBox / keyboard):${RESET}"
|
||||
echo " Type 'login' at the HAOS prompt to get a root shell."
|
||||
echo ""
|
||||
echo -e " ${BOLD}# Then run:${RESET}"
|
||||
echo " docker image prune -a # remove unused images"
|
||||
echo " docker builder prune -a # remove build cache"
|
||||
echo " docker system df # check Docker disk usage"
|
||||
echo ""
|
||||
echo -e "${YELLOW}Important: The 'ha docker' CLI does NOT support prune."
|
||||
echo -e "You must use the raw 'docker' command from a host root shell.${RESET}"
|
||||
}
|
||||
|
||||
case "${choice:-q}" in
|
||||
1) cleanup_npm ;;
|
||||
2) cleanup_pnpm ;;
|
||||
3) cleanup_pycache ;;
|
||||
4) cleanup_tmp ;;
|
||||
5) cleanup_npm; cleanup_pnpm; cleanup_pycache; cleanup_tmp ;;
|
||||
6) show_docker_commands ;;
|
||||
q|Q) echo "Bye." ;;
|
||||
*) echo "Unknown option." ;;
|
||||
esac
|
||||
|
||||
echo ""
|
||||
# Show result
|
||||
if df -h "$DATA_MOUNT" >/dev/null 2>&1; then
|
||||
DISK_AVAIL_NOW=$(df -h "$DATA_MOUNT" | awk 'NR==2{print $4}')
|
||||
DISK_PCT_NOW=$(df -h "$DATA_MOUNT" | awk 'NR==2{print $5}')
|
||||
echo -e "${BOLD}Disk now: ${DISK_PCT_NOW} used, ${DISK_AVAIL_NOW} available${RESET}"
|
||||
fi
|
||||
Executable
+133
@@ -0,0 +1,133 @@
|
||||
#!/usr/bin/env bash
|
||||
set -euo pipefail
|
||||
|
||||
cmd="${1:-status}"
|
||||
shift || true
|
||||
|
||||
find_gateway_pid() {
|
||||
local port="${1:-18789}"
|
||||
local pid=""
|
||||
|
||||
# 1) Port owner (most accurate)
|
||||
if command -v ss >/dev/null 2>&1; then
|
||||
pid=$(ss -tlnp 2>/dev/null \
|
||||
| grep ":${port} " \
|
||||
| sed -n 's/.*pid=\([0-9]*\).*/\1/p' \
|
||||
| head -1 || true)
|
||||
if [ -n "$pid" ] && [ -r "/proc/$pid/cmdline" ]; then
|
||||
local cmdline
|
||||
cmdline=$(tr '\0' ' ' < "/proc/$pid/cmdline" 2>/dev/null || true)
|
||||
if echo "$cmdline" | grep -qi "openclaw\|node"; then
|
||||
echo "$pid"
|
||||
return 0
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
|
||||
# 2) Process title
|
||||
pid=$(pgrep -f "openclaw-gateway" 2>/dev/null | head -1 || true)
|
||||
if [ -n "$pid" ]; then
|
||||
echo "$pid"
|
||||
return 0
|
||||
fi
|
||||
|
||||
# 3) /proc cmdline fallback
|
||||
for f in /proc/[0-9]*/cmdline; do
|
||||
[ -r "$f" ] || continue
|
||||
if tr '\0' ' ' < "$f" 2>/dev/null | grep -qi "openclaw"; then
|
||||
echo "${f#/proc/}" | cut -d/ -f1
|
||||
return 0
|
||||
fi
|
||||
done
|
||||
|
||||
return 1
|
||||
}
|
||||
|
||||
get_gateway_port() {
|
||||
python3 - <<'PY'
|
||||
import json, os
|
||||
p = os.environ.get('OPENCLAW_CONFIG_PATH', '/config/.openclaw/openclaw.json')
|
||||
try:
|
||||
with open(p, 'r', encoding='utf-8') as f:
|
||||
cfg = json.load(f)
|
||||
print(int(cfg.get('gateway', {}).get('port', 18789)))
|
||||
except Exception:
|
||||
print(18789)
|
||||
PY
|
||||
}
|
||||
|
||||
status_cmd() {
|
||||
local port pid
|
||||
port="$(get_gateway_port)"
|
||||
pid="$(find_gateway_pid "$port" || true)"
|
||||
|
||||
echo "OpenClaw add-on gateway status"
|
||||
echo "Supervisor: run.sh (not systemd)"
|
||||
echo "Configured port: ${port}"
|
||||
|
||||
if [ -n "$pid" ] && kill -0 "$pid" 2>/dev/null; then
|
||||
echo "Gateway process: running (PID ${pid})"
|
||||
if command -v ss >/dev/null 2>&1 && ss -tlnp 2>/dev/null | grep -q ":${port} "; then
|
||||
echo "Listener: active on :${port}"
|
||||
else
|
||||
echo "Listener: process found, port bind not detected yet"
|
||||
fi
|
||||
exit 0
|
||||
fi
|
||||
|
||||
echo "Gateway process: not detected"
|
||||
echo "Tip: Check add-on logs in Home Assistant for startup errors."
|
||||
exit 1
|
||||
}
|
||||
|
||||
restart_cmd() {
|
||||
local port pid
|
||||
port="$(get_gateway_port)"
|
||||
pid="$(find_gateway_pid "$port" || true)"
|
||||
|
||||
if [ -z "$pid" ] || ! kill -0 "$pid" 2>/dev/null; then
|
||||
echo "No running gateway process found to restart."
|
||||
echo "Tip: If startup failed, inspect add-on logs."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
echo "Requesting gateway self-restart via SIGUSR1 (PID ${pid})..."
|
||||
kill -USR1 "$pid"
|
||||
|
||||
for _ in $(seq 1 20); do
|
||||
sleep 1
|
||||
local new_pid
|
||||
new_pid="$(find_gateway_pid "$port" || true)"
|
||||
if [ -n "$new_pid" ] && kill -0 "$new_pid" 2>/dev/null; then
|
||||
echo "Gateway active (PID ${new_pid})"
|
||||
exit 0
|
||||
fi
|
||||
done
|
||||
|
||||
echo "Restart signal sent; gateway may still be reinitializing."
|
||||
echo "Run 'oc-gateway status' again in a few seconds."
|
||||
exit 0
|
||||
}
|
||||
|
||||
case "$cmd" in
|
||||
status)
|
||||
status_cmd
|
||||
;;
|
||||
restart|reload)
|
||||
restart_cmd
|
||||
;;
|
||||
help|-h|--help)
|
||||
cat <<'EOF'
|
||||
Usage: oc-gateway <status|restart|reload>
|
||||
|
||||
status Show add-on-native gateway status (run.sh-supervised)
|
||||
restart Request gateway self-restart via SIGUSR1
|
||||
reload Alias of restart
|
||||
EOF
|
||||
;;
|
||||
*)
|
||||
echo "Unknown command: $cmd" >&2
|
||||
echo "Run: oc-gateway help" >&2
|
||||
exit 2
|
||||
;;
|
||||
esac
|
||||
@@ -57,16 +57,18 @@ def set_gateway_setting(key, value):
|
||||
return write_config(cfg)
|
||||
|
||||
|
||||
def apply_gateway_settings(mode: str, bind_mode: str, port: int, enable_openai_api: bool, allow_insecure_auth: bool):
|
||||
def apply_gateway_settings(mode: str, remote_url: str, bind_mode: str, port: int, enable_openai_api: bool, auth_mode: str, trusted_proxies_csv: str):
|
||||
"""
|
||||
Apply gateway settings to OpenClaw config.
|
||||
|
||||
Args:
|
||||
mode: "local" or "remote"
|
||||
bind_mode: "loopback" or "lan"
|
||||
remote_url: remote Gateway websocket URL (used when mode=remote)
|
||||
bind_mode: "loopback", "lan", or "tailnet"
|
||||
port: Port number to listen on (must be 1-65535)
|
||||
enable_openai_api: Enable OpenAI-compatible Chat Completions endpoint
|
||||
allow_insecure_auth: Allow insecure HTTP authentication
|
||||
auth_mode: Gateway auth mode (token|trusted-proxy)
|
||||
trusted_proxies_csv: Comma-separated trusted proxy IP/CIDR list
|
||||
"""
|
||||
# Validate gateway mode
|
||||
if mode not in ["local", "remote"]:
|
||||
@@ -74,14 +76,19 @@ def apply_gateway_settings(mode: str, bind_mode: str, port: int, enable_openai_a
|
||||
return False
|
||||
|
||||
# Validate bind mode
|
||||
if bind_mode not in ["loopback", "lan"]:
|
||||
print(f"ERROR: Invalid bind_mode '{bind_mode}'. Must be 'loopback' or 'lan'")
|
||||
if bind_mode not in ["loopback", "lan", "tailnet"]:
|
||||
print(f"ERROR: Invalid bind_mode '{bind_mode}'. Must be 'loopback', 'lan', or 'tailnet'")
|
||||
return False
|
||||
|
||||
# Validate port range
|
||||
if port < 1 or port > 65535:
|
||||
print(f"ERROR: Invalid port {port}. Must be between 1 and 65535")
|
||||
return False
|
||||
|
||||
# Validate auth mode
|
||||
if auth_mode not in ["token", "trusted-proxy"]:
|
||||
print(f"ERROR: Invalid auth_mode '{auth_mode}'. Must be 'token' or 'trusted-proxy'")
|
||||
return False
|
||||
|
||||
cfg = read_config()
|
||||
if cfg is None:
|
||||
@@ -91,11 +98,16 @@ def apply_gateway_settings(mode: str, bind_mode: str, port: int, enable_openai_a
|
||||
cfg["gateway"] = {}
|
||||
|
||||
gateway = cfg["gateway"]
|
||||
|
||||
# controlUi should be nested inside gateway
|
||||
if "controlUi" not in gateway:
|
||||
gateway["controlUi"] = {}
|
||||
|
||||
|
||||
# gateway.remote settings
|
||||
if "remote" not in gateway or not isinstance(gateway.get("remote"), dict):
|
||||
gateway["remote"] = {}
|
||||
remote_cfg = gateway["remote"]
|
||||
|
||||
# auth should be nested inside gateway
|
||||
if "auth" not in gateway:
|
||||
gateway["auth"] = {}
|
||||
|
||||
# http.endpoints.chatCompletions should be nested inside gateway
|
||||
if "http" not in gateway:
|
||||
gateway["http"] = {}
|
||||
@@ -104,20 +116,33 @@ def apply_gateway_settings(mode: str, bind_mode: str, port: int, enable_openai_a
|
||||
if "chatCompletions" not in gateway["http"]["endpoints"]:
|
||||
gateway["http"]["endpoints"]["chatCompletions"] = {}
|
||||
|
||||
control_ui = gateway["controlUi"]
|
||||
auth = gateway["auth"]
|
||||
chat_completions = gateway["http"]["endpoints"]["chatCompletions"]
|
||||
|
||||
|
||||
trusted_proxies = [p.strip() for p in trusted_proxies_csv.split(",") if p.strip()]
|
||||
|
||||
# OpenClaw trusted-proxy mode requires nested auth.trustedProxy config.
|
||||
# Use a sane default user header expected from reverse proxies.
|
||||
trusted_proxy_cfg_default = {"userHeader": "x-forwarded-user"}
|
||||
|
||||
current_mode = gateway.get("mode", "")
|
||||
current_remote_url = remote_cfg.get("url", "")
|
||||
current_bind = gateway.get("bind", "")
|
||||
current_port = gateway.get("port", 18789)
|
||||
current_openai_api = chat_completions.get("enabled", False)
|
||||
current_insecure = control_ui.get("allowInsecureAuth", False)
|
||||
current_auth_mode = auth.get("mode", "token")
|
||||
current_trusted_proxies = gateway.get("trustedProxies", [])
|
||||
current_trusted_proxy_cfg = auth.get("trustedProxy")
|
||||
|
||||
changes = []
|
||||
|
||||
if current_mode != mode:
|
||||
gateway["mode"] = mode
|
||||
changes.append(f"mode: {current_mode} -> {mode}")
|
||||
|
||||
if current_remote_url != remote_url:
|
||||
remote_cfg["url"] = remote_url
|
||||
changes.append(f"remote.url: {current_remote_url} -> {remote_url}")
|
||||
|
||||
if current_bind != bind_mode:
|
||||
gateway["bind"] = bind_mode
|
||||
@@ -131,9 +156,18 @@ def apply_gateway_settings(mode: str, bind_mode: str, port: int, enable_openai_a
|
||||
chat_completions["enabled"] = enable_openai_api
|
||||
changes.append(f"chatCompletions.enabled: {current_openai_api} -> {enable_openai_api}")
|
||||
|
||||
if current_insecure != allow_insecure_auth:
|
||||
control_ui["allowInsecureAuth"] = allow_insecure_auth
|
||||
changes.append(f"allowInsecureAuth: {current_insecure} -> {allow_insecure_auth}")
|
||||
if current_auth_mode != auth_mode:
|
||||
auth["mode"] = auth_mode
|
||||
changes.append(f"auth.mode: {current_auth_mode} -> {auth_mode}")
|
||||
|
||||
if current_trusted_proxies != trusted_proxies:
|
||||
gateway["trustedProxies"] = trusted_proxies
|
||||
changes.append(f"trustedProxies: {current_trusted_proxies} -> {trusted_proxies}")
|
||||
|
||||
if auth_mode == "trusted-proxy":
|
||||
if current_trusted_proxy_cfg != trusted_proxy_cfg_default:
|
||||
auth["trustedProxy"] = trusted_proxy_cfg_default
|
||||
changes.append("auth.trustedProxy: configured default userHeader=x-forwarded-user")
|
||||
|
||||
if changes:
|
||||
if write_config(cfg):
|
||||
@@ -143,10 +177,122 @@ def apply_gateway_settings(mode: str, bind_mode: str, port: int, enable_openai_a
|
||||
print("ERROR: Failed to write config")
|
||||
return False
|
||||
else:
|
||||
print(f"INFO: Gateway settings already correct (mode={mode}, bind={bind_mode}, port={port}, chatCompletions={enable_openai_api}, allowInsecureAuth={allow_insecure_auth})")
|
||||
print(f"INFO: Gateway settings already correct (mode={mode}, remoteUrl={remote_url}, bind={bind_mode}, port={port}, chatCompletions={enable_openai_api}, authMode={auth_mode}, trustedProxies={trusted_proxies})")
|
||||
return True
|
||||
|
||||
|
||||
def set_control_ui_origins(origins_csv: str, additional_origins_csv: str = "", disable_device_auth: bool = True):
|
||||
"""
|
||||
Configure gateway.controlUi for the built-in HTTPS proxy.
|
||||
|
||||
Sets:
|
||||
- allowedOrigins: the HTTPS proxy origins so the browser WebSocket
|
||||
is accepted (required since v2026.2.21).
|
||||
- dangerouslyDisableDeviceAuth: controlled by add-on option
|
||||
`controlui_disable_device_auth` (default true). When true, skips
|
||||
interactive device pairing; token auth remains enforced.
|
||||
|
||||
Also removes any stale/invalid keys (e.g. pairingMode) that may have
|
||||
been written by earlier add-on versions.
|
||||
|
||||
Args:
|
||||
origins_csv: Comma-separated list of default origins provided by the add-on.
|
||||
additional_origins_csv: Comma-separated list of user-provided extra origins.
|
||||
"""
|
||||
cfg = read_config()
|
||||
if cfg is None:
|
||||
cfg = {}
|
||||
|
||||
if "gateway" not in cfg:
|
||||
cfg["gateway"] = {}
|
||||
gateway = cfg["gateway"]
|
||||
|
||||
if "controlUi" not in gateway:
|
||||
gateway["controlUi"] = {}
|
||||
|
||||
control_ui = gateway["controlUi"]
|
||||
default_origins = [o.strip() for o in origins_csv.split(",") if o.strip()]
|
||||
additional_origins = [o.strip() for o in (additional_origins_csv or "").split(",") if o.strip()]
|
||||
changes = []
|
||||
|
||||
# --- allowedOrigins ---
|
||||
current_origins = control_ui.get("allowedOrigins", [])
|
||||
if not isinstance(current_origins, list):
|
||||
current_origins = []
|
||||
|
||||
merged_origins = []
|
||||
for origin in [*default_origins, *current_origins, *additional_origins]:
|
||||
if isinstance(origin, str) and origin and origin not in merged_origins:
|
||||
merged_origins.append(origin)
|
||||
|
||||
if current_origins != merged_origins:
|
||||
control_ui["allowedOrigins"] = merged_origins
|
||||
changes.append(f"allowedOrigins: {current_origins} -> {merged_origins}")
|
||||
|
||||
# --- dangerouslyDisableDeviceAuth ---
|
||||
# Optional bypass of interactive per-device pairing (error 1008: pairing required).
|
||||
# Token auth is still enforced; this only controls the approval ceremony.
|
||||
desired_device_auth_flag = True if disable_device_auth else False
|
||||
if control_ui.get("dangerouslyDisableDeviceAuth") is not desired_device_auth_flag:
|
||||
prev = control_ui.get("dangerouslyDisableDeviceAuth")
|
||||
control_ui["dangerouslyDisableDeviceAuth"] = desired_device_auth_flag
|
||||
changes.append(f"dangerouslyDisableDeviceAuth: {prev} -> {desired_device_auth_flag}")
|
||||
|
||||
# --- Remove invalid keys from earlier add-on versions ---
|
||||
for stale_key in ("pairingMode",):
|
||||
if stale_key in control_ui:
|
||||
del control_ui[stale_key]
|
||||
changes.append(f"removed invalid key: {stale_key}")
|
||||
|
||||
if not changes:
|
||||
status = "disabled" if desired_device_auth_flag else "enabled"
|
||||
print(f"INFO: controlUi already correct: origins={merged_origins}, deviceAuth={status}")
|
||||
return True
|
||||
|
||||
if write_config(cfg):
|
||||
print(f"INFO: Updated controlUi: {', '.join(changes)}")
|
||||
return True
|
||||
print("ERROR: Failed to write config")
|
||||
return False
|
||||
|
||||
|
||||
def repair_known_invalid_settings():
|
||||
"""Repair known config values that prevent OpenClaw from starting."""
|
||||
cfg = read_config()
|
||||
if cfg is None:
|
||||
return True
|
||||
|
||||
tools = cfg.get("tools")
|
||||
if not isinstance(tools, dict):
|
||||
return True
|
||||
|
||||
web = tools.get("web")
|
||||
if not isinstance(web, dict):
|
||||
return True
|
||||
|
||||
search = web.get("search")
|
||||
if not isinstance(search, dict):
|
||||
return True
|
||||
|
||||
provider = search.get("provider")
|
||||
changes = []
|
||||
|
||||
if provider == "brave":
|
||||
del search["provider"]
|
||||
changes.append("removed unavailable tools.web.search.provider=brave")
|
||||
|
||||
if not changes:
|
||||
print("INFO: No known invalid OpenClaw config settings found")
|
||||
return True
|
||||
|
||||
if write_config(cfg):
|
||||
print(f"INFO: Repaired OpenClaw config: {', '.join(changes)}")
|
||||
return True
|
||||
|
||||
print("ERROR: Failed to write config")
|
||||
return False
|
||||
|
||||
|
||||
def main():
|
||||
"""CLI entry point for use by run.sh"""
|
||||
if len(sys.argv) < 2:
|
||||
@@ -156,15 +302,17 @@ def main():
|
||||
cmd = sys.argv[1]
|
||||
|
||||
if cmd == "apply-gateway-settings":
|
||||
if len(sys.argv) != 7:
|
||||
print("Usage: oc_config_helper.py apply-gateway-settings <local|remote> <loopback|lan> <port> <enable_openai_api:true|false> <allow_insecure:true|false>")
|
||||
if len(sys.argv) != 9:
|
||||
print("Usage: oc_config_helper.py apply-gateway-settings <local|remote> <remote_url> <loopback|lan|tailnet> <port> <enable_openai_api:true|false> <auth_mode:token|trusted-proxy> <trusted_proxies_csv>")
|
||||
sys.exit(1)
|
||||
mode = sys.argv[2]
|
||||
bind_mode = sys.argv[3]
|
||||
port = int(sys.argv[4])
|
||||
enable_openai_api = sys.argv[5].lower() == "true"
|
||||
allow_insecure_auth = sys.argv[6].lower() == "true"
|
||||
success = apply_gateway_settings(mode, bind_mode, port, enable_openai_api, allow_insecure_auth)
|
||||
remote_url = sys.argv[3]
|
||||
bind_mode = sys.argv[4]
|
||||
port = int(sys.argv[5])
|
||||
enable_openai_api = sys.argv[6].lower() == "true"
|
||||
auth_mode = sys.argv[7]
|
||||
trusted_proxies_csv = sys.argv[8]
|
||||
success = apply_gateway_settings(mode, remote_url, bind_mode, port, enable_openai_api, auth_mode, trusted_proxies_csv)
|
||||
sys.exit(0 if success else 1)
|
||||
|
||||
elif cmd == "get":
|
||||
@@ -177,6 +325,25 @@ def main():
|
||||
print(value)
|
||||
sys.exit(0)
|
||||
|
||||
elif cmd == "set-control-ui-origins":
|
||||
if len(sys.argv) not in (3, 4, 5):
|
||||
print("Usage: oc_config_helper.py set-control-ui-origins <origins_csv> [additional_origins_csv] [disable_device_auth:true|false]")
|
||||
sys.exit(1)
|
||||
origins_csv = sys.argv[2]
|
||||
additional_origins_csv = sys.argv[3] if len(sys.argv) >= 4 else ""
|
||||
disable_device_auth = True
|
||||
if len(sys.argv) == 5:
|
||||
disable_device_auth = sys.argv[4].strip().lower() == "true"
|
||||
success = set_control_ui_origins(origins_csv, additional_origins_csv, disable_device_auth)
|
||||
sys.exit(0 if success else 1)
|
||||
|
||||
elif cmd == "repair-known-invalid-settings":
|
||||
if len(sys.argv) != 2:
|
||||
print("Usage: oc_config_helper.py repair-known-invalid-settings")
|
||||
sys.exit(1)
|
||||
success = repair_known_invalid_settings()
|
||||
sys.exit(0 if success else 1)
|
||||
|
||||
elif cmd == "set":
|
||||
if len(sys.argv) != 4:
|
||||
print("Usage: oc_config_helper.py set <key> <value>")
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
"use strict";
|
||||
|
||||
/**
|
||||
* Enable HTTP(S) proxy support for Node/undici before OpenClaw initializes.
|
||||
* We load undici from OpenClaw's own node_modules path to avoid relying on
|
||||
* global module resolution from this shim's location.
|
||||
*/
|
||||
(function applyProxyFromEnv() {
|
||||
const hasProxyEnv =
|
||||
!!process.env.HTTPS_PROXY ||
|
||||
!!process.env.HTTP_PROXY ||
|
||||
!!process.env.https_proxy ||
|
||||
!!process.env.http_proxy;
|
||||
|
||||
if (!hasProxyEnv) {
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
const path = require("node:path");
|
||||
const globalModulesRoot =
|
||||
process.env.OPENCLAW_GLOBAL_NODE_MODULES || "/usr/lib/node_modules";
|
||||
const undiciPath = path.join(globalModulesRoot, "openclaw", "node_modules", "undici");
|
||||
const { EnvHttpProxyAgent, setGlobalDispatcher } = require(undiciPath);
|
||||
setGlobalDispatcher(new EnvHttpProxyAgent());
|
||||
} catch (_err) {
|
||||
// Keep startup resilient if module layout changes in future releases.
|
||||
}
|
||||
})();
|
||||
@@ -0,0 +1,133 @@
|
||||
#!/usr/bin/env python3
|
||||
"""
|
||||
Render nginx.conf and landing page HTML from templates.
|
||||
|
||||
Called by run.sh with the following env vars:
|
||||
GW_PUBLIC_URL, GW_TOKEN, TERMINAL_PORT,
|
||||
ENABLE_HTTPS_PROXY, HTTPS_PROXY_PORT,
|
||||
GATEWAY_INTERNAL_PORT, ACCESS_MODE,
|
||||
DISK_TOTAL, DISK_USED, DISK_AVAIL, DISK_PCT
|
||||
"""
|
||||
|
||||
import os
|
||||
import subprocess
|
||||
from pathlib import Path
|
||||
|
||||
|
||||
def main():
|
||||
tpl = Path('/etc/nginx/nginx.conf.tpl').read_text()
|
||||
landing_tpl = Path('/etc/nginx/landing.html.tpl').read_text()
|
||||
|
||||
public_url = os.environ.get('GW_PUBLIC_URL', '')
|
||||
terminal_port = os.environ.get('TERMINAL_PORT', '7681')
|
||||
enable_https = os.environ.get('ENABLE_HTTPS_PROXY', 'false') == 'true'
|
||||
https_port = os.environ.get('HTTPS_PROXY_PORT', '')
|
||||
internal_gw_port = os.environ.get('GATEWAY_INTERNAL_PORT', '')
|
||||
access_mode = os.environ.get('ACCESS_MODE', 'custom')
|
||||
|
||||
# Disk usage info (collected by run.sh)
|
||||
disk_total = os.environ.get('DISK_TOTAL', '')
|
||||
disk_used = os.environ.get('DISK_USED', '')
|
||||
disk_avail = os.environ.get('DISK_AVAIL', '')
|
||||
disk_pct = os.environ.get('DISK_PCT', '')
|
||||
nginx_log_level = os.environ.get('NGINX_LOG_LEVEL', 'minimal')
|
||||
|
||||
# Token comes from environment (best-effort CLI query in run.sh)
|
||||
token = os.environ.get('GW_TOKEN', '')
|
||||
|
||||
gw_path = '' if public_url.endswith('/') else '/'
|
||||
|
||||
# ── nginx.conf ──────────────────────────────────────────────
|
||||
# Build access_log directive (minimal suppresses HA health-check / polling noise)
|
||||
if nginx_log_level == 'minimal':
|
||||
access_log_block = (
|
||||
'# Suppress repetitive HA health-check / polling requests\n'
|
||||
' map $http_user_agent $loggable {\n'
|
||||
' ~HomeAssistant 0;\n'
|
||||
' default 1;\n'
|
||||
' }\n'
|
||||
' access_log /dev/stdout combined if=$loggable;'
|
||||
)
|
||||
else:
|
||||
access_log_block = 'access_log /dev/stdout;'
|
||||
|
||||
conf = tpl.replace('__NGINX_ACCESS_LOG__', access_log_block)
|
||||
conf = conf.replace('__TERMINAL_PORT__', terminal_port)
|
||||
|
||||
# Build HTTPS gateway proxy block (only for lan_https mode)
|
||||
https_block = ''
|
||||
if enable_https and https_port and internal_gw_port:
|
||||
https_block = f"""
|
||||
# --- HTTPS Gateway Proxy (lan_https mode) ---
|
||||
server {{
|
||||
listen {https_port} ssl;
|
||||
|
||||
ssl_certificate /config/certs/gateway.crt;
|
||||
ssl_certificate_key /config/certs/gateway.key;
|
||||
ssl_protocols TLSv1.2 TLSv1.3;
|
||||
ssl_ciphers HIGH:!aNULL:!MD5;
|
||||
|
||||
# Proxy all traffic to the loopback gateway with WebSocket support
|
||||
location / {{
|
||||
proxy_pass http://127.0.0.1:{internal_gw_port};
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection "upgrade";
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto https;
|
||||
proxy_read_timeout 86400s;
|
||||
proxy_send_timeout 86400s;
|
||||
proxy_buffering off;
|
||||
}}
|
||||
|
||||
# Download the local CA certificate (install on phone for trusted access)
|
||||
location = /cert/ca.crt {{
|
||||
alias /etc/nginx/html/openclaw-ca.crt;
|
||||
default_type application/x-x509-ca-cert;
|
||||
add_header Content-Disposition 'attachment; filename="openclaw-ca.crt"';
|
||||
}}
|
||||
}}
|
||||
"""
|
||||
|
||||
conf = conf.replace('__HTTPS_GATEWAY_BLOCK__', https_block)
|
||||
Path('/etc/nginx/nginx.conf').write_text(conf)
|
||||
|
||||
# ── landing page ────────────────────────────────────────────
|
||||
# If lan_https and no explicit public URL, auto-construct one
|
||||
if enable_https and not public_url:
|
||||
try:
|
||||
lan_ip = subprocess.check_output(
|
||||
['hostname', '-I'], text=True, timeout=2
|
||||
).split()[0]
|
||||
except Exception:
|
||||
lan_ip = '127.0.0.1'
|
||||
public_url = f'https://{lan_ip}:{https_port}'
|
||||
gw_path = '/'
|
||||
|
||||
landing = landing_tpl.replace('__GATEWAY_TOKEN__', token)
|
||||
landing = landing.replace('__GATEWAY_PUBLIC_URL__', public_url)
|
||||
landing = landing.replace('__GW_PUBLIC_URL_PATH__', gw_path)
|
||||
landing = landing.replace('__ACCESS_MODE__', access_mode)
|
||||
landing = landing.replace('__HTTPS_PORT__', https_port if enable_https else '')
|
||||
landing = landing.replace('__DISK_TOTAL__', disk_total)
|
||||
landing = landing.replace('__DISK_USED__', disk_used)
|
||||
landing = landing.replace('__DISK_AVAIL__', disk_avail)
|
||||
landing = landing.replace('__DISK_PCT__', disk_pct)
|
||||
|
||||
out_dir = Path('/etc/nginx/html')
|
||||
out_dir.mkdir(parents=True, exist_ok=True)
|
||||
out_file = out_dir / 'index.html'
|
||||
out_file.write_text(landing)
|
||||
|
||||
# Ensure nginx can read it even if base image uses restrictive umask/permissions.
|
||||
try:
|
||||
out_dir.chmod(0o755)
|
||||
out_file.chmod(0o644)
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
+990
-69
File diff suppressed because it is too large
Load Diff
@@ -18,6 +18,10 @@ configuration:
|
||||
homeassistant_token:
|
||||
name: Home Assistant токен
|
||||
description: Опционално - дълготраен токен на Home Assistant за локални API скриптове/инструменти
|
||||
|
||||
http_proxy:
|
||||
name: Изходящ HTTP прокси
|
||||
description: Опционално - URL на прокси за изходящи HTTP/HTTPS заявки (пример - http://192.168.2.1:3128)
|
||||
|
||||
router_ssh_host:
|
||||
name: SSH хост на рутер
|
||||
@@ -38,23 +42,82 @@ configuration:
|
||||
clean_session_locks_on_exit:
|
||||
name: Изчистване на заключвания при изход
|
||||
description: Изчистване на заключващи файлове на сесии при нормално спиране на добавката
|
||||
|
||||
persist_node_global:
|
||||
name: Запазване на npm глобални умения
|
||||
description: Когато е ВКЛ., съхранява инсталираните от потребителя npm умения и глобални пакети в /config/.node_global, за да оцелеят при преизграждане на добавката. По подразбиране е ИЗКЛ. за по-малки HA архиви.
|
||||
|
||||
persist_brew_tools:
|
||||
name: Запазване на Homebrew инструменти
|
||||
description: Когато е ВКЛ., съхранява Homebrew и инсталираните с brew CLI инструменти в /config/.linuxbrew, за да оцелеят при преизграждане на добавката. По подразбиране е ИЗКЛ. за по-малки HA архиви.
|
||||
|
||||
gateway_mode:
|
||||
name: Режим на Gateway
|
||||
description: Режим на работа на Gateway - local (локално изпълнение на gateway, препоръчително) или remote (свързване към отдалечен gateway)
|
||||
|
||||
options:
|
||||
local: "Локален (препоръчително)"
|
||||
remote: "Отдалечен"
|
||||
|
||||
gateway_remote_url:
|
||||
name: URL на отдалечен Gateway
|
||||
description: WebSocket URL на отдалечения gateway, използван когато Gateway Mode е remote (пример - ws://192.168.1.20:18789 или wss://gateway.example.com:443)
|
||||
|
||||
gateway_additional_allowed_origins:
|
||||
name: Допълнителни разрешени origins
|
||||
description: Допълнителни origins за Control UI, разделени със запетая; сливат се в gateway.controlUi.allowedOrigins при lan_https (пример - https://ha.example.com:8443,capacitor://localhost)
|
||||
|
||||
controlui_disable_device_auth:
|
||||
name: Изключи device pairing за Control UI (lan_https)
|
||||
description: "Когато е ВКЛ. (препоръчително), задава gateway.controlUi.dangerouslyDisableDeviceAuth=true и пропуска одобрението по устройство, за да избегне error 1008 в LAN HTTPS режим. Остави ВКЛ. за домашна/доверена мрежа. Изключи само ако искаш стриктно pairing потвърждение за всеки нов браузър/устройство."
|
||||
|
||||
gateway_bind_mode:
|
||||
name: Режим на свързване на Gateway
|
||||
description: Режим на мрежово свързване - loopback (само 127.0.0.1, по-сигурно) или lan (всички интерфейси, достъпно от локалната мрежа)
|
||||
|
||||
description: Режим на мрежово свързване - loopback (само 127.0.0.1, най-сигурен), lan (всички интерфейси) или tailnet (само Tailscale интерфейс). Пренебрегва се от предварителните режими на достъп.
|
||||
options:
|
||||
loopback: "Loopback (само 127.0.0.1, най-сигурен)"
|
||||
lan: "LAN (всички интерфейси)"
|
||||
tailnet: "Tailnet (само Tailscale)"
|
||||
|
||||
gateway_port:
|
||||
name: Порт на Gateway
|
||||
description: Номер на порт, на който OpenClaw gateway да слуша (по подразбиране - 18789)
|
||||
|
||||
|
||||
access_mode:
|
||||
name: Режим на достъп
|
||||
description: "Опростява настройката на сигурен достъп. Пренебрегва gateway_bind_mode и gateway_auth_mode, когато не е зададен на Потребителски."
|
||||
options:
|
||||
custom: "Потребителски (индивидуални настройки)"
|
||||
local_only: "Само локален (loopback + token, само Ingress)"
|
||||
lan_https: "LAN HTTPS (вграден HTTPS прокси — препоръчително за телефони)"
|
||||
lan_reverse_proxy: "LAN Reverse Proxy (външен прокси с trusted-proxy удостоверяване)"
|
||||
tailnet_https: "Tailscale HTTPS (Tailscale + token)"
|
||||
|
||||
gateway_auth_mode:
|
||||
name: Режим на удостоверяване на Gateway
|
||||
description: Режим на удостоверяване - token (по подразбиране) или trusted-proxy (за HTTPS reverse proxy). Пренебрегва се, когато access_mode не е Потребителски.
|
||||
options:
|
||||
token: "Token (по подразбиране)"
|
||||
trusted-proxy: "Доверен прокси (за reverse proxy)"
|
||||
|
||||
gateway_trusted_proxies:
|
||||
name: Доверени прокси на Gateway
|
||||
description: Списък с доверени прокси IP/CIDR, разделени със запетая, за trusted-proxy режим (пример - 127.0.0.1,192.168.88.0/24).
|
||||
|
||||
enable_openai_api:
|
||||
name: Активиране на OpenAI API
|
||||
description: Активиране на OpenAI-съвместим Chat Completions ендпойнт. Позволява използването на OpenClaw като разговорен агент в HA Assist pipeline чрез Extended OpenAI Conversation (HACS) или всеки OpenAI-съвместим клиент.
|
||||
|
||||
allow_insecure_auth:
|
||||
name: Разрешаване на HTTP автентикация
|
||||
description: Разрешаване на HTTP автентикация за достъп до gateway в локалната мрежа. ВНИМАНИЕ - Активирайте само ако използвате HTTP (не HTTPS) за gateway_public_url. Необходимо за достъп от браузър през HTTP.
|
||||
force_ipv4_dns:
|
||||
name: Принудителен IPv4 DNS ред
|
||||
description: Принудително задава IPv4-приоритет при DNS резолв. Повечето HAOS VM нямат IPv6 изход — предизвиква web_fetch и Telegram грешки. Препоръчително ВКЛЮЧЕНО (по подразбиране).
|
||||
nginx_log_level:
|
||||
name: Nginx ниво на логове
|
||||
description: "Подробност на логовете на nginx проксито. 'minimal' (по подразбиране) потиска повтарящи се HA health-check заявки. 'full' логва всичко."
|
||||
options:
|
||||
minimal: "Минимално (потискане на HA polling шум)"
|
||||
full: "Пълно (логване на всички заявки)"
|
||||
gateway_env_vars:
|
||||
name: Променливи на средата за Gateway
|
||||
description: Променливи на средата, предавани на OpenClaw gateway процеса при стартиране (списък от записи name/value в Home Assistant UI; макс. 50 променливи, ключове до 255 знака, стойности до 10000 знака).
|
||||
auto_configure_mcp:
|
||||
name: Автоматично конфигуриране на MCP за Home Assistant
|
||||
description: "Когато е ВКЛ. и Home Assistant Token е зададен, автоматично регистрира Home Assistant като MCP сървър при всяко стартиране. Това позволява на OpenClaw да контролира HA устройства, услуги и автоматизации чрез Model Context Protocol. Изключете само ако управлявате mcporter конфигурацията ръчно."
|
||||
|
||||
@@ -18,6 +18,10 @@ configuration:
|
||||
homeassistant_token:
|
||||
name: Home Assistant Token
|
||||
description: Optional - Langlebiger Home Assistant Token für lokale API-Skripte/Tools
|
||||
|
||||
http_proxy:
|
||||
name: Ausgehender HTTP-Proxy
|
||||
description: Optional - Proxy-URL für ausgehende HTTP/HTTPS-Anfragen (Beispiel - http://192.168.2.1:3128)
|
||||
|
||||
router_ssh_host:
|
||||
name: Router SSH-Host
|
||||
@@ -38,23 +42,82 @@ configuration:
|
||||
clean_session_locks_on_exit:
|
||||
name: Sitzungssperren beim Beenden bereinigen
|
||||
description: Sitzungssperrdateien beim ordnungsgemäßen Stoppen des Add-ons bereinigen
|
||||
|
||||
persist_node_global:
|
||||
name: npm-Globale Skills dauerhaft speichern
|
||||
description: Wenn EIN, werden benutzerinstallierte npm-Skills und globale Pakete unter /config/.node_global gespeichert und über Add-on-Neubuilds hinweg behalten. Standard ist AUS, um Home-Assistant-Backups klein zu halten.
|
||||
|
||||
persist_brew_tools:
|
||||
name: Homebrew-Tools dauerhaft speichern
|
||||
description: Wenn EIN, werden Homebrew und per brew installierte CLI-Tools unter /config/.linuxbrew gespeichert und über Add-on-Neubuilds hinweg behalten. Standard ist AUS, um Home-Assistant-Backups klein zu halten.
|
||||
|
||||
gateway_mode:
|
||||
name: Gateway-Modus
|
||||
description: Gateway-Betriebsmodus - local (Gateway lokal ausführen, empfohlen) oder remote (mit einem entfernten Gateway verbinden)
|
||||
|
||||
options:
|
||||
local: "Lokal (empfohlen)"
|
||||
remote: "Remote"
|
||||
|
||||
gateway_remote_url:
|
||||
name: Remote Gateway-URL
|
||||
description: Remote-Gateway-WebSocket-URL, verwendet wenn Gateway-Modus auf Remote steht (Beispiel - ws://192.168.1.20:18789 oder wss://gateway.example.com:443)
|
||||
|
||||
gateway_additional_allowed_origins:
|
||||
name: Zusätzliche erlaubte Origins
|
||||
description: Kommagetrennte zusätzliche Control-UI-Origins, die bei lan_https in gateway.controlUi.allowedOrigins zusammengeführt werden (Beispiel - https://ha.example.com:8443,capacitor://localhost)
|
||||
|
||||
controlui_disable_device_auth:
|
||||
name: Control-UI-Geräte-Pairing deaktivieren (lan_https)
|
||||
description: "Wenn EIN (empfohlen), setzt dies gateway.controlUi.dangerouslyDisableDeviceAuth=true, überspringt die Gerätefreigabe und vermeidet Fehler 1008 im LAN-HTTPS-Modus. Für Heim-/vertrauenswürdiges LAN eingeschaltet lassen. Nur AUS schalten, wenn du striktes Geräte-Pairing für jeden neuen Browser/jedes neue Gerät willst."
|
||||
|
||||
gateway_bind_mode:
|
||||
name: Gateway-Bindungsmodus
|
||||
description: Netzwerk-Bindungsmodus - loopback (nur 127.0.0.1, sicherer) oder lan (alle Schnittstellen, vom lokalen Netzwerk aus zugänglich)
|
||||
|
||||
description: Netzwerk-Bindungsmodus - loopback (nur 127.0.0.1, am sichersten), lan (alle Schnittstellen) oder tailnet (nur Tailscale-Schnittstelle). Wird durch Zugriffsmodus-Voreinstellungen überschrieben.
|
||||
options:
|
||||
loopback: "Loopback (nur 127.0.0.1, am sichersten)"
|
||||
lan: "LAN (alle Schnittstellen)"
|
||||
tailnet: "Tailnet (nur Tailscale)"
|
||||
|
||||
gateway_port:
|
||||
name: Gateway-Port
|
||||
description: Portnummer, auf der das OpenClaw-Gateway lauscht (Standard - 18789)
|
||||
|
||||
|
||||
access_mode:
|
||||
name: Zugriffsmodus
|
||||
description: "Vereinfacht die sichere Zugriffskonfiguration. Überschreibt gateway_bind_mode und gateway_auth_mode wenn nicht auf Benutzerdefiniert gesetzt."
|
||||
options:
|
||||
custom: "Benutzerdefiniert (individuelle Einstellungen)"
|
||||
local_only: "Nur lokal (Loopback + Token, nur Ingress)"
|
||||
lan_https: "LAN HTTPS (eingebauter HTTPS-Proxy — empfohlen für Smartphones)"
|
||||
lan_reverse_proxy: "LAN Reverse-Proxy (externer Proxy mit Trusted-Proxy-Auth)"
|
||||
tailnet_https: "Tailscale HTTPS (Tailscale-Bindung + Token)"
|
||||
|
||||
gateway_auth_mode:
|
||||
name: Gateway-Authentifizierungsmodus
|
||||
description: Gateway-Auth-Modus - token (Standard) oder trusted-proxy (für HTTPS-Reverse-Proxys). Wird überschrieben wenn access_mode nicht Benutzerdefiniert ist.
|
||||
options:
|
||||
token: "Token (Standard)"
|
||||
trusted-proxy: "Vertrauenswürdiger Proxy (für Reverse-Proxys)"
|
||||
|
||||
gateway_trusted_proxies:
|
||||
name: Vertrauenswürdige Gateway-Proxys
|
||||
description: Komma-getrennte Liste vertrauenswürdiger Proxy-IPs/CIDRs für den Trusted-Proxy-Modus (Beispiel - 127.0.0.1,192.168.88.0/24).
|
||||
|
||||
enable_openai_api:
|
||||
name: OpenAI API aktivieren
|
||||
description: OpenAI-kompatiblen Chat Completions Endpunkt aktivieren. Ermöglicht die Verwendung von OpenClaw als Gesprächsagent in der HA Assist Pipeline über Extended OpenAI Conversation (HACS) oder jeden OpenAI-kompatiblen Client.
|
||||
|
||||
allow_insecure_auth:
|
||||
name: Unsichere HTTP-Authentifizierung erlauben
|
||||
description: HTTP-Authentifizierung für Gateway-Zugriff im LAN erlauben. WARNUNG - Nur aktivieren, wenn HTTP (nicht HTTPS) für gateway_public_url verwendet wird. Erforderlich für Browser-Zugriff über HTTP.
|
||||
force_ipv4_dns:
|
||||
name: IPv4-DNS-Reihenfolge erzwingen
|
||||
description: Erzwingt IPv4-vorrangige DNS-Auflösung. Die meisten HAOS-VMs haben keinen IPv6-Ausgang — verursacht web_fetch- und Telegram-Timeouts. Empfohlen EIN (Standard).
|
||||
nginx_log_level:
|
||||
name: Nginx Log-Level
|
||||
description: "Ausführlichkeit des Nginx-Zugriffslogs. 'minimal' (Standard) unterdrückt wiederholte HA-Healthcheck- und Polling-Anfragen. 'full' protokolliert alles."
|
||||
options:
|
||||
minimal: "Minimal (HA-Polling-Rauschen unterdrücken)"
|
||||
full: "Vollständig (alle Anfragen protokollieren)"
|
||||
gateway_env_vars:
|
||||
name: Gateway-Umgebungsvariablen
|
||||
description: Umgebungsvariablen, die beim Start an den OpenClaw-Gateway-Prozess übergeben werden (Liste mit name/value-Einträgen in der Home Assistant UI; max. 50 Variablen, Schlüssel bis 255 Zeichen, Werte bis 10.000 Zeichen).
|
||||
auto_configure_mcp:
|
||||
name: MCP für Home Assistant automatisch konfigurieren
|
||||
description: "Wenn AN und Home Assistant Token gesetzt ist, wird Home Assistant bei jedem Start automatisch als MCP-Server registriert. Das erlaubt OpenClaw, HA-Geräte, -Dienste und -Automatisierungen über das Model Context Protocol zu steuern. Nur deaktivieren, wenn Sie die mcporter-Konfiguration manuell verwalten."
|
||||
|
||||
@@ -18,6 +18,10 @@ configuration:
|
||||
homeassistant_token:
|
||||
name: Home Assistant Token
|
||||
description: Optional - Home Assistant long-lived token for local HA API scripts/tools
|
||||
|
||||
http_proxy:
|
||||
name: Outbound HTTP Proxy
|
||||
description: Optional - Proxy URL for outbound HTTP/HTTPS requests (example - http://192.168.2.1:3128)
|
||||
|
||||
router_ssh_host:
|
||||
name: Router SSH Host
|
||||
@@ -38,23 +42,82 @@ configuration:
|
||||
clean_session_locks_on_exit:
|
||||
name: Clean Session Locks on Exit
|
||||
description: Cleanup session lock files when add-on stops gracefully
|
||||
|
||||
persist_node_global:
|
||||
name: Persist npm Global Skills
|
||||
description: When ON, store user-installed npm skills and global packages under /config/.node_global so they survive add-on rebuilds. Default OFF to keep Home Assistant backups smaller.
|
||||
|
||||
persist_brew_tools:
|
||||
name: Persist Homebrew Tools
|
||||
description: When ON, store Homebrew and brew-installed CLI tools under /config/.linuxbrew so they survive add-on rebuilds. Default OFF to keep Home Assistant backups smaller.
|
||||
|
||||
gateway_mode:
|
||||
name: Gateway Mode
|
||||
description: Gateway operation mode - local (run gateway locally, recommended) or remote (connect to a remote gateway)
|
||||
|
||||
options:
|
||||
local: "Local (recommended)"
|
||||
remote: "Remote"
|
||||
|
||||
gateway_remote_url:
|
||||
name: Remote Gateway URL
|
||||
description: Remote gateway WebSocket URL used when Gateway Mode is Remote (example - ws://192.168.1.20:18789 or wss://gateway.example.com:443)
|
||||
|
||||
gateway_additional_allowed_origins:
|
||||
name: Additional Allowed Origins
|
||||
description: Comma-separated extra Control UI origins to merge into gateway.controlUi.allowedOrigins in lan_https mode (example - https://ha.example.com:8443,capacitor://localhost)
|
||||
|
||||
controlui_disable_device_auth:
|
||||
name: Disable Control UI Device Pairing (lan_https)
|
||||
description: "When ON (recommended), sets gateway.controlUi.dangerouslyDisableDeviceAuth=true to skip per-device approval and avoid error 1008 in LAN HTTPS mode. Keep ON for home/trusted LAN. Turn OFF only when you want strict per-device pairing prompts on every new browser/device."
|
||||
|
||||
gateway_bind_mode:
|
||||
name: Gateway Bind Mode
|
||||
description: Network bind mode - loopback (127.0.0.1 only, more secure) or lan (all interfaces, accessible from local network)
|
||||
|
||||
description: Network bind mode - loopback (127.0.0.1 only, most secure), lan (all interfaces), or tailnet (Tailscale interface only). Overridden by access_mode presets.
|
||||
options:
|
||||
loopback: "Loopback (127.0.0.1 only, most secure)"
|
||||
lan: "LAN (all interfaces)"
|
||||
tailnet: "Tailnet (Tailscale only)"
|
||||
|
||||
gateway_port:
|
||||
name: Gateway Port
|
||||
description: Port number for the OpenClaw gateway to listen on (default - 18789)
|
||||
|
||||
|
||||
access_mode:
|
||||
name: Access Mode
|
||||
description: "Simplifies secure access setup. Overrides gateway_bind_mode and gateway_auth_mode when not set to Custom."
|
||||
options:
|
||||
custom: "Custom (use individual settings)"
|
||||
local_only: "Local Only (loopback + token, Ingress only)"
|
||||
lan_https: "LAN HTTPS (built-in HTTPS proxy — recommended for phones)"
|
||||
lan_reverse_proxy: "LAN Reverse Proxy (external proxy with trusted-proxy auth)"
|
||||
tailnet_https: "Tailscale HTTPS (Tailscale bind + token)"
|
||||
|
||||
gateway_auth_mode:
|
||||
name: Gateway Auth Mode
|
||||
description: Gateway auth mode - token (default) or trusted-proxy (for HTTPS reverse proxies). Overridden when access_mode is not Custom.
|
||||
options:
|
||||
token: "Token (default)"
|
||||
trusted-proxy: "Trusted Proxy (for reverse proxies)"
|
||||
|
||||
gateway_trusted_proxies:
|
||||
name: Gateway Trusted Proxies
|
||||
description: Comma-separated trusted proxy IP/CIDR list for trusted-proxy mode (example - 127.0.0.1,192.168.88.0/24).
|
||||
|
||||
enable_openai_api:
|
||||
name: Enable OpenAI API
|
||||
description: Enable OpenAI-compatible Chat Completions endpoint. Allows using OpenClaw as a conversation agent in HA Assist pipeline via Extended OpenAI Conversation (HACS) or any OpenAI-compatible client.
|
||||
|
||||
allow_insecure_auth:
|
||||
name: Allow Insecure HTTP Auth
|
||||
description: Allow HTTP authentication for gateway access on LAN. WARNING - Only enable if using HTTP (not HTTPS) for gateway_public_url. Required for browser access over HTTP.
|
||||
force_ipv4_dns:
|
||||
name: Force IPv4 DNS Order
|
||||
description: Force IPv4-first DNS ordering for Node network calls. Most HAOS VMs lack IPv6 egress, causing web_fetch and Telegram timeouts. Recommended ON (default).
|
||||
nginx_log_level:
|
||||
name: Nginx Log Level
|
||||
description: "Access log verbosity for the built-in nginx proxy. 'minimal' (default) suppresses repetitive HA health-check and polling requests. 'full' logs everything."
|
||||
options:
|
||||
minimal: "Minimal (suppress HA polling noise)"
|
||||
full: "Full (log all requests)"
|
||||
gateway_env_vars:
|
||||
name: Gateway Environment Variables
|
||||
description: Environment variables passed to the OpenClaw gateway process at startup (list entries with name/value in Home Assistant UI; max 50 variables, keys up to 255 characters, values up to 10,000 characters).
|
||||
auto_configure_mcp:
|
||||
name: Auto-Configure MCP for Home Assistant
|
||||
description: "When ON and Home Assistant Token is set, automatically registers Home Assistant as an MCP server on each startup. This lets OpenClaw control HA entities, services, and automations via the Model Context Protocol. Disable only if you manage mcporter configuration manually."
|
||||
|
||||
@@ -18,6 +18,10 @@ configuration:
|
||||
homeassistant_token:
|
||||
name: Token de Home Assistant
|
||||
description: Opcional - Token de larga duración de Home Assistant para scripts/herramientas de API local
|
||||
|
||||
http_proxy:
|
||||
name: Proxy HTTP de salida
|
||||
description: Opcional - URL de proxy para solicitudes HTTP/HTTPS salientes (ejemplo - http://192.168.2.1:3128)
|
||||
|
||||
router_ssh_host:
|
||||
name: Host SSH del router
|
||||
@@ -38,23 +42,82 @@ configuration:
|
||||
clean_session_locks_on_exit:
|
||||
name: Limpiar bloqueos de sesión al salir
|
||||
description: Limpiar archivos de bloqueo de sesión cuando el complemento se detiene correctamente
|
||||
|
||||
persist_node_global:
|
||||
name: Conservar habilidades globales de npm
|
||||
description: Cuando está activado, guarda las habilidades npm instaladas por el usuario y los paquetes globales en /config/.node_global para que sobrevivan a reconstrucciones del complemento. Por defecto está desactivado para mantener pequeñas las copias de seguridad de Home Assistant.
|
||||
|
||||
persist_brew_tools:
|
||||
name: Conservar herramientas de Homebrew
|
||||
description: Cuando está activado, guarda Homebrew y las herramientas CLI instaladas con brew en /config/.linuxbrew para que sobrevivan a reconstrucciones del complemento. Por defecto está desactivado para mantener pequeñas las copias de seguridad de Home Assistant.
|
||||
|
||||
gateway_mode:
|
||||
name: Modo del Gateway
|
||||
description: Modo de operación del Gateway - local (ejecutar gateway localmente, recomendado) o remote (conectar a un gateway remoto)
|
||||
|
||||
options:
|
||||
local: "Local (recomendado)"
|
||||
remote: "Remoto"
|
||||
|
||||
gateway_remote_url:
|
||||
name: URL del Gateway Remoto
|
||||
description: URL WebSocket del gateway remoto utilizada cuando Gateway Mode es Remote (ejemplo - ws://192.168.1.20:18789 o wss://gateway.example.com:443)
|
||||
|
||||
gateway_additional_allowed_origins:
|
||||
name: Orígenes permitidos adicionales
|
||||
description: Orígenes extra de Control UI separados por comas que se combinan en gateway.controlUi.allowedOrigins en modo lan_https (ejemplo - https://ha.example.com:8443,capacitor://localhost)
|
||||
|
||||
controlui_disable_device_auth:
|
||||
name: Desactivar emparejamiento por dispositivo en Control UI (lan_https)
|
||||
description: "Cuando está ACTIVADO (recomendado), establece gateway.controlUi.dangerouslyDisableDeviceAuth=true para omitir la aprobación por dispositivo y evitar el error 1008 en modo LAN HTTPS. Déjalo ACTIVADO en redes domésticas/de confianza. Desactívalo solo si quieres emparejamiento estricto para cada navegador/dispositivo nuevo."
|
||||
|
||||
gateway_bind_mode:
|
||||
name: Modo de enlace del Gateway
|
||||
description: Modo de enlace de red - loopback (solo 127.0.0.1, más seguro) o lan (todas las interfaces, accesible desde la red local)
|
||||
|
||||
description: "Modo de enlace de red: loopback (solo 127.0.0.1, más seguro), lan (todas las interfaces) o tailnet (solo interfaz Tailscale). Se anula con las preselecciones del modo de acceso."
|
||||
options:
|
||||
loopback: "Loopback (solo 127.0.0.1, más seguro)"
|
||||
lan: "LAN (todas las interfaces)"
|
||||
tailnet: "Tailnet (solo Tailscale)"
|
||||
|
||||
gateway_port:
|
||||
name: Puerto del Gateway
|
||||
description: Número de puerto en el que el gateway de OpenClaw escuchará (predeterminado - 18789)
|
||||
|
||||
|
||||
access_mode:
|
||||
name: Modo de acceso
|
||||
description: "Simplifica la configuración de acceso seguro. Anula gateway_bind_mode y gateway_auth_mode cuando no es Personalizado."
|
||||
options:
|
||||
custom: "Personalizado (configuración individual)"
|
||||
local_only: "Solo local (loopback + token, solo Ingress)"
|
||||
lan_https: "LAN HTTPS (proxy HTTPS integrado — recomendado para teléfonos)"
|
||||
lan_reverse_proxy: "LAN Proxy inverso (proxy externo con auth trusted-proxy)"
|
||||
tailnet_https: "Tailscale HTTPS (Tailscale + token)"
|
||||
|
||||
gateway_auth_mode:
|
||||
name: Modo de autenticación del Gateway
|
||||
description: Modo de autenticación - token (predeterminado) o trusted-proxy (para proxys inversos HTTPS). Se anula cuando access_mode no es Personalizado.
|
||||
options:
|
||||
token: "Token (predeterminado)"
|
||||
trusted-proxy: "Proxy de confianza (para proxys inversos)"
|
||||
|
||||
gateway_trusted_proxies:
|
||||
name: Proxys de confianza del Gateway
|
||||
description: Lista de IPs/CIDR de proxys de confianza separados por comas para el modo trusted-proxy (ejemplo - 127.0.0.1,192.168.88.0/24).
|
||||
|
||||
enable_openai_api:
|
||||
name: Activar API OpenAI
|
||||
description: Activar endpoint de Chat Completions compatible con OpenAI. Permite usar OpenClaw como agente de conversación en HA Assist pipeline mediante Extended OpenAI Conversation (HACS) o cualquier cliente compatible con OpenAI.
|
||||
|
||||
allow_insecure_auth:
|
||||
name: Permitir autenticación HTTP insegura
|
||||
description: Permitir autenticación HTTP para acceso al gateway en LAN. ADVERTENCIA - Solo habilitar si usa HTTP (no HTTPS) para gateway_public_url. Requerido para acceso desde navegador por HTTP.
|
||||
force_ipv4_dns:
|
||||
name: Forzar orden DNS IPv4
|
||||
description: Fuerza prioridad IPv4 en DNS. La mayoría de VMs HAOS no tienen salida IPv6 — causa errores en web_fetch y Telegram. Recomendado ACTIVADO (por defecto).
|
||||
nginx_log_level:
|
||||
name: Nivel de log Nginx
|
||||
description: "Nivel de detalle del log de acceso de nginx. 'minimal' (por defecto) suprime las solicitudes repetitivas de health-check y polling de HA. 'full' registra todo."
|
||||
options:
|
||||
minimal: "Mínimo (suprimir ruido de polling HA)"
|
||||
full: "Completo (registrar todas las solicitudes)"
|
||||
gateway_env_vars:
|
||||
name: Variables de entorno del Gateway
|
||||
description: Variables de entorno que se pasan al proceso del gateway OpenClaw al iniciarse (lista de entradas name/value en la UI de Home Assistant; maximo 50 variables, claves de hasta 255 caracteres, valores de hasta 10 000 caracteres).
|
||||
auto_configure_mcp:
|
||||
name: Configurar MCP automáticamente para Home Assistant
|
||||
description: "Cuando está ACTIVADO y el token de Home Assistant está configurado, registra automáticamente Home Assistant como servidor MCP en cada inicio. Esto permite a OpenClaw controlar entidades, servicios y automatizaciones de HA mediante el Model Context Protocol. Desactive solo si administra la configuración de mcporter manualmente."
|
||||
|
||||
@@ -18,6 +18,10 @@ configuration:
|
||||
homeassistant_token:
|
||||
name: Token Home Assistant
|
||||
description: Opcjonalnie - długoterminowy token Home Assistant dla lokalnych skryptów/narzędzi API HA
|
||||
|
||||
http_proxy:
|
||||
name: Wychodzący proxy HTTP
|
||||
description: Opcjonalnie - URL proxy dla wychodzących żądań HTTP/HTTPS (przykład - http://192.168.2.1:3128)
|
||||
|
||||
router_ssh_host:
|
||||
name: Host SSH routera
|
||||
@@ -38,23 +42,82 @@ configuration:
|
||||
clean_session_locks_on_exit:
|
||||
name: Wyczyść blokady sesji przy wyjściu
|
||||
description: Usuń pliki blokad sesji gdy dodatek zatrzymuje się poprawnie
|
||||
|
||||
persist_node_global:
|
||||
name: Zachowuj globalne umiejętności npm
|
||||
description: Po włączeniu zapisuje umiejętności npm instalowane przez użytkownika i pakiety globalne w /config/.node_global, aby przetrwały przebudowę dodatku. Domyślnie wyłączone, aby kopie zapasowe Home Assistant były mniejsze.
|
||||
|
||||
persist_brew_tools:
|
||||
name: Zachowuj narzędzia Homebrew
|
||||
description: Po włączeniu zapisuje Homebrew i narzędzia CLI instalowane przez brew w /config/.linuxbrew, aby przetrwały przebudowę dodatku. Domyślnie wyłączone, aby kopie zapasowe Home Assistant były mniejsze.
|
||||
|
||||
gateway_remote_url:
|
||||
name: URL zdalnego Gateway
|
||||
description: Adres WebSocket zdalnego gateway używany gdy Gateway Mode = Remote (przykład - ws://192.168.1.20:18789 lub wss://gateway.example.com:443)
|
||||
|
||||
gateway_additional_allowed_origins:
|
||||
name: Dodatkowe dozwolone origins
|
||||
description: Dodatkowe origins Control UI rozdzielone przecinkami; łączone z gateway.controlUi.allowedOrigins w trybie lan_https (przykład - https://ha.example.com:8443,capacitor://localhost)
|
||||
|
||||
controlui_disable_device_auth:
|
||||
name: Wyłącz parowanie urządzeń Control UI (lan_https)
|
||||
description: "Gdy WŁĄCZONE (zalecane), ustawia gateway.controlUi.dangerouslyDisableDeviceAuth=true, pomija akceptację per-urządzenie i zapobiega błędowi 1008 w trybie LAN HTTPS. Zostaw WŁĄCZONE w domowej/zaufanej sieci. Wyłącz tylko jeśli chcesz ścisłe parowanie dla każdej nowej przeglądarki/urządzenia."
|
||||
|
||||
gateway_bind_mode:
|
||||
name: Tryb bindowania Gateway
|
||||
description: Tryb bindowania sieci - loopback (tylko 127.0.0.1, bardziej bezpieczny) lub lan (wszystkie interfejsy, dostępny z sieci lokalnej)
|
||||
|
||||
description: Tryb bindowania sieci - loopback (tylko 127.0.0.1, najbezpieczniejszy), lan (wszystkie interfejsy) lub tailnet (tylko interfejs Tailscale). Nadpisywane przez ustawienia trybu dostępu.
|
||||
options:
|
||||
loopback: "Loopback (tylko 127.0.0.1, najbezpieczniejszy)"
|
||||
lan: "LAN (wszystkie interfejsy)"
|
||||
tailnet: "Tailnet (tylko Tailscale)"
|
||||
|
||||
gateway_port:
|
||||
name: Port Gateway
|
||||
description: Numer portu na którym gateway OpenClaw będzie nasłuchiwał (domyślnie - 18789)
|
||||
|
||||
enable_openai_api:
|
||||
name: Włącz API OpenAI
|
||||
description: Włącz endpoint Chat Completions kompatybilny z OpenAI. Pozwala używać OpenClaw jako agenta konwersacji w HA Assist pipeline przez Extended OpenAI Conversation (HACS) lub dowolnego klienta kompatybilnego z OpenAI.
|
||||
|
||||
allow_insecure_auth:
|
||||
name: Zezwól na niezabezpieczone uwierzytelnianie HTTP
|
||||
description: Zezwól na uwierzytelnianie HTTP dla dostępu do gateway w sieci LAN. UWAGA - Włącz tylko jeśli używasz HTTP (nie HTTPS) dla gateway_public_url. Wymagane dla dostępu przez przeglądarkę przez HTTP.
|
||||
|
||||
|
||||
gateway_mode:
|
||||
name: Tryb Gateway
|
||||
description: Tryb działania gateway - local (uruchom gateway lokalnie, zalecane) lub remote (połącz się ze zdalnym gateway)
|
||||
options:
|
||||
local: "Lokalny (zalecane)"
|
||||
remote: "Zdalny"
|
||||
|
||||
access_mode:
|
||||
name: Tryb dostępu
|
||||
description: "Upraszcza konfigurację bezpiecznego dostępu. Nadpisuje gateway_bind_mode i gateway_auth_mode gdy nie jest ustawiony na Niestandardowy."
|
||||
options:
|
||||
custom: "Niestandardowy (indywidualne ustawienia)"
|
||||
local_only: "Tylko lokalny (loopback + token, tylko Ingress)"
|
||||
lan_https: "LAN HTTPS (wbudowany proxy HTTPS — zalecane dla telefonów)"
|
||||
lan_reverse_proxy: "LAN Reverse Proxy (zewnętrzny proxy z auth trusted-proxy)"
|
||||
tailnet_https: "Tailscale HTTPS (Tailscale + token)"
|
||||
|
||||
gateway_auth_mode:
|
||||
name: Tryb uwierzytelniania Gateway
|
||||
description: Tryb uwierzytelniania - token (domyślnie) lub trusted-proxy (dla reverse proxy HTTPS). Nadpisywane gdy access_mode nie jest Niestandardowy.
|
||||
options:
|
||||
token: "Token (domyślnie)"
|
||||
trusted-proxy: "Zaufany proxy (dla reverse proxy)"
|
||||
|
||||
gateway_trusted_proxies:
|
||||
name: Zaufane proxy Gateway
|
||||
description: Lista zaufanych IP/CIDR proxy rozdzielona przecinkami dla trybu trusted-proxy (przykład - 127.0.0.1,192.168.88.0/24).
|
||||
|
||||
enable_openai_api:
|
||||
name: Włącz API OpenAI
|
||||
description: Włącz endpoint Chat Completions kompatybilny z OpenAI. Pozwala używać OpenClaw jako agenta konwersacji w HA Assist pipeline przez Extended OpenAI Conversation (HACS) lub dowolnego klienta kompatybilnego z OpenAI.
|
||||
force_ipv4_dns:
|
||||
name: Wymuś kolejność DNS IPv4
|
||||
description: Wymusza priorytet IPv4 w DNS. Większość VM HAOS nie ma wyjścia IPv6 — powoduje błędy web_fetch i Telegram. Zalecane WŁĄCZONE (domyślnie).
|
||||
nginx_log_level:
|
||||
name: Poziom logów Nginx
|
||||
description: "Szczegółowość logów dostępu nginx. 'minimal' (domyślnie) pomija powtarzające się żądania health-check i polling HA. 'full' loguje wszystko."
|
||||
options:
|
||||
minimal: "Minimalny (pominięcie szumu polling HA)"
|
||||
full: "Pełny (logowanie wszystkich żądań)"
|
||||
gateway_env_vars:
|
||||
name: Zmienne środowiskowe gateway
|
||||
description: Zmienne środowiskowe przekazywane do procesu gateway OpenClaw podczas uruchamiania (lista wpisow name/value w UI Home Assistant; maks. 50 zmiennych, klucze do 255 znakow, wartosci do 10000 znakow).
|
||||
auto_configure_mcp:
|
||||
name: Automatyczna konfiguracja MCP dla Home Assistant
|
||||
description: "Gdy WŁĄCZONE i token Home Assistant jest ustawiony, automatycznie rejestruje Home Assistant jako serwer MCP przy każdym starcie. Pozwala to OpenClaw kontrolować urządzenia HA, usługi i automatyzacje przez Model Context Protocol. Wyłącz tylko jeśli zarządzasz konfiguracją mcporter ręcznie."
|
||||
|
||||
@@ -0,0 +1,123 @@
|
||||
configuration:
|
||||
timezone:
|
||||
name: Fuso Horário
|
||||
description: Fuso horário do add-on (ex., America/Sao_Paulo, America/Fortaleza)
|
||||
|
||||
enable_terminal:
|
||||
name: Habilitar Terminal Web
|
||||
description: Habilitar botão do terminal web dentro do Home Assistant (Ingress) via ttyd
|
||||
|
||||
terminal_port:
|
||||
name: Porta do Terminal
|
||||
description: Número da porta para o terminal web (padrão - 7681). Altere se esta porta conflitar com outro serviço.
|
||||
|
||||
gateway_public_url:
|
||||
name: URL Pública do Gateway
|
||||
description: URL base pública para abrir a interface web do Gateway em uma nova aba (não incorporada). Exemplo - https://exemplo.duckdns.org:12345 ou http://192.168.1.10:18789
|
||||
|
||||
homeassistant_token:
|
||||
name: Token do Home Assistant
|
||||
description: Opcional - Token de longa duração do Home Assistant para scripts/ferramentas da API local do HA
|
||||
|
||||
http_proxy:
|
||||
name: Proxy HTTP de saída
|
||||
description: Opcional - URL de proxy para requisições HTTP/HTTPS de saída (exemplo - http://192.168.2.1:3128)
|
||||
|
||||
router_ssh_host:
|
||||
name: Host SSH do Roteador
|
||||
description: Opcional - Nome do host ou endereço IP do roteador/firewall via SSH
|
||||
|
||||
router_ssh_user:
|
||||
name: Usuário SSH do Roteador
|
||||
description: Opcional - Nome de usuário SSH do roteador/firewall
|
||||
|
||||
router_ssh_key_path:
|
||||
name: Caminho da Chave SSH do Roteador
|
||||
description: Caminho para a chave privada SSH para acesso ao roteador (padrão - /data/keys/router_ssh)
|
||||
|
||||
clean_session_locks_on_start:
|
||||
name: Limpar Bloqueios de Sessão ao Iniciar
|
||||
description: Limpar arquivos de bloqueio de sessão obsoletos deixados após falhas/reinicializações quando o add-on iniciar
|
||||
|
||||
clean_session_locks_on_exit:
|
||||
name: Limpar Bloqueios de Sessão ao Sair
|
||||
description: Limpar arquivos de bloqueio de sessão quando o add-on parar normalmente
|
||||
|
||||
persist_node_global:
|
||||
name: Persistir skills globais do npm
|
||||
description: Quando ativado, armazena skills npm instaladas pelo usuário e pacotes globais em /config/.node_global para sobreviverem a reconstruções do add-on. O padrão é desativado para manter menores os backups do Home Assistant.
|
||||
|
||||
persist_brew_tools:
|
||||
name: Persistir ferramentas do Homebrew
|
||||
description: Quando ativado, armazena o Homebrew e ferramentas CLI instaladas via brew em /config/.linuxbrew para sobreviverem a reconstruções do add-on. O padrão é desativado para manter menores os backups do Home Assistant.
|
||||
|
||||
gateway_mode:
|
||||
name: Modo do Gateway
|
||||
description: Modo de operação do gateway - local (executar gateway localmente, recomendado) ou remote (conectar a um gateway remoto)
|
||||
options:
|
||||
local: "Local (recomendado)"
|
||||
remote: "Remoto"
|
||||
|
||||
gateway_remote_url:
|
||||
name: URL do Gateway Remoto
|
||||
description: URL WebSocket do gateway remoto usada quando Gateway Mode está em Remote (exemplo - ws://192.168.1.20:18789 ou wss://gateway.example.com:443)
|
||||
|
||||
gateway_additional_allowed_origins:
|
||||
name: Origens permitidas adicionais
|
||||
description: Origens extras da Control UI separadas por vírgula, mescladas em gateway.controlUi.allowedOrigins no modo lan_https (exemplo - https://ha.example.com:8443,capacitor://localhost)
|
||||
|
||||
controlui_disable_device_auth:
|
||||
name: Desativar pareamento por dispositivo no Control UI (lan_https)
|
||||
description: "Quando LIGADO (recomendado), define gateway.controlUi.dangerouslyDisableDeviceAuth=true para pular aprovação por dispositivo e evitar erro 1008 no modo LAN HTTPS. Mantenha LIGADO em rede doméstica/confiável. Desligue apenas se quiser pareamento estrito para cada novo navegador/dispositivo."
|
||||
|
||||
gateway_bind_mode:
|
||||
name: Modo de Vinculação do Gateway
|
||||
description: Modo de vinculação de rede - loopback (somente 127.0.0.1, mais seguro), lan (todas as interfaces) ou tailnet (somente interface Tailscale). Substituído pelas predefinições do modo de acesso.
|
||||
options:
|
||||
loopback: "Loopback (somente 127.0.0.1, mais seguro)"
|
||||
lan: "LAN (todas as interfaces)"
|
||||
tailnet: "Tailnet (somente Tailscale)"
|
||||
|
||||
gateway_port:
|
||||
name: Porta do Gateway
|
||||
description: Número da porta para o gateway do OpenClaw escutar (padrão - 18789)
|
||||
|
||||
access_mode:
|
||||
name: Modo de Acesso
|
||||
description: "Simplifica a configuração de acesso seguro. Substitui gateway_bind_mode e gateway_auth_mode quando não definido como Personalizado."
|
||||
options:
|
||||
custom: "Personalizado (configurações individuais)"
|
||||
local_only: "Apenas local (loopback + token, apenas Ingress)"
|
||||
lan_https: "LAN HTTPS (proxy HTTPS integrado — recomendado para celulares)"
|
||||
lan_reverse_proxy: "LAN Reverse Proxy (proxy externo com auth trusted-proxy)"
|
||||
tailnet_https: "Tailscale HTTPS (Tailscale + token)"
|
||||
|
||||
gateway_auth_mode:
|
||||
name: Modo de Autenticação do Gateway
|
||||
description: Modo de autenticação - token (padrão) ou trusted-proxy (para reverse proxies HTTPS). Substituído quando access_mode não é Personalizado.
|
||||
options:
|
||||
token: "Token (padrão)"
|
||||
trusted-proxy: "Proxy Confiável (para reverse proxies)"
|
||||
|
||||
gateway_trusted_proxies:
|
||||
name: Proxies Confiáveis do Gateway
|
||||
description: Lista de IPs/CIDR de proxies confiáveis separados por vírgula para o modo trusted-proxy (exemplo - 127.0.0.1,192.168.88.0/24).
|
||||
|
||||
enable_openai_api:
|
||||
name: Habilitar API OpenAI
|
||||
description: Habilitar endpoint de Chat Completions compatível com OpenAI. Permite usar o OpenClaw como agente de conversação no pipeline do HA Assist via Extended OpenAI Conversation (HACS) ou qualquer cliente compatível com OpenAI.
|
||||
force_ipv4_dns:
|
||||
name: Forçar ordem DNS IPv4
|
||||
description: Força prioridade IPv4 no DNS. A maioria das VMs HAOS não tem saída IPv6 — causa erros em web_fetch e Telegram. Recomendado LIGADO (padrão).
|
||||
nginx_log_level:
|
||||
name: Nível de log Nginx
|
||||
description: "Detalhamento do log de acesso do nginx. 'minimal' (padrão) suprime requisições repetitivas de health-check e polling do HA. 'full' registra tudo."
|
||||
options:
|
||||
minimal: "Mínimo (suprimir ruído de polling HA)"
|
||||
full: "Completo (registrar todas as requisições)"
|
||||
gateway_env_vars:
|
||||
name: Variáveis de Ambiente do Gateway
|
||||
description: Variaveis de ambiente passadas para o processo do gateway OpenClaw na inicializacao (lista de entradas name/value na UI do Home Assistant; maximo de 50 variaveis, chaves com ate 255 caracteres, valores com ate 10.000 caracteres).
|
||||
auto_configure_mcp:
|
||||
name: Configurar MCP automaticamente para o Home Assistant
|
||||
description: "Quando LIGADO e o token do Home Assistant estiver definido, registra automaticamente o Home Assistant como servidor MCP a cada inicialização. Isso permite que o OpenClaw controle entidades, serviços e automações do HA via Model Context Protocol. Desative apenas se você gerencia a configuração do mcporter manualmente."
|
||||
Reference in New Issue
Block a user