Rebrand add-on to Moltbot Assistant and remove Papur naming
This commit is contained in:
@@ -1,37 +1,47 @@
|
||||
# Papur (Clawdbot) Home Assistant Add-on (Draft)
|
||||
# Moltbot Assistant – Home Assistant Add-on (Draft)
|
||||
|
||||
This is a starter Home Assistant add-on wrapper to run **Clawdbot** as a Supervisor-managed container on **HAOS**.
|
||||
This repository contains a Home Assistant add-on that runs a **Moltbot Assistant** instance on **HAOS**.
|
||||
|
||||
## What this gives you
|
||||
- Always-on Clawdbot instance on your HAOS host
|
||||
- Separate bot identity (you will provide a new Telegram bot token)
|
||||
- Persistent storage in `/data` inside the add-on (maps to HAOS add-on data folder)
|
||||
Upstream note: Moltbot is the new name for the Clawdbot project. The add-on may still install/use the `clawdbot` npm package/CLI for compatibility until the upstream transition fully settles.
|
||||
|
||||
## Notes / constraints
|
||||
- This is a **headless** deployment; browser automation via Chrome-extension relay won’t be available.
|
||||
- You can still do LAN automation (MikroTik/HA API, cron reminders, etc.).
|
||||
## What you get
|
||||
- Always-on personal assistant running as a Supervisor-managed container
|
||||
- Home Assistant **Ingress UI** (the assistant Gateway UI inside the add-on page)
|
||||
- Optional **web terminal** inside Home Assistant (disabled by default)
|
||||
- Persistent data stored under the add-on config directory (in-container: `/config`)
|
||||
|
||||
## Install overview (high level)
|
||||
1. Put this repo on GitHub (or local git).
|
||||
2. In Home Assistant: **Settings → Add-ons → Add-on Store → ⋮ → Repositories**
|
||||
3. Add the repo URL.
|
||||
4. Install the add-on and configure the options.
|
||||
## Security defaults
|
||||
- Gateway binds to **loopback** by default (not exposed on LAN)
|
||||
- Terminal is **off by default**
|
||||
- Tokens/IDs are provided via add-on options and are never hardcoded
|
||||
|
||||
## Install (high level)
|
||||
1. Add this repo in Home Assistant:
|
||||
Settings → Add-ons → Add-on Store → ⋮ → Repositories
|
||||
2. Install **Moltbot Assistant**
|
||||
3. Configure options (at minimum: Telegram bot token)
|
||||
|
||||
## Configuration
|
||||
You’ll set options in the add-on UI (Telegram token + optional HA token + MikroTik connection hints). See `papur-addon/config.yaml` schema.
|
||||
All configuration is done via the add-on UI.
|
||||
See the schema in `moltbot_assistant/config.yaml`.
|
||||
|
||||
### MikroTik key
|
||||
For MikroTik access, put the private key file inside the add-on data folder:
|
||||
- host path (HAOS): `/addon_configs/<addon_slug>/keys/mikrotik_papur_nopw`
|
||||
- in-container path: `/data/keys/mikrotik_papur_nopw`
|
||||
### Optional: Brave Search
|
||||
If you provide `brave_api_key`, the add-on exports `BRAVE_API_KEY` for the assistant’s web search tool.
|
||||
|
||||
(Exact host path may vary; easiest is using File editor / Samba share to place the key under the add-on’s data directory.)
|
||||
### Optional: Home Assistant token
|
||||
If you provide `homeassistant_token`, it is written to `/config/secrets/homeassistant.token` inside the container for local scripts/tools.
|
||||
|
||||
## Logs
|
||||
View logs in the add-on UI.
|
||||
### Optional: MikroTik SSH
|
||||
If you want MikroTik automation, provide:
|
||||
- `mikrotik_host`
|
||||
- `mikrotik_ssh_user`
|
||||
- `mikrotik_ssh_key_path` (default: `/data/keys/mikrotik`)
|
||||
|
||||
## Next steps
|
||||
If you want, I can tailor:
|
||||
- default config for Telegram routing
|
||||
- persistent memory paths
|
||||
- optional Home Assistant token mounting (for HA integration skill)
|
||||
Place the SSH key file under the add-on config folder (e.g., with File editor), so it appears in-container at `/data/keys/...`.
|
||||
|
||||
## UI
|
||||
- The main add-on page loads the Gateway UI via **Ingress**.
|
||||
- If enabled, web terminal is available at `/terminal/` under the ingress UI.
|
||||
|
||||
## Status
|
||||
This is still in "draft" while we finalize naming, docs, and a public release process.
|
||||
|
||||
Reference in New Issue
Block a user