Zum Inhalt springen
Localtonet Localtonet Dashboard

Localtonet auf einem NAS oder Home Assistant ausführen

Einrichtungsvorlagen AMD64 und ARM64

Hilfe zu dieser Seite
Auf dieser Seite 7 Abschnitte
  1. Was die Vorlagen sind
  2. Was sie nicht sind
  3. Bevor Sie beginnen
  4. Ein NAS mit Docker Compose einrichten
  5. Das ZIP entpacken und den Ordner nas auf das NAS kopieren
  6. Die Token-Datei erstellen
  7. compose.yaml unverändert lassen
  8. Das Projekt starten
  9. Einen Tunnel erstellen und starten
  10. Was die Compose-Vorlage bewirkt
  11. Home Assistant OS oder Supervised einrichten
  12. Den App-Ordner kopieren
  13. Den App-Store neu laden und Localtonet installieren
  14. Ihr Token eingeben und die App starten
  15. Einen Tunnel erstellen und starten
  16. Ihre Dienste erreichen
  17. Protokolle und Updates
  18. Verwandte Seiten

Localtonet stellt Bereitstellungsvorlagen bereit, die den Localtonet-Client als Container auf einem Docker-fähigen NAS und auf Home Assistant ausführen. Sie tragen Ihren AuthToken ein, starten den Container und verwalten die Tunnel anschließend im Dashboard.

Was die Vorlagen sind #

Der Download ist ein kleines ZIP-Archiv mit zwei Vorlagen, insgesamt fünf Dateien:

VorlageEinsatz aufDateienWas Sie ändern
NAS / Docker Compose (Ordner nas)Synology Container Manager, QNAP Container Station, jedes andere NAS, auf dem Docker läuft, sowie Hosts mit Home Assistant Container oder Corenas/compose.yaml und nas/auth-token.exampleNur das Token: Kopieren Sie auth-token.example nach auth-token und ersetzen Sie DUMMY_AUTH_TOKEN durch Ihren AuthToken. Lassen Sie compose.yaml unverändert.
Home Assistant App (Ordner home-assistant)Home Assistant OS und Home Assistant Supervisedhome-assistant/localtonet/config.json, die Definition einer lokalen App (früher Add-on genannt), und home-assistant/repository.jsonNichts in den Dateien. Sie geben das Token in Home Assistant ein, nachdem Sie die App installiert haben. Eine lokale Installation verwendet repository.json nicht.

Die fünfte Datei, README.txt, ist eine kurze Textfassung der Schritte auf dieser Seite.

Beide Vorlagen führen den Localtonet-Client in einem Container ohne Rückfragen aus, wie es die Seite Docker beschreibt. Sie sind für AMD64 (Intel- und AMD-Prozessoren) und ARM64 gemacht. Prüfen Sie vor dem Start, welchen Prozessor Ihr NAS hat; ein NAS mit 32-Bit-ARM kann ihn nicht ausführen.

Was sie nicht sind #

  • Es sind keine Synology-SPK- oder QNAP-QPKG-Pakete. Im Synology Package Center oder im QNAP App Center erscheint nichts.
  • Die Vorlage für Home Assistant ist kein Eintrag im offiziellen Home-Assistant-Store. Sie installieren sie als lokale App.
  • Sie enthalten nicht das Container-Image. Ihr Gerät lädt das Image, das die Vorlagen nennen, docker.io/localtonet/localtonet; das ist das Image der Seite Docker auf Docker Hub.
  • Sie geben dem Container nicht die Berechtigungen, die eine VPN-Schnittstelle benötigt. Die Vorlagen sind für Tunnel gedacht; die VPN-Funktion gehört nicht dazu.

Bevor Sie beginnen #

  • Ein NAS mit Unterstützung für Docker und Docker Compose oder Home Assistant OS / Supervised.
  • Ein AuthToken aus Meine Tokens. Verwenden Sie ein Token, das kein anderes Gerät nutzt: Wenn sich ein zweiter Client mit demselben Token verbindet, wird der erste getrennt.
  • Das ZIP mit den Vorlagen. Der Download steht in der Liste am Ende dieser Seite und auf der Seite Downloads.

Ein NAS mit Docker Compose einrichten #

  1. Das ZIP entpacken und den Ordner nas auf das NAS kopieren #

    Entpacken Sie das Archiv auf Ihrem Computer. Kopieren Sie den Ordner nas in einen freigegebenen Ordner auf dem NAS, den Ihr Container-Manager verwenden kann.

  2. Die Token-Datei erstellen #

    Kopieren Sie im Ordner nas die Datei auth-token.example nach auth-token. Öffnen Sie auth-token und ersetzen Sie DUMMY_AUTH_TOKEN durch Ihren AuthToken, in einer einzigen Zeile und ohne weiteren Inhalt in der Datei.

    Halten Sie die Token-Datei privat. Beschränken Sie sie auf Ihr eigenes Konto auf dem NAS und legen Sie sie nicht in einem freigegebenen oder synchronisierten Ordner ab, den andere Personen lesen können. Das Token erlaubt dem Localtonet-Client, sich als dieses Gerät zu verbinden.

    Die Datei muss existieren, bevor der Container startet. Fehlt sie, legt Docker stattdessen ein Verzeichnis namens auth-token an, und der Container kann daraus kein Token lesen.

  3. compose.yaml unverändert lassen #

    Sie müssen compose.yaml nicht bearbeiten. Die Zeile image: nennt das Localtonet-Image und die Version, für die dieses ZIP erstellt wurde, zum Beispiel docker.io/localtonet/localtonet:8.6.0. Die übrigen Zeilen werden unter Was die Compose-Vorlage bewirkt erklärt.

  4. Das Projekt starten #

    Importieren Sie compose.yaml als Projekt in Ihrem Container-Manager und starten Sie es:

    • Synology: Erstellen Sie im Container Manager ein Projekt aus dem Ordner nas und seiner Datei compose.yaml.
    • QNAP: Erstellen Sie in der Container Station eine Anwendung aus compose.yaml. Die Datei bindet ./auth-token relativ zur Compose-Datei ein, die Token-Datei muss also unter diesem Pfad erreichbar sein.
    • Jeder Docker-Host mit Shell: Führen Sie den folgenden Befehl im Verzeichnis nas aus.
    Bash
    docker compose up -d

    Die genauen Bildschirme unterscheiden sich je nach NAS-Modell und Version. Folgen Sie der Dokumentation Ihres Herstellers zum Erstellen eines Projekts aus einer Compose-Datei.

  5. Einen Tunnel erstellen und starten #

    Wenn der Container läuft, öffnen Sie das Dashboard, erstellen Sie einen Tunnel mit dem Token, das Sie in die Datei eingetragen haben, und wählen Sie Starten, wie in der Schnellstart-Anleitung.

Was die Compose-Vorlage bewirkt #

Das ist die vollständige Datei. Das Tag am Ende der Zeile image: ist die Localtonet-Version, für die Ihr ZIP erstellt wurde; 8.6.0 ist ein Beispiel.

nas/compose.yaml
services:
  localtonet:
    image: "docker.io/localtonet/localtonet:8.6.0"
    restart: unless-stopped
    network_mode: host
    environment:
      LOCALTONET_HEADLESS: "1"
      LOCALTONET_AUTH_TOKEN_FILE: /run/secrets/localtonet_auth_token
    volumes:
      - ./auth-token:/run/secrets/localtonet_auth_token:ro
EinstellungFunktion
imageDas Localtonet-Image docker.io/localtonet/localtonet und die auszuführende Version. Ändern Sie das Tag nur, wenn Sie auf eine andere Version wechseln, siehe Protokolle und Updates.
restart: unless-stoppedDocker startet den Container nach einem Neustart oder einem Absturz erneut, es sei denn, Sie haben ihn selbst gestoppt.
network_mode: hostDer Container teilt sich das Netzwerk des NAS. Ein Tunnel kann dann Dienste auf dem NAS selbst unter 127.0.0.1 und andere Geräte in Ihrem LAN unter deren LAN-Adressen erreichen. Dafür ist das Host-Networking von Linux nötig.
LOCALTONET_HEADLESSFührt den Client ohne Rückfragen und mit einfachen Protokollzeilen aus.
LOCALTONET_AUTH_TOKEN_FILEDer Pfad innerhalb des Containers zu der Datei, aus der der Client das Token liest.
volumesBindet Ihre Datei auth-token unter diesem Pfad schreibgeschützt ein.

Home Assistant OS oder Supervised einrichten #

Home Assistant OS und Supervised führen Apps über den Supervisor aus. Die Vorlage ist eine lokale App, die Sie auf das Gerät kopieren.

  1. Den App-Ordner kopieren #

    Entpacken Sie das ZIP. Kopieren Sie den Ordner home-assistant/localtonet in das Verzeichnis für lokale Apps Ihres Home Assistant, sodass daraus /addons/localtonet wird. Der Ordner enthält eine Datei, config.json. Bearbeiten Sie sie nicht: Sie nennt die App Localtonet, das Image docker.io/localtonet/localtonet und die Version, für die dieses ZIP erstellt wurde, und lässt die Option authtoken leer, damit Sie sie später ausfüllen.

  2. Den App-Store neu laden und Localtonet installieren #

    Laden Sie den App-Store in Home Assistant neu, damit er die lokale App findet, und installieren Sie dann Localtonet.

  3. Ihr Token eingeben und die App starten #

    Öffnen Sie die Seite Configuration der App, geben Sie Ihren AuthToken in der Option authtoken ein und starten Sie die App. Home Assistant blendet den Wert wie ein Passwort aus. Die App startet danach automatisch zusammen mit Home Assistant.

  4. Einen Tunnel erstellen und starten #

    Erstellen Sie im Dashboard einen Tunnel mit diesem Token und wählen Sie Starten. Um Home Assistant selbst zu veröffentlichen, erstellen Sie einen HTTP-Tunnel zu 127.0.0.1 und dem Port, auf dem Ihr Home Assistant lauscht. Der Standardport von Home Assistant ist 8123. Home Assistant hat eigene Einstellungen für Anfragen, die über einen Proxy eintreffen; wenn es sie ablehnt, lesen Sie die HTTP-Dokumentation von Home Assistant.

Die App verwendet Host-Networking und erreicht daher Home Assistant und die anderen Geräte in Ihrem Netzwerk direkt. Sie unterstützt die Architekturen von Home Assistant amd64 und aarch64.

Home Assistant Container und Core haben keinen Supervisor und können daher keine Apps installieren. Verwenden Sie bei diesen Installationen stattdessen die Vorlage für NAS / Docker Compose auf dem Docker-Host.

Die Datei home-assistant/repository.json liegt außerhalb des Ordners, den Sie kopieren, und gehört nicht zu einer lokalen Installation. Sie enthält Platzhalterwerte (DUMMY) für eine Repository-URL und einen Maintainer; ignorieren Sie sie.

Ihre Dienste erreichen #

Beide Vorlagen verwenden Host-Networking. Im Feld Lokale IP-Adresse eines Tunnels gilt:

  • 127.0.0.1 ist das NAS oder der Home-Assistant-Host selbst. Verwenden Sie es für die Weboberfläche des NAS, für Home Assistant oder jeden anderen Dienst auf diesem Gerät, mit dem Port, auf dem der Dienst lauscht.
  • Eine LAN-Adresse wie 192.168.1.20 erreicht ein anderes Gerät in Ihrem Netzwerk.

Ein gestarteter Tunnel ist aus dem Internet erreichbar. Bevor Sie eine NAS-Anmeldeseite oder Home Assistant veröffentlichen, sorgen Sie auf dem Dienst selbst für starke Passwörter und eine Zwei-Faktor-Anmeldung und ziehen Sie die Möglichkeiten auf der Seite Zugriffskontrolle in Betracht.

Protokolle und Updates #

Der Container schreibt einfache Protokollzeilen: seinen Verbindungsstatus, den Namen des Tokens, mit dem er sich angemeldet hat, und eine Zeile, wenn ein Tunnel hinzugefügt, im Status geändert oder entfernt wird. Sie lesen sie in der Protokollansicht Ihres Container-Managers, im Tab Log der App in Home Assistant oder mit:

Bash
docker compose logs -f localtonet

Die Zeile Invalid Localtonet headless configuration. Check the token file or environment settings. bedeutet, dass der Client kein brauchbares Token gefunden hat: Die Token-Datei fehlt oder ist leer, enthält noch DUMMY_AUTH_TOKEN, oder das Token ist nicht 33 Zeichen lang. Authentication failed: AuthToken was rejected. bedeutet, dass das Token wohlgeformt ist, Localtonet es aber nicht akzeptiert.

Jedes Vorlagen-ZIP ist für eine Localtonet-Version gemacht: Die Compose-Datei legt sie im Tag der Zeile image: fest, die App für Home Assistant im Feld version von config.json. Um ein NAS auf eine neuere Version zu bringen, ändern Sie das Tag auf eine Version, die Docker Hub für das Image auflistet (siehe Docker), und führen Sie docker compose up -d erneut aus (oder aktualisieren Sie das Projekt in Ihrem Container-Manager). Ihre Datei auth-token bleibt unverändert.

NAS & Home Assistant

Docker Compose-Vorlagen für Synology Container Manager, QNAP Container Station und andere Docker-fähige NAS-Geräte sowie eine Home Assistant-App-Vorlage für OS / Supervised. AMD64 und ARM64.

Dies sind Einrichtungsvorlagen, keine SPK-/QPKG-Installer und kein offizieller Eintrag im Home Assistant Store. Ein passendes Docker-Image muss in der Registry verfügbar sein. Nutzer von Home Assistant Container / Core können die Compose-Vorlage verwenden.

NAS oder Home Assistant einrichten
  1. Entpacken Sie die ZIP-Datei und lesen Sie README.txt.
  2. Für ein NAS kopieren Sie nas/auth-token.example nach nas/auth-token und tragen Ihr AuthToken ein. Halten Sie diese Datei privat.
  3. Prüfen Sie den Image-Tag in nas/compose.yaml und importieren Sie die Datei dann als Projekt oder führen Sie docker compose up -d im Verzeichnis nas aus.
  4. Für Home Assistant OS / Supervised folgen Sie den Installationsschritten für die lokale App in der README und tragen den Token in der App-Konfiguration ein.

Die Vorlagen nutzen Linux-Host-Networking für den LAN-Zugriff. Sie aktivieren keine VPN-Berechtigungen.

Brauchen Sie Hilfe zu dieser Seite? Fragen Sie die Community oder eröffnen Sie ein Support-Ticket.

Support