Aller au contenu
Localtonet Localtonet Tableau de bord

Exécuter Localtonet sur un NAS ou Home Assistant

Modèles d'installation AMD64 et ARM64

Aide pour cette page
Sur cette page 7 sections
  1. Ce que sont les modèles
  2. Ce qu'ils ne sont pas
  3. Avant de commencer
  4. Configurer un NAS avec Docker Compose
  5. Extraire le ZIP et copier le dossier nas sur le NAS
  6. Créer le fichier de jeton
  7. Laisser compose.yaml tel quel
  8. Démarrer le projet
  9. Créer et démarrer un tunnel
  10. Ce que fait le modèle Compose
  11. Configurer Home Assistant OS ou Supervised
  12. Copier le dossier de l'application
  13. Recharger le magasin d'applications et installer Localtonet
  14. Saisir votre jeton et démarrer l'application
  15. Créer et démarrer un tunnel
  16. Atteindre vos services
  17. Journaux et mises à jour
  18. Pages associées

Localtonet fournit des modèles de déploiement qui exécutent le client Localtonet dans un conteneur sur un NAS compatible Docker et sur Home Assistant. Vous ajoutez votre AuthToken, démarrez le conteneur, puis gérez les tunnels dans le tableau de bord.

Ce que sont les modèles #

Le téléchargement est une petite archive ZIP contenant deux modèles, cinq fichiers au total :

ModèleÀ utiliser surFichiersCe que vous modifiez
NAS / Docker Compose (dossier nas)Synology Container Manager, QNAP Container Station, tout autre NAS qui exécute Docker, et les hôtes Home Assistant Container ou Corenas/compose.yaml et nas/auth-token.exampleUniquement le jeton : copiez auth-token.example vers auth-token et remplacez DUMMY_AUTH_TOKEN par votre AuthToken. Laissez compose.yaml tel quel.
Application Home Assistant (dossier home-assistant)Home Assistant OS et Home Assistant Supervisedhome-assistant/localtonet/config.json, la définition d'une application locale (appelée auparavant add-on), et home-assistant/repository.jsonRien dans les fichiers. Vous saisissez le jeton dans Home Assistant après avoir installé l'application. Une installation locale n'utilise pas repository.json.

Le cinquième fichier, README.txt, est une version texte courte des étapes de cette page.

Les deux modèles exécutent le client Localtonet dans un conteneur, sans invite, comme le décrit la page Docker. Ils sont conçus pour AMD64 (processeurs Intel et AMD) et ARM64. Vérifiez le processeur de votre NAS avant de commencer ; un NAS ARM 32 bits ne peut pas l'exécuter.

Ce qu'ils ne sont pas #

  • Ce ne sont pas des paquets Synology SPK ni QNAP QPKG. Rien n'apparaît dans le Centre de paquets Synology ni dans l'App Center QNAP.
  • Le modèle Home Assistant n'est pas une entrée du store officiel de Home Assistant. Vous l'installez comme application locale.
  • Ils ne contiennent pas l'image du conteneur. Votre appareil télécharge l'image que nomment les modèles, docker.io/localtonet/localtonet, qui est l'image de la page Docker sur Docker Hub.
  • Ils ne donnent pas au conteneur les privilèges dont a besoin une interface VPN. Les modèles servent aux tunnels ; la fonction VPN n'en fait pas partie.

Avant de commencer #

  • Un NAS compatible Docker et Docker Compose, ou Home Assistant OS / Supervised.
  • Un AuthToken provenant de Mes jetons. Utilisez un jeton qu'aucun autre appareil n'utilise : lorsqu'un second client se connecte avec le même jeton, le premier est déconnecté.
  • Le ZIP des modèles. Le téléchargement se trouve dans la liste à la fin de cette page et sur la page Téléchargements.

Configurer un NAS avec Docker Compose #

  1. Extraire le ZIP et copier le dossier nas sur le NAS #

    Extrayez l'archive sur votre ordinateur. Copiez le dossier nas dans un dossier partagé du NAS que votre gestionnaire de conteneurs peut utiliser.

  2. Créer le fichier de jeton #

    Dans le dossier nas, copiez auth-token.example vers auth-token. Ouvrez auth-token et remplacez DUMMY_AUTH_TOKEN par votre AuthToken, sur une seule ligne et sans rien d'autre dans le fichier.

    Gardez le fichier de jeton privé. Limitez-le à votre propre compte sur le NAS et ne le placez pas dans un dossier partagé ou synchronisé que d'autres personnes peuvent lire. Le jeton permet au client Localtonet de se connecter en tant que cet appareil.

    Le fichier doit exister avant le démarrage du conteneur. S'il est absent, Docker crée à la place un répertoire nommé auth-token, et le conteneur ne peut pas y lire de jeton.

  3. Laisser compose.yaml tel quel #

    Vous n'avez pas besoin de modifier compose.yaml. Sa ligne image: nomme l'image Localtonet et la version pour laquelle ce ZIP a été créé, par exemple docker.io/localtonet/localtonet:8.6.0. Les autres lignes sont expliquées sous Ce que fait le modèle Compose.

  4. Démarrer le projet #

    Importez compose.yaml comme projet dans votre gestionnaire de conteneurs et démarrez-le :

    • Synology : dans Container Manager, créez un projet à partir du dossier nas et de son compose.yaml.
    • QNAP : dans Container Station, créez une application à partir de compose.yaml. Le fichier monte ./auth-token relativement au fichier Compose ; le fichier de jeton doit donc être accessible à ce chemin.
    • Tout hôte Docker avec un shell : exécutez la commande ci-dessous depuis le répertoire nas.
    Bash
    docker compose up -d

    Les écrans exacts diffèrent selon les modèles et les versions de NAS. Suivez la documentation de votre fabricant pour créer un projet à partir d'un fichier Compose.

  5. Créer et démarrer un tunnel #

    Lorsque le conteneur fonctionne, ouvrez le tableau de bord, créez un tunnel avec le jeton que vous avez placé dans le fichier et sélectionnez Démarrer, comme dans le Démarrage rapide.

Ce que fait le modèle Compose #

Voici le fichier complet. Le tag à la fin de la ligne image: est la version de Localtonet pour laquelle votre ZIP a été créé ; 8.6.0 est un exemple.

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
ParamètreFonction
imageL'image Localtonet, docker.io/localtonet/localtonet, et la version à exécuter. Ne changez le tag que lorsque vous passez à une autre version, voir Journaux et mises à jour.
restart: unless-stoppedDocker redémarre le conteneur après un redémarrage de la machine ou un plantage, sauf si vous l'avez arrêté vous-même.
network_mode: hostLe conteneur partage le réseau du NAS. Un tunnel peut alors atteindre les services du NAS lui-même à l'adresse 127.0.0.1 et les autres appareils de votre réseau local à leur adresse locale. Cela nécessite le réseau hôte de Linux.
LOCALTONET_HEADLESSExécute le client sans invite, avec des lignes de journal simples.
LOCALTONET_AUTH_TOKEN_FILELe chemin, à l'intérieur du conteneur, du fichier dans lequel le client lit le jeton.
volumesMonte votre fichier auth-token en lecture seule à ce chemin.

Configurer Home Assistant OS ou Supervised #

Home Assistant OS et Supervised exécutent les applications par l'intermédiaire du Supervisor. Le modèle est une application locale que vous copiez sur l'appareil.

  1. Copier le dossier de l'application #

    Extrayez le ZIP. Copiez le dossier home-assistant/localtonet dans le répertoire des applications locales de votre Home Assistant, de sorte qu'il devienne /addons/localtonet. Le dossier contient un seul fichier, config.json. Ne le modifiez pas : il nomme l'application Localtonet, l'image docker.io/localtonet/localtonet et la version pour laquelle ce ZIP a été créé, et il laisse l'option authtoken vide pour que vous la renseigniez plus tard.

  2. Recharger le magasin d'applications et installer Localtonet #

    Rechargez le magasin d'applications dans Home Assistant pour qu'il trouve l'application locale, puis installez Localtonet.

  3. Saisir votre jeton et démarrer l'application #

    Ouvrez la page Configuration de l'application, saisissez votre AuthToken dans l'option authtoken et démarrez l'application. Home Assistant masque la valeur comme un mot de passe. L'application démarre ensuite automatiquement avec Home Assistant.

  4. Créer et démarrer un tunnel #

    Créez dans le tableau de bord un tunnel avec ce jeton et sélectionnez Démarrer. Pour publier Home Assistant lui-même, créez un tunnel HTTP vers 127.0.0.1 et le port sur lequel écoute votre Home Assistant. Le port par défaut de Home Assistant est 8123. Home Assistant a ses propres paramètres pour les requêtes qui arrivent par un proxy ; s'il les rejette, consultez la documentation HTTP de Home Assistant.

L'application utilise le réseau hôte ; elle atteint donc directement Home Assistant et les autres appareils de votre réseau. Elle prend en charge les architectures Home Assistant amd64 et aarch64.

Home Assistant Container et Core n'ont pas de Supervisor ; ils ne peuvent donc pas installer d'applications. Pour ces installations, utilisez à la place le modèle NAS / Docker Compose sur l'hôte Docker.

Le fichier home-assistant/repository.json se trouve en dehors du dossier que vous copiez et ne fait pas partie d'une installation locale. Il contient des valeurs fictives (DUMMY) pour l'URL d'un dépôt et un mainteneur ; ignorez-le.

Atteindre vos services #

Les deux modèles utilisent le réseau hôte. Dans le champ Adresse IP locale d'un tunnel :

  • 127.0.0.1 désigne le NAS ou l'hôte Home Assistant lui-même. Utilisez-le pour l'interface web du NAS, Home Assistant ou tout autre service de cet appareil, avec le port sur lequel ce service écoute.
  • Une adresse du réseau local comme 192.168.1.20 atteint un autre appareil de votre réseau.

Un tunnel démarré est accessible depuis internet. Avant de publier la page de connexion d'un NAS ou Home Assistant, conservez des mots de passe robustes et l'authentification à deux facteurs sur le service lui-même, et envisagez les options de la page Contrôle d'accès.

Journaux et mises à jour #

Le conteneur écrit des lignes de journal simples : son état de connexion, le nom du jeton avec lequel il s'est connecté, et une ligne chaque fois qu'un tunnel est ajouté, change d'état ou est retiré. Lisez-les dans la vue des journaux de votre gestionnaire de conteneurs, dans l'onglet Log de l'application dans Home Assistant, ou avec :

Bash
docker compose logs -f localtonet

La ligne Invalid Localtonet headless configuration. Check the token file or environment settings. signifie que le client n'a trouvé aucun jeton utilisable : le fichier de jeton est absent ou vide, contient encore DUMMY_AUTH_TOKEN, ou le jeton ne compte pas 33 caractères. Authentication failed: AuthToken was rejected. signifie que le jeton est bien formé mais que Localtonet ne l'accepte pas.

Chaque ZIP de modèles est créé pour une version de Localtonet : le fichier Compose l'épingle dans le tag de la ligne image:, l'application Home Assistant dans le champ version de config.json. Pour faire passer un NAS à une version plus récente, changez le tag pour une version que Docker Hub liste pour l'image (voir Docker) et exécutez de nouveau docker compose up -d (ou mettez à jour le projet dans votre gestionnaire de conteneurs). Votre fichier auth-token reste tel quel.

NAS et Home Assistant

Modèles Docker Compose pour Synology Container Manager, QNAP Container Station et autres NAS compatibles Docker, ainsi qu'un modèle d'application Home Assistant pour OS / Supervised. AMD64 et ARM64.

Il s'agit de modèles d'installation, et non d'installateurs SPK / QPKG ni d'une fiche officielle de la boutique Home Assistant. Une image Docker correspondante doit être disponible dans le registre. Les utilisateurs de Home Assistant Container / Core peuvent utiliser le modèle Compose.

Configurer votre NAS ou Home Assistant
  1. Extrayez le ZIP et lisez README.txt.
  2. Pour un NAS, copiez nas/auth-token.example vers nas/auth-token et saisissez votre AuthToken. Gardez ce fichier privé.
  3. Vérifiez le tag d'image dans nas/compose.yaml, puis importez-le comme projet ou exécutez docker compose up -d depuis le dossier nas.
  4. Pour Home Assistant OS / Supervised, suivez les instructions d'installation de l'application locale dans le README et saisissez le jeton dans la configuration de l'application.

Les modèles utilisent le réseau hôte Linux pour l'accès au LAN. Ils n'activent pas les privilèges VPN.

Support