From dc87859f00396d508044360ca89e28953a42c72e Mon Sep 17 00:00:00 2001 From: root Date: Wed, 28 Jan 2026 21:04:49 +0200 Subject: [PATCH] Add DOCS.md, Moltbot icons, and update log strings --- DOCS.md | 47 +++++++++++++++++++++++++++++++++++++ moltbot_assistant/icon.png | Bin 0 -> 614 bytes moltbot_assistant/logo.png | Bin 0 -> 614 bytes moltbot_assistant/run.sh | 6 ++--- 4 files changed, 50 insertions(+), 3 deletions(-) create mode 100644 DOCS.md create mode 100644 moltbot_assistant/icon.png create mode 100644 moltbot_assistant/logo.png diff --git a/DOCS.md b/DOCS.md new file mode 100644 index 0000000..15170f1 --- /dev/null +++ b/DOCS.md @@ -0,0 +1,47 @@ +# Moltbot Assistant (Home Assistant Add-on) + +This add-on runs a Moltbot Assistant instance on Home Assistant OS (Supervisor add-on). + +> Note: Moltbot is the new name for the upstream Clawdbot project. Internally, this add-on may still use the `clawdbot` CLI/package as a compatibility layer. + +## Features +- Ingress UI inside Home Assistant (no LAN port required) +- Telegram channel support (bot token) +- Optional Brave web search (Brave API key) +- Optional Home Assistant long-lived token persisted in the add-on secrets folder +- Optional web terminal inside Home Assistant (disabled by default) + +## Installation +1. Home Assistant → Settings → Add-ons → Add-on store +2. Add repository URL: + - Add-on store → ⋮ → Repositories → paste the GitHub repo URL +3. Install **Moltbot Assistant** + +## Configuration +Configure via the add-on UI. + +Required: +- `telegram_bot_token` + +Recommended: +- `gateway_bind`: `loopback` +- `gateway_token`: set a fixed token (Ingress proxy uses it server-side) + +Optional: +- `telegram_allow_from`: comma-separated Telegram user IDs +- `homeassistant_token`: written to `/config/secrets/homeassistant.token` +- `brave_api_key`: exported as `BRAVE_API_KEY` (for web search) +- `enable_terminal`: enables web terminal at `/terminal/` + +## UI / Ingress +- The add-on uses **Ingress**. Open the add-on page to access the gateway UI. +- If `enable_terminal=true`, the terminal is available under the same ingress base at `/terminal/`. + +## Security notes +- Keep `gateway_bind=loopback` unless you know what you’re doing. +- Terminal is powerful: only enable it if you trust all Home Assistant admins with shell access to the add-on container. + +## Troubleshooting +- If Ingress loads but the gateway UI is unauthorized, verify `gateway_token` is set. +- If Telegram doesn’t connect, verify the bot token using @BotFather and check add-on logs. +- If search tools fail, check that `brave_api_key` is set and that your plan limits aren’t exceeded. diff --git a/moltbot_assistant/icon.png b/moltbot_assistant/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..533cc812de79e24f30da7c024d5d23ee8be2622c GIT binary patch literal 614 zcmeAS@N?(olHy`uVBq!ia0vp^4Is?H1|$#LC7uRSY)RhkE)4%caKYZ?lNlJ8q&;06 zLn`LHy=&Vg;>gf&QPQyRpz(~Zl{2MR96Z)EqnauCe8L;fGp+_^0nFycqQU1C);z3W z+8xoht?FB~{@SJ6%bzV?ko7x#J2TLD5XhVL_lrAKskwd@uaQzAp05@4mk^eW`36!VYtg6u*06 z`s_{VzpKB`cRxWBa@N(K2@RzY_~gf&QPQyRpz(~Zl{2MR96Z)EqnauCe8L;fGp+_^0nFycqQU1C);z3W z+8xoht?FB~{@SJ6%bzV?ko7x#J2TLD5XhVL_lrAKskwd@uaQzAp05@4mk^eW`36!VYtg6u*06 z`s_{VzpKB`cRxWBa@N(K2@RzY_~/dev/null 2>&1 } @@ -214,7 +214,7 @@ EOF RUN_DOCTOR=$(jq -r '.run_doctor_on_start // false' "$OPTIONS_FILE") if [ "$RUN_DOCTOR" = "true" ]; then - echo "Running clawdbot doctor (auto-fix) ..." + echo "Running assistant doctor (auto-fix) ..." (timeout 60s clawdbot doctor --fix --yes) || true else echo "Skipping clawdbot doctor on startup (run_doctor_on_start=false)" @@ -253,7 +253,7 @@ trap shutdown INT TERM NGINX_PID="" TTYD_PID="" -echo "Starting Clawdbot Gateway..." +echo "Starting Moltbot Assistant gateway (clawdbot-compatible)..." clawdbot gateway run & GW_PID=$!