Compare commits

...
105 Commits
Author SHA1 Message Date
TechArtDevandroot b0a0cc3f23 fix: correct bundled OpenClaw version for 0.5.87
Co-authored-by: root <root@0bfc167e-openclaw-assistant.local.hass.io>
2026-08-11 15:32:12 +03:00
TechArtDev 00df877305 Merge pull request #167 from techartdev/bot/openclaw-bump-2026.7.1-2
Bump OpenClaw to 2026.7.1-2
2026-08-10 14:38:47 +03:00
root a037d8311b Bump OpenClaw to 2026.7.1-2 (add-on 0.5.86) 2026-08-10 09:00:46 +03:00
PapurHa beb59e8eb6 Merge pull request #166 from techartdev/bot/openclaw-bump-2026.7.1-2 2026-07-21 15:07:59 +03:00
PapurHa a6af4b78ac docs(changelog): add 0.5.85 release note 2026-07-21 15:07:33 +03:00
root f658885c59 Bump OpenClaw to 2026.7.1-2 (add-on 0.5.85) 2026-07-21 09:00:43 +03:00
TechArtDev ceb9522648 Merge pull request #164 from techartdev/fix/issue-163-mcporter-auto-config
fix(addon): bundle mcporter for HA MCP auto-config
2026-07-17 16:52:47 +03:00
TechArtDev ca2c7cab82 Merge origin/main into fix/issue-163-mcporter-auto-config 2026-07-17 16:51:51 +03:00
TechArtDev 99be0ed6e6 chore(release): 0.5.83 2026-07-17 16:45:27 +03:00
TechArtDev ec825fa8c5 Merge pull request #165 from techartdev/chore/node24-addon-runtime
chore(build): bump add-on runtime to Node 24
2026-07-17 16:43:36 +03:00
root 971e4bc8e0 chore(build): bump add-on runtime to Node 24 2026-07-17 00:34:09 +03:00
root c3a926299f fix(addon): bundle mcporter for HA MCP auto-config 2026-07-17 00:19:13 +03:00
root 883f5b8778 Merge pull request #162 from techartdev/fix/issues-159-150-release 2026-07-17 00:12:08 +03:00
root 7608357297 fix(addon): repair runtime downgrade and lan certs 2026-07-15 13:08:13 +03:00
TechArtDev 9235903ef2 Merge pull request #161 from techartdev/bot/openclaw-bump-2026.7.1
Bump OpenClaw to 2026.7.1
2026-07-14 18:14:19 +03:00
root d5f3831131 Bump OpenClaw to 2026.7.1 (add-on 0.5.81) 2026-07-14 09:00:42 +03:00
TechArtDev b45e665bca Merge pull request #157 from techartdev/bot/openclaw-bump-2026.6.10
Bump OpenClaw to 2026.6.10
2026-06-26 17:51:42 +03:00
root 0b799f5fb1 Bump OpenClaw to 2026.6.10 (add-on 0.5.80) 2026-06-26 09:00:44 +03:00
TechArtDev 6129b62512 Merge pull request #156 from techartdev/bot/openclaw-bump-2026.6.9
Bump OpenClaw to 2026.6.9
2026-06-24 00:48:22 +03:00
root fe082864ec Bump OpenClaw to 2026.6.9 (add-on 0.5.79) 2026-06-23 09:00:40 +03:00
TechArtDev 4d8fa8996a Merge pull request #153 from techartdev/bot/openclaw-bump-2026.6.6
Bump OpenClaw to 2026.6.6
2026-06-16 23:54:44 +03:00
root 45d4066d2a Bump OpenClaw to 2026.6.6 (add-on 0.5.78) 2026-06-16 09:00:32 +03:00
TechArtDev 28574b28ef Merge pull request #149 from techartdev/bot/openclaw-bump-2026.5.28
Bump OpenClaw to 2026.5.28
2026-05-31 10:50:08 +03:00
root 089594a95b Bump OpenClaw to 2026.5.28 (add-on 0.5.77) 2026-05-31 09:00:39 +03:00
TechArtDev 08bc68b9e7 Merge pull request #148 from techartdev/bot/openclaw-bump-2026.5.27
Bump OpenClaw to 2026.5.27
2026-05-29 13:22:21 +03:00
TechArtDev 3a06c4604f Merge branch 'main' into bot/openclaw-bump-2026.5.27 2026-05-29 13:22:09 +03:00
TechArtDev 661085afc3 Bump version to 0.5.76 in config.yaml 2026-05-29 13:21:32 +03:00
TechArtDev ccde8598d7 Merge pull request #146 from techartdev/fix/backup-friendly-persistence-defaults
fix(addon): make heavy tool persistence opt-in
2026-05-29 13:15:28 +03:00
root 80f86ae030 Bump OpenClaw to 2026.5.27 (add-on 0.5.75) 2026-05-29 09:01:20 +03:00
root 082c2c74b2 fix(addon): keep backups lean by default 2026-05-28 01:47:06 +03:00
TechArtDev d070dbe1e1 Merge pull request #145 from techartdev/fix/issue-136-local-embeddings-addon
fix(addon): bundle node-llama-cpp for local embeddings
2026-05-27 23:43:19 +03:00
root 9824f7c138 fix: bundle local embeddings runtime in addon 2026-05-27 23:28:33 +03:00
TechArtDev 71e3fbe410 Merge pull request #144 from techartdev/bot/openclaw-bump-2026.5.22
Bump OpenClaw to 2026.5.22
2026-05-26 14:11:23 +03:00
root c2398c84a4 Bump OpenClaw to 2026.5.22 (add-on 0.5.73) 2026-05-26 09:00:38 +03:00
techartdev 3e5e0877b1 Bump OpenClaw to version 0.5.72 and add repair for known invalid config settings 2026-05-04 10:19:53 +03:00
TechArtDev c769cb88e1 Merge pull request #127 from techartdev/bot/openclaw-bump-2026.5.2
Bump OpenClaw to 2026.5.2
2026-05-03 12:01:49 +03:00
root 865ca08873 Bump OpenClaw to 2026.5.2 (add-on 0.5.71) 2026-05-03 09:01:16 +03:00
TechArtDev f0a465bf7c Update OpenClaw to version 2026.4.27
Bump OpenClaw version to 2026.4.27.
2026-04-30 04:22:52 +03:00
TechArtDev 80ef635315 Merge pull request #124 from techartdev/bot/openclaw-bump-2026.4.26
Bump OpenClaw to 2026.4.26
2026-04-30 04:19:20 +03:00
TechArtDev 2acfc77a3f Update OpenClaw version to 2026.4.27 2026-04-30 04:19:09 +03:00
root 91a2ddd01f Bump OpenClaw to 2026.4.26 (add-on 0.5.70) 2026-04-29 09:01:24 +03:00
TechArtDev f66c574611 Merge pull request #122 from techartdev/bot/openclaw-bump-2026.4.24
Bump OpenClaw to 2026.4.24
2026-04-27 14:33:27 +03:00
root 57a8bf3868 Bump OpenClaw to 2026.4.24 (add-on 0.5.69) 2026-04-27 09:01:16 +03:00
TechArtDev 2b6c875b0e Merge pull request #121 from techartdev/bot/openclaw-bump-2026.4.22
Bump OpenClaw to 2026.4.22
2026-04-25 00:38:13 +03:00
root ff5e1eba1e Bump OpenClaw to 2026.4.22 (add-on 0.5.68) 2026-04-24 09:01:21 +03:00
TechArtDev 9a65e66b75 Merge pull request #116 from techartdev/bot/openclaw-bump-2026.4.12
Bump OpenClaw to 2026.4.12
2026-04-14 12:09:42 +03:00
root 9b7b701d5b Bump OpenClaw to 2026.4.12 (add-on 0.5.67) 2026-04-14 09:00:41 +03:00
TechArtDev 505115e06f Merge pull request #107 from techartdev/fix/landing-token-post-onboard
fix: re-render landing page with gateway token after onboard (issue #102)
2026-04-04 16:17:54 +03:00
root 72495984ad fix: re-render landing page with token after onboard (issue #102)
On first boot the gateway token doesn't exist yet when nginx/landing are
first rendered, so the 'Open Gateway Web UI' button opens the Control UI
without a token and the user sees Unauthorized.

Fix: extract render logic into render_landing(), call it once at startup
(as before) and spawn a background poller that re-renders and HUPs nginx
as soon as the token appears in openclaw.json — no add-on restart needed.

Bumps add-on to 0.5.66.
2026-04-04 15:03:26 +03:00
TechArtDev ba8fd59571 Merge pull request #106 from techartdev/bot/openclaw-bump-2026.4.2
chore: bump OpenClaw to 2026.4.2
2026-04-04 03:09:45 +03:00
root dab02d2e22 chore: bump OpenClaw to 2026.4.2 2026-04-04 03:09:20 +03:00
techartdev 38e104d663 Merge branch 'main' of https://github.com/techartdev/OpenClawHomeAssistant 2026-03-18 14:21:27 +02:00
techartdev 991cc3bcfc feat: enhance gateway daemon detection and restart handling 2026-03-18 14:21:19 +02:00
techartdev 1a4e23e8c3 feat: update version to 0.5.63 and bump OpenClaw to 2026.3.13 2026-03-14 20:14:44 +02:00
techartdev 4f56a16b91 feat: update version to 0.5.62 and fix gateway restart loop issues 2026-03-10 23:31:04 +02:00
techartdev 6a08c66128 feat: update version to 0.5.61 and fix gateway restart loop in tailnet mode 2026-03-10 23:05:32 +02:00
techartdev 02814db080 feat: update version to 0.5.60 and enhance session lock cleanup for non-default agents 2026-03-10 22:44:51 +02:00
techartdev dd6b7eca6c bump version 2026-03-10 21:13:24 +02:00
techartdev c6232b6f5d feat(mcp): add auto-configuration for Home Assistant and enhance documentation 2026-03-10 21:12:21 +02:00
TechArtDev e6cad868ab Merge pull request #92 from techartdev/bot/openclaw-bump-2026.3.7
Bump OpenClaw to 2026.3.7
2026-03-08 13:12:00 +02:00
root 8f91cdc23e Bump OpenClaw to 2026.3.7 (add-on 0.5.58) 2026-03-08 09:00:08 +02:00
TechArtDev 04ffef8f9f Merge pull request #91 from techartdev/fix/issue-89-nodesource-install-stability
fix(build): stabilize NodeSource Node 22 install in Docker image
2026-03-07 15:39:09 +02:00
root 60fb692e7d fix(build): address follow-up Copilot review on NodeSource step
- remove NodeSource repo/key after Node install
- avoid duplicate node -v call via NODE_VERSION variable
2026-03-07 15:38:45 +02:00
root 7d8f7d524d fix(build): address Copilot review for NodeSource repo setup
- ensure nodesource keyring is world-readable for _apt
- assert installed Node major is v22 to avoid Debian Node 18 fallback
2026-03-07 14:48:50 +02:00
root 6707c4ed28 fix(build): make Node 22 install deterministic in Dockerfile
- replace NodeSource setup_22.x pipe script with keyring + apt source
- prevent intermittent apt exit 100 during nodejs install
- bump add-on version to 0.5.57

Fixes #89
2026-03-07 12:44:46 +02:00
TechArtDev 2c5fa46572 Merge pull request #88 from techartdev/fix/issue-87-controlui-device-auth-toggle
feat(addon): make lan_https device-auth toggle configurable
2026-03-07 12:32:21 +02:00
root 31656139c0 chore(release): bump add-on version to 0.5.56 2026-03-06 09:17:20 +02:00
root 3aaed98ac0 feat(addon): make lan_https device auth toggle configurable
Fixes #87
2026-03-06 08:16:43 +02:00
TechArtDev 9259ce16a6 Merge pull request #85 from techartdev/bot/openclaw-bump-2026.3.2
Bump OpenClaw to 2026.3.2
2026-03-03 13:00:03 +02:00
root 206cf75889 Bump OpenClaw to 2026.3.2 (add-on 0.5.55) 2026-03-03 09:00:09 +02:00
TechArtDev c0e83c3aac Add image to README and update integration link 2026-02-25 23:38:54 +02:00
techartdev 45bad5f76b Merge branch 'main' of https://github.com/techartdev/OpenClawHomeAssistant 2026-02-25 18:13:58 +02:00
techartdev 615ea2f1a4 agentic instructions and guidelines 2026-02-25 18:13:45 +02:00
TechArtDev 9181b4d22a Add image and integration link to README
Updated the README to include a new image and integration link.
2026-02-25 17:15:28 +02:00
techartdev ab07454051 docs update 2026-02-25 16:34:07 +02:00
techartdev a82df8c851 Update OpenClaw to 2026.2.24 and enhance gateway configuration options
- Added `gateway_remote_url` and `gateway_additional_allowed_origins` options for improved remote gateway support.
- Updated startup guidance for `gateway_auth_mode=trusted-proxy`.
- Adjusted token retrieval instructions in the landing page.
- Updated translations for new configuration options.
- Fixed various issues related to gateway settings and TLS certificate generation.
2026-02-25 16:24:21 +02:00
techartdev 90607c867d relocate release workflow 2026-02-24 17:44:36 +02:00
techartdev dd14dd0f7d docs update 2026-02-24 17:36:36 +02:00
techartdev 55d678c7ef Bump OpenClaw to 2026.2.23 2026-02-24 17:36:00 +02:00
techartdev b5a3e3ccde discord announcement per release 2026-02-24 00:45:58 +02:00
TechArtDev 8d7caf7ad5 Merge pull request #73 from techartdev/chore/add-question-issue-template
chore(github): add question/help issue template
2026-02-24 00:23:30 +02:00
root ec5adcb297 chore(github): add question/help issue template 2026-02-24 00:22:03 +02:00
TechArtDev f22c273599 Merge pull request #72 from techartdev/chore/add-issue-templates
chore(github): add issue templates for bug and feature requests
2026-02-24 00:20:23 +02:00
root 24ec277043 chore(github): update addon discord invite link 2026-02-24 00:19:19 +02:00
TechArtDev 02a4393822 Update Discord server link in README 2026-02-24 00:17:44 +02:00
root 6629013d81 chore(github): add addon docs and addon discord links to issue config 2026-02-24 00:15:44 +02:00
root 8bfc304009 chore(github): add issue templates for bug reports and feature requests 2026-02-24 00:08:28 +02:00
TechArtDev e014805b4b Merge pull request #70 from megamen32/main
feat: support gateway environment variables via add-on config
2026-02-23 22:05:59 +02:00
TechArtDev 5117d7c561 Fix increment of env_count variable 2026-02-23 22:04:29 +02:00
macm1 1c2694c526 -denylist includes low-level env injection vectors too: LD_, DYLD_, BASH_ENV, ENV, BASH_FUNC_*
-fixed changelog
2026-02-23 20:34:36 +03:00
macm1 9908db2f99 feat: support list based gateway env vars 2026-02-23 18:53:09 +03:00
macm1 e64a85bb3a updated version to 0.5.52, and added a note about reserved keys in gateway_env_vars. 2026-02-23 18:21:30 +03:00
macm1 0dea325473 put some guards at critical runtime env vars 2026-02-23 18:17:14 +03:00
macm1 5003263eef Merge remote-tracking branch 'upstream/main'
# Conflicts:
#	openclaw_assistant/CHANGELOG.md
#	openclaw_assistant/config.yaml
#	openclaw_assistant/run.sh
#	openclaw_assistant/translations/bg.yaml
#	openclaw_assistant/translations/de.yaml
#	openclaw_assistant/translations/en.yaml
#	openclaw_assistant/translations/es.yaml
#	openclaw_assistant/translations/pl.yaml
#	openclaw_assistant/translations/pt-BR.yaml
2026-02-23 18:08:09 +03:00
techartdev c16b938674 feat: Update changelog and configuration for version 0.5.51
- Set default `force_ipv4_dns` to true to prevent web_fetch timeouts in HAOS VMs.
- Introduced `nginx_log_level` option to control access log verbosity.
- Updated translations for new configuration options.
2026-02-23 15:50:07 +02:00
techartdev 78353c336f update docs 2026-02-23 11:48:08 +02:00
techartdev 6eb2e11862 conf update 2026-02-23 10:11:54 +02:00
macm1 6990b07d79 feat: add gateway env vars option 2026-02-23 06:38:40 +03:00
macm1 94fab5b260 added translation 2026-02-23 06:31:41 +03:00
macm1 872a52221e refactor: remove env vars from oc_config_helper, keep validation in run.sh
Environment variables are fully handled by run.sh:
- run.sh reads gateway_env_vars from options.json
- run.sh validates variable names (alphanumeric + underscore)
- run.sh enforces max 50 variables and 255 char name limit
- run.sh exports to process environment

oc_config_helper.py now only manages gateway config (mode, port, bind).

Removes:
- env_vars parameter from apply_gateway_settings()
- All env var parsing and validation from Python helper
- MAX_ENV_VARS constants
- env_vars CLI argument
2026-02-23 06:06:20 +03:00
macm1 b45d2e685a refactor: remove env vars persistence, only validate and export
Environment variables should NOT be saved to openclaw.json config.
Instead, they are injected directly into the gateway process via run.sh.

Flow:
  options.json (gateway_env_vars) → run.sh (export) → gateway process env

Changes:
- Remove cfg["env"] initialization from apply_gateway_settings
- Only validate env vars format and size limits in oc_config_helper.py
- Log validated vars but don't persist them to config
- run.sh remains responsible for parsing and exporting to process env
- Cleaner separation of concerns: helpers validates, run.sh exports
2026-02-23 06:00:01 +03:00
macm1 47631c1968 fix: store env vars in cfg[env][vars] not cfg[gateway][env] 2026-02-23 05:55:59 +03:00
macm1 30d95b8798 refactor: use YAML map for gateway environment variables instead of string parsing
Benefits:
- More idiomatic configuration format for Home Assistant add-ons
- config.yaml: Change default from empty string to empty YAML map
- config.yaml: Update schema type from str? to map(str)?
- config.yaml: Improve documentation to explain YAML map usage
- run.sh: Parse JSON object from jq using to_entries instead of semicolon splitting
- oc_config_helper.py: Accept JSON string and parse as dict instead of semicolon-separated values
- Better error handling for invalid JSON
- Cleaner and more maintainable parsing logic

This allows users to configure environment variables more naturally:
  gateway_env_vars:
    OPENAI_API_KEY: sk-abc123
    SERVICE_URL: https://api.example.com
2026-02-23 05:40:32 +03:00
macm1 9b402d3130 refactor: improve gateway env vars security and limits
- Add max limits (50 vars, 255 char names, 10000 char values)
- Validate variable names with regex
- Warn about duplicate variables
- Show var names in logs (not just count)
- Improve bash parsing with process substitution
- Better config documentation with examples
2026-02-23 05:36:07 +03:00
macm1 5086b88a00 feat: Add gateway environment variables support
- Add 'gateway_env_vars' configuration option to addon config
- Parse semicolon-separated KEY=VALUE pairs from add-on options
- Export environment variables to gateway process at startup
- Store parsed env vars in openclaw.json (gateway.env)

Allows users to pass custom environment variables to the gateway via
Home Assistant add-on configuration, e.g.:
  gateway_env_vars: 'SERVICE_API_KEY=123;SERVICE2_API=1231'

These variables are exported to the gateway process and can be used
for API authentication, feature flags, or other configuration needs.
2026-02-23 05:28:32 +03:00
29 changed files with 2416 additions and 262 deletions
+100
View File
@@ -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.
+14
View File
@@ -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
+70
View File
@@ -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`.
+68
View File
@@ -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"
+9
View File
@@ -0,0 +1,9 @@
{
"recommendations": [
"timonwong.shellcheck",
"redhat.vscode-yaml",
"ms-python.python",
"ms-python.vscode-pylance",
"esbenp.prettier-vscode"
]
}
+44
View File
@@ -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
}
}
+108
View File
@@ -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).
+1
View File
@@ -0,0 +1 @@
AGENTS.md
+266 -62
View File
@@ -43,10 +43,10 @@ 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/` | Yes | Homebrew install and brew-installed CLI tools |
| `/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) |
@@ -89,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
@@ -100,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.
@@ -159,19 +164,29 @@ This is the simplest way to get secure LAN access, especially for phones and tab
> **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
### Method B — HTTPS via external reverse proxy (tested recipe: NPM)
If you already run a reverse proxy (NPM, Caddy, Traefik):
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's IP/CIDR (e.g., `127.0.0.1,192.168.88.0/24`)
3. Set `gateway_public_url` to your HTTPS URL
4. Configure your proxy to forward HTTPS to `<HA-IP>:18789`
5. Restart the add-on
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
See the landing page's **Reverse-proxy recipes** section for copy-paste configs.
**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`
> **Note**: Nabu Casa remote access only proxies port 8123 — it cannot forward custom ports. The Ingress page works through Nabu Casa, but the Gateway UI requires one of the methods above.
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)
@@ -185,13 +200,22 @@ Then open `http://localhost:18789` in your browser. `localhost` counts as a secu
> **Limitation**: SSH forwarding doesn't work on phones/tablets. Use `lan_https` for mobile access.
### Method D — Tailscale HTTPS
### Method D — Tailnet flow (tested with HA Tailscale add-on + NPM)
1. Set `access_mode`: **tailnet_https**
2. Enable HTTPS certificates 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`
5. Restart the add-on
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
@@ -221,9 +245,11 @@ This means the browser is connecting over plain HTTP. **Solutions**:
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
@@ -241,16 +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_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` |
| `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` |
| `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) |
| `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.
| `force_ipv4_dns` | bool | `false` | Force IPv4-first DNS ordering for Node network calls. Useful if IPv6 DNS resolves but IPv6 egress is broken (can affect Telegram API polling). |
### Terminal
@@ -284,7 +315,9 @@ 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
@@ -325,14 +358,12 @@ This is the most common setup — accessing the Gateway Web UI from a browser on
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
@@ -341,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.
@@ -355,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
@@ -375,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.
@@ -391,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 hasnt 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"_
- _"Whats 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 doesnt see HA entities | Run `mcporter call home-assistant.GetLiveContext` to refresh |
| Model says “whats MCP?” | Switch to a more capable model for the initial session (see above) |
To enable it, add to `/config/.openclaw/openclaw.json`:
```json
@@ -494,10 +651,10 @@ You should see your account listed with the `sheets` service.
| 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 & brew-installed tools | `/config/.linuxbrew/` | Yes (synced on startup) |
| 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 |
@@ -514,19 +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
Homebrew (Linuxbrew) and all brew-installed CLI tools (e.g., `gemini`, `aider`, `gh`, `bw`) are now **persisted** across add-on updates. On each startup, the add-on:
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.
This means `brew install` packages survive image rebuilds only when persistence is enabled.
---
@@ -552,6 +711,7 @@ The add-on image includes these tools, available in the terminal:
| 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
@@ -587,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 and brew-installed packages are preserved (synced to `/config/.linuxbrew/`)
- 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
@@ -600,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**
@@ -609,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
```
@@ -619,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.
---
@@ -653,11 +827,23 @@ 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`
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".
@@ -675,17 +861,15 @@ Go to **Settings → Add-ons → OpenClaw Assistant → Log** tab. Logs show sta
**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.78+** this is configured automatically on startup. If you still see the error:
1. Restart the add-on (the startup script detects the LAN IP and sets the origins).
2. If the IP has changed since you last started, restart again — the cert and origins are regenerated.
3. **Manual override** (from the add-on terminal):
**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"]'
```
Replace the IP and port with your actual values, then restart the gateway:
```sh
openclaw gateway restart
```
Then restart the add-on to re-merge defaults + extras.
### "disconnected (1008): pairing required"
@@ -693,7 +877,7 @@ Go to **Settings → Add-ons → OpenClaw Assistant → Log** tab. Logs show sta
**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.80+** the add-on automatically sets `gateway.controlUi.dangerouslyDisableDeviceAuth: true` on startup when using `lan_https` mode. This bypasses per-device pairing — token authentication is still enforced.
**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.
@@ -709,7 +893,7 @@ Go to **Settings → Add-ons → OpenClaw Assistant → Log** tab. Logs show sta
"allowedOrigins": ["https://YOUR_IP:18789"]
}
```
Then restart the gateway: `openclaw gateway restart`
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
@@ -721,17 +905,37 @@ Go to **Settings → Add-ons → OpenClaw Assistant → Log** tab. Logs show sta
**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:
@@ -741,7 +945,7 @@ If Telegram is configured but polling fails with network fetch errors:
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, set add-on option `force_ipv4_dns: true` and restart.
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.
@@ -763,7 +967,7 @@ Built-in skills are synced to persistent storage on each startup. If skills are
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
@@ -843,13 +1047,13 @@ 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. 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.
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.
+4 -2
View File
@@ -1,7 +1,9 @@
# OpenClaw Assistant Home Assistant App/Add-on
## [Join our Discord Server!](https://discord.gg/Nx4H3XmY)
![OpenClaw Assistant](https://github.com/techartdev/OpenClawHomeAssistant/blob/main/oca_addon.png?raw=true)
## [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
+205
View File
@@ -2,6 +2,211 @@
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!]**
+44 -25
View File
@@ -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 \
@@ -30,22 +31,35 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
bat \
less \
openssl \
&& apt-get clean \
&& rm -rf /var/lib/apt/lists/*
&& 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
@@ -57,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.
@@ -69,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
@@ -94,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.22-2
&& 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'
@@ -127,10 +145,11 @@ 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 /render_nginx.py /usr/local/bin/oc-cleanup \
&& 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" ]
+58 -5
View File
@@ -1,5 +1,5 @@
name: OpenClaw Assistant
version: "0.5.49"
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
@@ -56,12 +56,21 @@ 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, most secure)
# - lan: bind to all interfaces (accessible from local network)
@@ -89,15 +98,50 @@ options:
# 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
# Force IPv4-first DNS result ordering for Node fetch/network calls.
# Useful on networks where IPv6 resolution exists but IPv6 egress is broken
# (can affect Telegram API polling in some HAOS/VM setups).
force_ipv4_dns: false
# 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:
@@ -114,12 +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_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?
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

+29 -3
View File
@@ -109,12 +109,38 @@
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 in the terminal:
<code>openclaw config get gateway.auth.token</code>
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">
@@ -210,7 +236,7 @@ SSL tab: Request a new SSL certificate (Let's Encrypt or custom)</pre>
'pairing required': {
friendly: 'The Gateway requires device pairing before the Control UI can connect.',
fix: ACCESS_MODE === 'lan_https'
? 'Restart the add-on — it auto-sets <code>controlUi.dangerouslyDisableDeviceAuth: true</code> to skip pairing (token auth is still enforced). <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>'
? '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': {
Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 62 KiB

+2 -2
View File
@@ -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;
+133
View File
@@ -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
+102 -31
View File
@@ -57,12 +57,13 @@ 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, auth_mode: str, trusted_proxies_csv: str):
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"
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
@@ -97,7 +98,12 @@ def apply_gateway_settings(mode: str, bind_mode: str, port: int, enable_openai_a
cfg["gateway"] = {}
gateway = cfg["gateway"]
# 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"] = {}
@@ -120,6 +126,7 @@ def apply_gateway_settings(mode: str, bind_mode: str, port: int, enable_openai_a
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)
@@ -132,6 +139,10 @@ def apply_gateway_settings(mode: str, bind_mode: str, port: int, enable_openai_a
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
@@ -166,28 +177,27 @@ 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}, authMode={auth_mode}, trustedProxies={trusted_proxies})")
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):
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: true — skips the interactive device
pairing ceremony. In a self-hosted HA add-on the user already
controls the gateway token, so the pairing step adds friction
without meaningful security benefit.
- 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 allowed origins.
Pass an empty string to clear / leave unset.
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:
@@ -201,21 +211,32 @@ def set_control_ui_origins(origins_csv: str):
gateway["controlUi"] = {}
control_ui = gateway["controlUi"]
origins = [o.strip() for o in origins_csv.split(",") if o.strip()]
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 current_origins != origins:
control_ui["allowedOrigins"] = origins
changes.append(f"allowedOrigins: {current_origins} -> {origins}")
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 ---
# Skips the interactive pairing handshake (error 1008: pairing required).
# Token auth is still enforced; this only disables the per-device approval.
if control_ui.get("dangerouslyDisableDeviceAuth") is not True:
control_ui["dangerouslyDisableDeviceAuth"] = True
changes.append("dangerouslyDisableDeviceAuth: True")
# 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",):
@@ -224,7 +245,8 @@ def set_control_ui_origins(origins_csv: str):
changes.append(f"removed invalid key: {stale_key}")
if not changes:
print(f"INFO: controlUi already correct: origins={origins}, deviceAuth=disabled")
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):
@@ -234,6 +256,43 @@ def set_control_ui_origins(origins_csv: str):
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:
@@ -243,16 +302,17 @@ def main():
cmd = sys.argv[1]
if cmd == "apply-gateway-settings":
if len(sys.argv) != 8:
print("Usage: oc_config_helper.py apply-gateway-settings <local|remote> <loopback|lan|tailnet> <port> <enable_openai_api:true|false> <auth_mode:token|trusted-proxy> <trusted_proxies_csv>")
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"
auth_mode = sys.argv[6]
trusted_proxies_csv = sys.argv[7]
success = apply_gateway_settings(mode, bind_mode, port, enable_openai_api, auth_mode, trusted_proxies_csv)
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":
@@ -266,11 +326,22 @@ def main():
sys.exit(0)
elif cmd == "set-control-ui-origins":
if len(sys.argv) != 3:
print("Usage: oc_config_helper.py set-control-ui-origins <origins_csv>")
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]
success = set_control_ui_origins(origins_csv)
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":
+16 -1
View File
@@ -30,6 +30,7 @@ def main():
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', '')
@@ -37,7 +38,21 @@ def main():
gw_path = '' if public_url.endswith('/') else '/'
# ── nginx.conf ──────────────────────────────────────────────
conf = tpl.replace('__TERMINAL_PORT__', terminal_port)
# 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 = ''
+831 -125
View File
File diff suppressed because it is too large Load Diff
+33 -1
View File
@@ -42,6 +42,14 @@ 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
@@ -50,6 +58,18 @@ configuration:
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 (всички интерфейси) или tailnet (само Tailscale интерфейс). Пренебрегва се от предварителните режими на достъп.
@@ -88,4 +108,16 @@ configuration:
description: Активиране на OpenAI-съвместим Chat Completions ендпойнт. Позволява използването на OpenClaw като разговорен агент в HA Assist pipeline чрез Extended OpenAI Conversation (HACS) или всеки OpenAI-съвместим клиент.
force_ipv4_dns:
name: Принудителен IPv4 DNS ред
description: Принудително задава IPv4-приоритет при DNS резолв за Node мрежови заявки. Полезно е, когато IPv6 DNS се резолвира, но IPv6 интернет маршрутизацията е неработеща (може да влияе на Telegram API polling).
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 конфигурацията ръчно."
+33 -1
View File
@@ -42,6 +42,14 @@ 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
@@ -50,6 +58,18 @@ configuration:
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, am sichersten), lan (alle Schnittstellen) oder tailnet (nur Tailscale-Schnittstelle). Wird durch Zugriffsmodus-Voreinstellungen überschrieben.
@@ -88,4 +108,16 @@ configuration:
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.
force_ipv4_dns:
name: IPv4-DNS-Reihenfolge erzwingen
description: Erzwingt IPv4-vorrangige DNS-Auflösung für Node-Netzwerkaufrufe. Nützlich, wenn IPv6-DNS aufgelöst wird, aber IPv6-Internet-Routing nicht funktioniert (kann Telegram-API-Polling beeinträchtigen).
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."
+33 -1
View File
@@ -42,6 +42,14 @@ 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
@@ -50,6 +58,18 @@ configuration:
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, most secure), lan (all interfaces), or tailnet (Tailscale interface only). Overridden by access_mode presets.
@@ -88,4 +108,16 @@ configuration:
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.
force_ipv4_dns:
name: Force IPv4 DNS Order
description: Force IPv4-first DNS ordering for Node network calls. Useful when IPv6 DNS resolves but IPv6 internet routing is broken (can affect Telegram API polling).
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."
+33 -1
View File
@@ -42,6 +42,14 @@ 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
@@ -50,6 +58,18 @@ configuration:
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), lan (todas las interfaces) o tailnet (solo interfaz Tailscale). Se anula con las preselecciones del modo de acceso."
@@ -88,4 +108,16 @@ configuration:
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.
force_ipv4_dns:
name: Forzar orden DNS IPv4
description: Fuerza el orden de DNS con prioridad IPv4 para llamadas de red de Node. Útil cuando el DNS IPv6 resuelve, pero el enrutamiento IPv6 a Internet falla (puede afectar el polling de la API de Telegram).
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."
+33 -1
View File
@@ -42,7 +42,27 @@ 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, najbezpieczniejszy), lan (wszystkie interfejsy) lub tailnet (tylko interfejs Tailscale). Nadpisywane przez ustawienia trybu dostępu.
@@ -88,4 +108,16 @@ configuration:
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 preferowanie IPv4 przy rozwiązywaniu DNS dla wywołań sieciowych Node. Przydatne, gdy DNS IPv6 się rozwiązuje, ale routing IPv6 do Internetu nie działa (może wpływać na polling API Telegrama).
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."
+33 -1
View File
@@ -42,6 +42,14 @@ configuration:
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
@@ -50,6 +58,18 @@ configuration:
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.
@@ -88,4 +108,16 @@ configuration:
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 a ordem de DNS com prioridade para IPv4 nas chamadas de rede do Node. Útil quando o DNS IPv6 resolve, mas o roteamento IPv6 para a internet está quebrado (pode afetar o polling da API do Telegram).
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."