Vai al contenuto
Localtonet Localtonet Dashboard

Esegui Localtonet su un NAS o su Home Assistant

Template di configurazione AMD64 e ARM64

Aiuto su questa pagina
In questa pagina 7 sezioni
  1. Cosa sono i template
  2. Cosa non sono
  3. Prima di iniziare
  4. Configura un NAS con Docker Compose
  5. Estrai lo ZIP e copia la cartella nas sul NAS
  6. Crea il file del token
  7. Lascia compose.yaml com'è
  8. Avvia il progetto
  9. Crea e avvia un tunnel
  10. Cosa fa il template Compose
  11. Configura Home Assistant OS o Supervised
  12. Copia la cartella dell'app
  13. Ricarica lo store delle app e installa Localtonet
  14. Inserisci il tuo token e avvia l'app
  15. Crea e avvia un tunnel
  16. Raggiungi i tuoi servizi
  17. Log e aggiornamenti
  18. Pagine correlate

Localtonet offre template di distribuzione che eseguono il client Localtonet come container su un NAS compatibile con Docker e su Home Assistant. Aggiungi il tuo AuthToken, avvii il container e poi gestisci i tunnel nella dashboard.

Cosa sono i template #

Il download è un piccolo archivio ZIP con due template, cinque file in tutto:

TemplateDa usare suFileCosa modifichi
NAS / Docker Compose (cartella nas)Synology Container Manager, QNAP Container Station, qualsiasi altro NAS che esegue Docker e gli host Home Assistant Container o Corenas/compose.yaml e nas/auth-token.exampleSolo il token: copia auth-token.example in auth-token e sostituisci DUMMY_AUTH_TOKEN con il tuo AuthToken. Lascia compose.yaml così com'è.
App di Home Assistant (cartella home-assistant)Home Assistant OS e Home Assistant Supervisedhome-assistant/localtonet/config.json, la definizione di un'app locale (chiamata un tempo add-on), e home-assistant/repository.jsonNiente nei file. Inserisci il token in Home Assistant dopo aver installato l'app. Un'installazione locale non usa repository.json.

Il quinto file, README.txt, è una breve versione testuale dei passaggi di questa pagina.

Entrambi i template eseguono il client Localtonet in un container, senza richieste interattive, come descrive la pagina Docker. Sono pensati per AMD64 (processori Intel e AMD) e ARM64. Controlla quale processore ha il tuo NAS prima di iniziare; un NAS ARM a 32 bit non può eseguirlo.

Cosa non sono #

  • Non sono pacchetti SPK di Synology né QPKG di QNAP. Non compare nulla nel Package Center di Synology né nell'App Center di QNAP.
  • Il template di Home Assistant non è una voce dello store ufficiale di Home Assistant. Lo installi come app locale.
  • Non contengono l'immagine del container. Il tuo dispositivo scarica l'immagine indicata dai template, docker.io/localtonet/localtonet, che è l'immagine della pagina Docker su Docker Hub.
  • Non danno al container i privilegi di cui ha bisogno un'interfaccia VPN. I template servono per i tunnel; la funzione VPN non ne fa parte.

Prima di iniziare #

  • Un NAS con supporto a Docker e Docker Compose, oppure Home Assistant OS / Supervised.
  • Un AuthToken da I miei token. Usa un token che nessun altro dispositivo utilizza: quando un secondo client si connette con lo stesso token, il primo viene disconnesso.
  • Lo ZIP dei template. Il download si trova nell'elenco alla fine di questa pagina e nella pagina Download.

Configura un NAS con Docker Compose #

  1. Estrai lo ZIP e copia la cartella nas sul NAS #

    Estrai l'archivio sul tuo computer. Copia la cartella nas in una cartella condivisa del NAS che il tuo gestore di container può usare.

  2. Crea il file del token #

    Nella cartella nas, copia auth-token.example in auth-token. Apri auth-token e sostituisci DUMMY_AUTH_TOKEN con il tuo AuthToken, su una sola riga e senza nient'altro nel file.

    Tieni privato il file del token. Limitane l'accesso al tuo account sul NAS e non metterlo in una cartella condivisa o sincronizzata che altre persone possano leggere. Il token consente al client Localtonet di connettersi come questo dispositivo.

    Il file deve esistere prima dell'avvio del container. Se manca, Docker crea al suo posto una directory di nome auth-token, e il container non può leggerne un token.

  3. Lascia compose.yaml com'è #

    Non devi modificare compose.yaml. La sua riga image: indica l'immagine Localtonet e la versione per cui è stato creato questo ZIP, per esempio docker.io/localtonet/localtonet:8.6.0. Le altre righe sono spiegate in Cosa fa il template Compose.

  4. Avvia il progetto #

    Importa compose.yaml come progetto nel tuo gestore di container e avvialo:

    • Synology: in Container Manager, crea un progetto dalla cartella nas e dal suo compose.yaml.
    • QNAP: in Container Station, crea un'applicazione da compose.yaml. Il file monta ./auth-token relativamente al file Compose, quindi il file del token deve essere raggiungibile in quel percorso.
    • Qualsiasi host Docker con una shell: esegui il comando qui sotto dalla directory nas.
    Bash
    docker compose up -d

    Le schermate esatte cambiano tra i modelli di NAS e le versioni. Segui la documentazione del tuo produttore per creare un progetto da un file Compose.

  5. Crea e avvia un tunnel #

    Quando il container è in esecuzione, apri la dashboard, crea un tunnel con il token che hai inserito nel file e seleziona Avvia, come nella Guida rapida.

Cosa fa il template Compose #

Questo è l'intero file. Il tag alla fine della riga image: è la versione di Localtonet per cui è stato creato il tuo ZIP; 8.6.0 è un esempio.

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
ImpostazioneCosa fa
imageL'immagine Localtonet, docker.io/localtonet/localtonet, e la versione da eseguire. Cambia il tag solo quando passi a un'altra versione, vedi Log e aggiornamenti.
restart: unless-stoppedDocker riavvia il container dopo un riavvio del sistema o un crash, a meno che tu non lo abbia fermato di persona.
network_mode: hostIl container condivide la rete del NAS. Un tunnel può quindi raggiungere i servizi sul NAS stesso a 127.0.0.1 e gli altri dispositivi della tua LAN ai loro indirizzi LAN. Serve la rete host di Linux.
LOCALTONET_HEADLESSEsegue il client senza richieste interattive, con righe di log semplici.
LOCALTONET_AUTH_TOKEN_FILEIl percorso, dentro il container, del file da cui il client legge il token.
volumesMonta il tuo file auth-token in sola lettura in quel percorso.

Configura Home Assistant OS o Supervised #

Home Assistant OS e Supervised eseguono le app tramite il Supervisor. Il template è un'app locale che copi sul dispositivo.

  1. Copia la cartella dell'app #

    Estrai lo ZIP. Copia la cartella home-assistant/localtonet nella directory delle app locali del tuo Home Assistant, in modo che diventi /addons/localtonet. La cartella contiene un solo file, config.json. Non modificarlo: dà all'app il nome Localtonet, indica l'immagine docker.io/localtonet/localtonet e la versione per cui è stato creato questo ZIP, e lascia vuota l'opzione authtoken perché la compili dopo.

  2. Ricarica lo store delle app e installa Localtonet #

    Ricarica lo store delle app in Home Assistant in modo che trovi l'app locale, poi installa Localtonet.

  3. Inserisci il tuo token e avvia l'app #

    Apri la pagina Configuration dell'app, inserisci il tuo AuthToken nell'opzione authtoken e avvia l'app. Home Assistant nasconde il valore come una password. Da quel momento l'app parte automaticamente con Home Assistant.

  4. Crea e avvia un tunnel #

    Crea un tunnel con quel token nella dashboard e seleziona Avvia. Per pubblicare Home Assistant stesso, crea un tunnel HTTP verso 127.0.0.1 e la porta su cui è in ascolto il tuo Home Assistant. La porta predefinita di Home Assistant è 8123. Home Assistant ha impostazioni proprie per le richieste che arrivano tramite un proxy; se le rifiuta, consulta la documentazione HTTP di Home Assistant.

L'app usa la rete host, quindi raggiunge direttamente Home Assistant e gli altri dispositivi della tua rete. Supporta le architetture di Home Assistant amd64 e aarch64.

Home Assistant Container e Core non hanno un Supervisor, quindi non possono installare app. Su queste installazioni usa invece il template NAS / Docker Compose sull'host Docker.

Il file home-assistant/repository.json si trova fuori dalla cartella che copi e non fa parte di un'installazione locale. Contiene valori segnaposto (DUMMY) per l'URL di un repository e per un maintainer; ignoralo.

Raggiungi i tuoi servizi #

Entrambi i template usano la rete host. Nel campo Indirizzo IP locale di un tunnel:

  • 127.0.0.1 è il NAS o l'host di Home Assistant stesso. Usalo per l'interfaccia web del NAS, per Home Assistant o per qualsiasi altro servizio su quel dispositivo, con la porta su cui il servizio è in ascolto.
  • Un indirizzo LAN come 192.168.1.20 raggiunge un altro dispositivo della tua rete.

Un tunnel avviato è raggiungibile da internet. Prima di pubblicare la pagina di accesso di un NAS o Home Assistant, usa password robuste e l'accesso a due fattori sul servizio stesso e valuta le opzioni della pagina Controllo degli accessi.

Log e aggiornamenti #

Il container scrive semplici righe di log: lo stato della connessione, il nome del token con cui ha effettuato l'accesso e una riga ogni volta che un tunnel viene aggiunto, cambia stato o viene rimosso. Leggile nella vista dei log del tuo gestore di container, nella scheda Log dell'app in Home Assistant, oppure con:

Bash
docker compose logs -f localtonet

La riga Invalid Localtonet headless configuration. Check the token file or environment settings. significa che il client non ha trovato alcun token utilizzabile: il file del token manca o è vuoto, contiene ancora DUMMY_AUTH_TOKEN, oppure il token non è lungo 33 caratteri. Authentication failed: AuthToken was rejected. significa che il token è ben formato ma Localtonet non lo accetta.

Ogni ZIP dei template è creato per una versione di Localtonet: il file Compose la fissa nel tag della riga image:, l'app di Home Assistant nel campo version di config.json. Per portare un NAS a una versione più recente, cambia il tag con una versione che Docker Hub elenca per l'immagine (vedi Docker) ed esegui di nuovo docker compose up -d (oppure aggiorna il progetto nel tuo gestore di container). Il tuo file auth-token resta com'è.

NAS e Home Assistant

Modelli Docker Compose per Synology Container Manager, QNAP Container Station e altri NAS compatibili con Docker, più un modello di app Home Assistant per OS / Supervised. AMD64 e ARM64.

Questi sono modelli di configurazione, non installer SPK / QPKG né un'inserzione ufficiale nello store di Home Assistant. Nel registry deve essere disponibile un'immagine Docker corrispondente. Gli utenti di Home Assistant Container / Core possono usare il modello Compose.

Configura il tuo NAS o Home Assistant
  1. Estrai lo ZIP e leggi README.txt.
  2. Per un NAS, copia nas/auth-token.example in nas/auth-token e inserisci il tuo AuthToken. Mantieni questo file privato.
  3. Verifica il tag dell'immagine in nas/compose.yaml, poi importalo come progetto o esegui docker compose up -d dalla cartella nas.
  4. Per Home Assistant OS / Supervised, segui le istruzioni di installazione dell'app locale nel README e inserisci il token nella configurazione dell'app.

I modelli usano la rete host di Linux per l'accesso alla LAN. Non abilitano i privilegi VPN.

Supporto