Naar de inhoud
Localtonet Localtonet Dashboard

Localtonet uitvoeren op een NAS of Home Assistant

Installatiesjablonen AMD64 en ARM64

Hulp bij deze pagina
Op deze pagina 7 secties
  1. Wat de sjablonen zijn
  2. Wat ze niet zijn
  3. Voordat je begint
  4. Een NAS instellen met Docker Compose
  5. Pak de ZIP uit en kopieer de map nas naar de NAS
  6. Maak het tokenbestand
  7. Laat compose.yaml zoals het is
  8. Start het project
  9. Maak een tunnel en start hem
  10. Wat het Compose-sjabloon doet
  11. Home Assistant OS of Supervised instellen
  12. Kopieer de appmap
  13. Laad de appstore opnieuw en installeer Localtonet
  14. Voer je token in en start de app
  15. Maak een tunnel en start hem
  16. Bereik je services
  17. Logboeken en updates
  18. Gerelateerde pagina's

Localtonet biedt implementatiesjablonen waarmee je de Localtonet-client als container uitvoert op een NAS die Docker ondersteunt en op Home Assistant. Je voegt je AuthToken toe, start de container en beheert daarna je tunnels in het dashboard.

Wat de sjablonen zijn #

De download is een klein ZIP-archief met twee sjablonen, in totaal vijf bestanden:

SjabloonGebruik het opBestandenWat je wijzigt
NAS / Docker Compose (map nas)Synology Container Manager, QNAP Container Station, elke andere NAS die Docker draait, en hosts met Home Assistant Container of Corenas/compose.yaml en nas/auth-token.exampleAlleen het token: kopieer auth-token.example naar auth-token en vervang DUMMY_AUTH_TOKEN door je AuthToken. Laat compose.yaml zoals het is.
Home Assistant-app (map home-assistant)Home Assistant OS en Home Assistant Supervisedhome-assistant/localtonet/config.json, de definitie van een lokale app (voorheen add-on genoemd), en home-assistant/repository.jsonNiets in de bestanden. Je voert het token in Home Assistant in nadat je de app hebt geïnstalleerd. Een lokale installatie gebruikt repository.json niet.

Het vijfde bestand, README.txt, is een korte tekstversie van de stappen op deze pagina.

Beide sjablonen voeren de Localtonet-client uit in een container, zonder prompts, zoals de pagina Docker beschrijft. Ze zijn gemaakt voor AMD64 (Intel- en AMD-processors) en ARM64. Controleer welke processor je NAS heeft voordat je begint; een 32-bits ARM-NAS kan het niet uitvoeren.

Wat ze niet zijn #

  • Het zijn geen Synology SPK- of QNAP QPKG-pakketten. Er verschijnt niets in het Synology Package Center of het QNAP App Center.
  • Het Home Assistant-sjabloon is geen vermelding in de officiële Home Assistant-store. Je installeert het als lokale app.
  • Ze bevatten het containerimage niet. Je apparaat haalt het image op dat de sjablonen noemen, docker.io/localtonet/localtonet, het image van de pagina Docker op Docker Hub.
  • Ze geven de container niet de rechten die een VPN-interface nodig heeft. De sjablonen zijn voor tunnels; de VPN-functie maakt er geen deel van uit.

Voordat je begint #

  • Een NAS met ondersteuning voor Docker en Docker Compose, of Home Assistant OS / Supervised.
  • Een AuthToken uit Mijn tokens. Gebruik een token dat geen ander apparaat gebruikt: wanneer een tweede client met hetzelfde token verbindt, wordt de eerste losgekoppeld.
  • De ZIP met sjablonen. De download staat in de lijst aan het einde van deze pagina en op de pagina Downloads.

Een NAS instellen met Docker Compose #

  1. Pak de ZIP uit en kopieer de map nas naar de NAS #

    Pak het archief uit op je computer. Kopieer de map nas naar een gedeelde map op de NAS die je containerbeheer kan gebruiken.

  2. Maak het tokenbestand #

    Kopieer in de map nas het bestand auth-token.example naar auth-token. Open auth-token en vervang DUMMY_AUTH_TOKEN door je AuthToken, op één regel en zonder iets anders in het bestand.

    Houd het tokenbestand privé. Beperk het tot je eigen account op de NAS en zet het niet in een gedeelde of gesynchroniseerde map die anderen kunnen lezen. Met het token kan de Localtonet-client als dit apparaat verbinding maken.

    Het bestand moet bestaan voordat de container start. Als het ontbreekt, maakt Docker in plaats daarvan een map met de naam auth-token aan, en kan de container daar geen token uit lezen.

  3. Laat compose.yaml zoals het is #

    Je hoeft compose.yaml niet te bewerken. De regel image: noemt het Localtonet-image en de versie waarvoor deze ZIP is gemaakt, bijvoorbeeld docker.io/localtonet/localtonet:8.6.0. De andere regels worden uitgelegd onder Wat het Compose-sjabloon doet.

  4. Start het project #

    Importeer compose.yaml als project in je containerbeheer en start het:

    • Synology: maak in Container Manager een project van de map nas en het bijbehorende compose.yaml.
    • QNAP: maak in Container Station een applicatie van compose.yaml. Het bestand koppelt ./auth-token relatief aan het Compose-bestand, dus het tokenbestand moet op dat pad bereikbaar zijn.
    • Elke Docker-host met een shell: voer de onderstaande opdracht uit vanuit de map nas.
    Bash
    docker compose up -d

    De precieze schermen verschillen per NAS-model en -versie. Volg de documentatie van je leverancier voor het maken van een project uit een Compose-bestand.

  5. Maak een tunnel en start hem #

    Open het dashboard wanneer de container draait, maak een tunnel met het token dat je in het bestand hebt gezet en kies Starten, zoals in de Snelstart.

Wat het Compose-sjabloon doet #

Dit is het hele bestand. De tag aan het eind van de regel image: is de Localtonet-versie waarvoor je ZIP is gemaakt; 8.6.0 is een voorbeeld.

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
InstellingWat het doet
imageHet Localtonet-image, docker.io/localtonet/localtonet, en de versie die moet draaien. Wijzig de tag alleen wanneer je naar een andere versie overstapt, zie Logboeken en updates.
restart: unless-stoppedDocker start de container opnieuw na een herstart of een crash, tenzij je hem zelf hebt gestopt.
network_mode: hostDe container deelt het netwerk van de NAS. Een tunnel kan dan services op de NAS zelf bereiken op 127.0.0.1 en andere apparaten in je LAN op hun LAN-adressen. Hiervoor is Linux-hostnetwerken nodig.
LOCALTONET_HEADLESSVoert de client uit zonder prompts, met eenvoudige logregels.
LOCALTONET_AUTH_TOKEN_FILEHet pad, binnen de container, van het bestand waaruit de client het token leest.
volumesKoppelt je bestand auth-token alleen-lezen op dat pad.

Home Assistant OS of Supervised instellen #

Home Assistant OS en Supervised voeren apps uit via de Supervisor. Het sjabloon is een lokale app die je naar het apparaat kopieert.

  1. Kopieer de appmap #

    Pak de ZIP uit. Kopieer de map home-assistant/localtonet naar de map met lokale apps van je Home Assistant, zodat het /addons/localtonet wordt. De map bevat één bestand, config.json. Bewerk het niet: het noemt de app Localtonet, het image docker.io/localtonet/localtonet en de versie waarvoor deze ZIP is gemaakt, en laat de optie authtoken leeg zodat je die later invult.

  2. Laad de appstore opnieuw en installeer Localtonet #

    Laad de appstore in Home Assistant opnieuw, zodat de lokale app wordt gevonden, en installeer daarna Localtonet.

  3. Voer je token in en start de app #

    Open de pagina Configuration van de app, voer je AuthToken in bij de optie authtoken en start de app. Home Assistant verbergt de waarde zoals een wachtwoord. De app start vanaf dan automatisch met Home Assistant.

  4. Maak een tunnel en start hem #

    Maak in het dashboard een tunnel met dat token en kies Starten. Om Home Assistant zelf te publiceren, maak je een HTTP-tunnel naar 127.0.0.1 en de poort waarop je Home Assistant luistert. De standaardpoort van Home Assistant is 8123. Home Assistant heeft eigen instellingen voor verzoeken die via een proxy binnenkomen; als het ze weigert, zie de HTTP-documentatie van Home Assistant.

De app gebruikt hostnetwerken, dus hij bereikt Home Assistant en de andere apparaten in je netwerk rechtstreeks. Hij ondersteunt de Home Assistant-architecturen amd64 en aarch64.

Home Assistant Container en Core hebben geen Supervisor, dus ze kunnen geen apps installeren. Gebruik op die installaties in plaats daarvan het NAS- / Docker Compose-sjabloon op de Docker-host.

Het bestand home-assistant/repository.json ligt buiten de map die je kopieert en maakt geen deel uit van een lokale installatie. Het bevat plaatshouderwaarden (DUMMY) voor een repository-URL en een beheerder; negeer het.

Bereik je services #

Beide sjablonen gebruiken hostnetwerken. In het veld Lokaal IP-adres van een tunnel:

  • 127.0.0.1 is de NAS of de Home Assistant-host zelf. Gebruik het voor de webinterface van de NAS, Home Assistant of een andere service op dat apparaat, met de poort waarop die service luistert.
  • Een LAN-adres zoals 192.168.1.20 bereikt een ander apparaat in je netwerk.

Een gestarte tunnel is bereikbaar vanaf het internet. Zorg, voordat je een inlogpagina van een NAS of Home Assistant publiceert, voor sterke wachtwoorden en tweestapsverificatie op de service zelf, en bekijk de opties op de pagina Toegangsbeheer.

Logboeken en updates #

De container schrijft eenvoudige logregels: de verbindingsstatus, de naam van het token waarmee hij zich heeft aangemeld, en een regel wanneer een tunnel wordt toegevoegd, van status verandert of wordt verwijderd. Lees ze in de logweergave van je containerbeheer, op het tabblad Log van de app in Home Assistant, of met:

Bash
docker compose logs -f localtonet

De regel Invalid Localtonet headless configuration. Check the token file or environment settings. betekent dat de client geen bruikbaar token heeft gevonden: het tokenbestand ontbreekt of is leeg, bevat nog DUMMY_AUTH_TOKEN, of het token is niet 33 tekens lang. Authentication failed: AuthToken was rejected. betekent dat het token correct is opgebouwd maar dat Localtonet het niet accepteert.

Elke ZIP met sjablonen is gemaakt voor één Localtonet-versie: het Compose-bestand legt die vast in de tag op de regel image:, de Home Assistant-app in het veld version van config.json. Om een NAS naar een nieuwere versie te brengen, wijzig je de tag in een versie die Docker Hub voor het image vermeldt (zie Docker) en voer je docker compose up -d opnieuw uit (of werk je het project bij in je containerbeheer). Je bestand auth-token blijft zoals het is.

NAS & Home Assistant

Docker Compose-sjablonen voor Synology Container Manager, QNAP Container Station en andere NAS-apparaten met Docker-ondersteuning, plus een Home Assistant-appsjabloon voor OS / Supervised. AMD64 en ARM64.

Dit zijn installatiesjablonen, geen SPK/QPKG-installers of een officiële vermelding in de Home Assistant-store. Er moet een passend Docker-image beschikbaar zijn in de registry. Gebruikers van Home Assistant Container / Core kunnen het Compose-sjabloon gebruiken.

Je NAS of Home Assistant instellen
  1. Pak de ZIP uit en lees README.txt.
  2. Kopieer voor een NAS nas/auth-token.example naar nas/auth-token en vul je AuthToken in. Houd dit bestand privé.
  3. Controleer de image-tag in nas/compose.yaml en importeer het dan als project of voer docker compose up -d uit in de map nas.
  4. Volg voor Home Assistant OS / Supervised de installatie-instructies voor de lokale app in de README en vul de token in bij de appconfiguratie.

De sjablonen gebruiken Linux-hostnetwerken voor LAN-toegang. Ze schakelen geen VPN-rechten in.

Support