AmberChest als Add-on: Mail-Sicherung in der Seitenleiste von Home Assistant

Unter Home Assistant OS lässt sich AmberChest als Add-on betreiben. Das Add-on lässt Weboberfläche und Zeitplaner in einem Container unter dem Supervisor laufen, die Oberfläche erscheint in der Seitenleiste. Es ist ein Zeiger auf das veröffentlichte AmberChest-Image und enthält selbst keine Anwendung.

Wie es in Home Assistant eingebunden ist

Damit AmberChest als Add-on laufen kann, versteht der Container /data/options.json, die Datei, in der der Supervisor einem Add-on seine Optionen übergibt, und wandelt sie in die Konfiguration um, die AmberChest schon kannte. Die Konfiguration landet in /data/config, das Archiv in /share/mail-archive; beides überlebt ein Add-on-Update. Diese Unterstützung kam mit Version 1.1.2 der Anwendung.

Die Oberfläche kommt per Ingress nach Home Assistant, im Browser und in der Home-Assistant-App auf dem Handy. Ingress braucht keinen offenen Port: Home Assistant reicht die Oberfläche selbst durch, und das Add-on antwortet ausschließlich diesem Proxy. Weil Home Assistant den Benutzer schon authentifiziert hat, läuft das Add-on ohne eigenen Login.

Installation

1. Unter „Einstellungen → Add-ons → Add-on-Store → ⋮ → Repositories“ die Adresse https://github.com/sphings79/amberchest-ha-app hinzufügen.
2. AmberChest installieren.
3. Unter „Konfiguration“ ein Master-Passwort setzen.
4. Starten und AmberChest in der Seitenleiste öffnen.

Ohne Master-Passwort startet das Add-on nicht, weil es seine eigene Konfiguration nicht öffnen kann. Das Passwort verschlüsselt alle gespeicherten Postfach-Passwörter und muss aufbewahrt werden. Die Optionen im Überblick:

master_password: irgendwas-langes
ui_password: ""
cron: "0 3 * * *"
cron_export_attachments: false
archive_path: /share/mail-archive
log_level: info

cron hat fünf Felder (Minute, Stunde, Tag, Monat, Wochentag); 0 3 * * * ist jede Nacht um drei, leer heißt kein Zeitplan. Mit cron_export_attachments läuft nach jeder geplanten Sicherung der Anhang-Export. archive_path muss unter /share, /media oder /backup liegen: Ein Pfad, der in den Container hineinzeigt, wäre nach einem Update leer. Das Archiv liegt in /share und gehört deshalb zu einem Home-Assistant-Backup. Werden die Backups zu groß, lässt sich archive_path auf eine Netzwerkfreigabe unter /media legen und dort ausschließen.

Von außen erreichbar machen

Ingress ist keine Adresse, mit der andere Programme sprechen können. Wer ein Archiv aus der Desktop-App ins Add-on umziehen will, wer die Oberfläche von einem anderen Rechner öffnen oder die Home-Assistant-Integration anbinden möchte, braucht dafür zwei Einstellungen im Reiter „Konfiguration“: ein ui_password unter „Optionen“ und den Port 8484 unter „Netzwerk“. Danach antwortet die Oberfläche auch unter http://homeassistant.local:8484, und genau diese Adresse will „Umziehen“ in der Desktop-App. Nur den Port freizugeben bewirkt nichts: Ohne eigene Anmeldung weist das Add-on alles ab, was nicht der Supervisor ist, und schreibt das ins Protokoll. Das ist auch die Meldung „Only reachable through Home Assistant“, wenn man die Seite direkt aufruft. Die bebilderte Anleitung dazu liegt im Repository unter docs/remote-access.de.md und auf dem Reiter „Dokumentation“ des Add-ons.

Sensoren statt nur Oberfläche

Zwei Wege führen zu Entitäten. Die Integration verlangt den freigegebenen Port samt ui_password und bringt eine Lovelace-Karte mit, braucht aber keinen Broker. MQTT ist im Add-on selbst eingebaut: Unter „Home Assistant“ in der Oberfläche trägt man den Broker ein, und Home Assistant legt per Discovery je Postfach ein Gerät an. Beide dürfen nebeneinander laufen.

Updates

Ein Update des Add-ons ist eine Versionsnummer. Ein Workflow im Repository prüft stündlich, ob AmberChest ein neueres Release hat, stellt sicher, dass das passende Image veröffentlicht ist, prüft die Konfiguration und trägt die Version ein. Danach bietet Home Assistant das Update wie gewohnt an. Geholt wird, nicht gepusht: Ein Workflow-Token gilt nur für sein eigenes Repository, ein Push aus dem Anwendungs-Repository bräuchte einen persönlichen Zugriffstoken. So braucht es gar kein Geheimnis. Wer eine Version sofort will, startet unter „Actions“ den Workflow „Follow AmberChest“ von Hand. GitHub schaltet geplante Workflows nach 60 Tagen ohne Commit im Repository ab; dann ebenfalls einmal von Hand starten.

Voraussetzungen

Add-ons gibt es nur bei Home Assistant OS und Supervised. Bei Container und Core läuft dasselbe Image direkt mit Docker Compose. Unterstützt werden aarch64 und amd64, eine 32-Bit-Fassung gibt es nicht. Auf einem Raspberry Pi läuft es mit einer 64-Bit-Installation, wobei man auf den Speicher achten sollte: Eine SD-Karte ist kein guter Platz für ein 20-GB-Archiv. Das Projekt ist inoffiziell und weder mit der Open Home Foundation noch mit dem Home-Assistant-Projekt verbunden.