Add DOCS.md, Moltbot icons, and update log strings

This commit is contained in:
root
2026-01-28 21:04:49 +02:00
parent 7255c316b7
commit dc87859f00
4 changed files with 50 additions and 3 deletions
+47
View File
@@ -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 youre 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 doesnt 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 arent exceeded.
Binary file not shown.

After

Width:  |  Height:  |  Size: 614 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 614 B

+3 -3
View File
@@ -64,7 +64,7 @@ fi
# Session lock cleanup helpers # Session lock cleanup helpers
# ------------------------------------------------------------------------------ # ------------------------------------------------------------------------------
# Returns 0 if a clawdbot gateway process appears to be running, else 1 # Returns 0 if a gateway process appears to be running, else 1
gateway_running() { gateway_running() {
pgrep -f "clawdbot.*gateway.*run" >/dev/null 2>&1 pgrep -f "clawdbot.*gateway.*run" >/dev/null 2>&1
} }
@@ -214,7 +214,7 @@ EOF
RUN_DOCTOR=$(jq -r '.run_doctor_on_start // false' "$OPTIONS_FILE") RUN_DOCTOR=$(jq -r '.run_doctor_on_start // false' "$OPTIONS_FILE")
if [ "$RUN_DOCTOR" = "true" ]; then if [ "$RUN_DOCTOR" = "true" ]; then
echo "Running clawdbot doctor (auto-fix) ..." echo "Running assistant doctor (auto-fix) ..."
(timeout 60s clawdbot doctor --fix --yes) || true (timeout 60s clawdbot doctor --fix --yes) || true
else else
echo "Skipping clawdbot doctor on startup (run_doctor_on_start=false)" echo "Skipping clawdbot doctor on startup (run_doctor_on_start=false)"
@@ -253,7 +253,7 @@ trap shutdown INT TERM
NGINX_PID="" NGINX_PID=""
TTYD_PID="" TTYD_PID=""
echo "Starting Clawdbot Gateway..." echo "Starting Moltbot Assistant gateway (clawdbot-compatible)..."
clawdbot gateway run & clawdbot gateway run &
GW_PID=$! GW_PID=$!