Exécuter Localtonet dans Docker
Sur cette page 12 sections
- Avant de commencer
- Étapes
- Télécharger l'image
- Démarrer le conteneur avec votre jeton
- Créer et démarrer un tunnel
- Fonctionnement du conteneur
- Exécuter en arrière-plan et redémarrer automatiquement
- Façons de transmettre le jeton
- Docker Compose
- Accéder à votre service depuis le conteneur
- Lire le journal
- Mise à jour
- Archives d'image pour les hôtes sans accès au registre
- Dépannage
- Pages associées
L'image officielle localtonet/localtonet exécute le client Localtonet dans un conteneur. Transmettez votre AuthToken, puis créez et démarrez des tunnels dans le tableau de bord comme d'habitude.
Avant de commencer #
- Docker sur un hôte 64 bits. L'image est publiée pour
linux/amd64etlinux/arm64, et Docker choisit celle qui correspond à votre hôte. Pour un appareil ARM 32 bits, utilisez plutôt la version Linux. - Un AuthToken obtenu dans Mes jetons. Donnez à chaque conteneur son propre jeton : lorsqu'un second client se connecte avec le même jeton, le premier est déconnecté.
Étapes #
-
Télécharger l'image #
Télécharger d'abord l'image garantit que vous exécutez la version actuelle et non une ancienne image encore présente sur l'hôte.
Bashdocker pull localtonet/localtonetL'image se trouve sur Docker Hub. Outre
latest, Docker Hub liste un tag pour chaque version si vous voulez figer une version précise. -
Démarrer le conteneur avec votre jeton #
Tout ce qui suit le nom de l'image est transmis au client Localtonet. Remplacez
<YOUR_TOKEN>par votre AuthToken.Bashdocker run localtonet/localtonet --authtoken <YOUR_TOKEN>Le conteneur affiche l'état de sa connexion et reste au premier plan. Appuyez sur Ctrl + C pour l'arrêter.
-
Créer et démarrer un tunnel #
Ouvrez le tableau de bord, créez un tunnel avec le jeton que vous avez donné au conteneur, puis sélectionnez Démarrer. Le Démarrage rapide présente le formulaire. Lisez Accéder à votre service depuis le conteneur avant de renseigner Adresse IP locale, car
127.0.0.1a un autre sens à l'intérieur d'un conteneur.
Fonctionnement du conteneur #
L'image lance le client en mode headless (sans interface). Cela change trois choses par rapport au client sur un poste de bureau :
- Il ne pose jamais de question. Si le jeton est absent ou mal formé, le conteneur affiche une erreur et se termine avec le code 2.
- Il écrit des lignes de journal simples au lieu du tableau d'état en direct, y compris lorsque vous le lancez avec
-it. - Il n'enregistre pas le jeton. L'image ne déclare aucun volume ; transmettez donc le jeton à chaque création d'un conteneur : sur la ligne de commande, dans une variable d'environnement ou sous forme de fichier.
Les tunnels ne sont pas configurés dans le conteneur. Vous les créez, les démarrez et les arrêtez dans le tableau de bord, et le conteneur les récupère via sa connexion.
Exécuter en arrière-plan et redémarrer automatiquement #
Utilisez -d pour détacher le conteneur et une politique de redémarrage afin que Docker le relance après un redémarrage de la machine ou un plantage :
docker run -d \
--name localtonet \
--restart unless-stopped \
localtonet/localtonet --authtoken <YOUR_TOKEN>Gérez-le avec les commandes Docker habituelles :
| Commande | Fonction |
|---|---|
docker ps | Liste les conteneurs en cours d'exécution. |
docker logs -f localtonet | Suit le journal du client. |
docker stop localtonet | Arrête le client. Ses tunnels passent hors ligne. |
docker start localtonet | Le redémarre avec le même jeton. |
docker rm -f localtonet | Supprime le conteneur. |
Façons de transmettre le jeton #
Un jeton passé sur la ligne de commande est visible dans docker inspect et dans la liste des processus de l'hôte. L'image lit aussi le jeton depuis l'environnement ou depuis un fichier :
| Source | Utilisation | Remarques |
|---|---|---|
--authtoken <YOUR_TOKEN> | Argument placé après le nom de l'image. | Le plus simple. Prévaut sur LOCALTONET_AUTH_TOKEN. |
LOCALTONET_AUTH_TOKEN | Variable d'environnement qui contient le jeton. | Utilisée lorsqu'aucun argument --authtoken n'est fourni. |
LOCALTONET_AUTH_TOKEN_FILE | Variable d'environnement qui contient le chemin, à l'intérieur du conteneur, d'un fichier ne contenant que le jeton. | Un fichier de jeton prévaut toujours sur un jeton transmis directement. L'argument --authtoken-file <PATH> a le même effet. |
L'image définit elle-même LOCALTONET_HEADLESS=1. Vous n'avez pas besoin de le définir.
Avec un fichier de jeton, gardez le jeton hors de la définition du conteneur et montez-le en lecture seule :
printf '%s' '<YOUR_TOKEN>' > auth-token
chmod 600 auth-token
docker run -d \
--name localtonet \
--restart unless-stopped \
-e LOCALTONET_AUTH_TOKEN_FILE=/run/secrets/localtonet_auth_token \
-v "$(pwd)/auth-token:/run/secrets/localtonet_auth_token:ro" \
localtonet/localtonetCréez le fichier de jeton avant de démarrer le conteneur. Si le fichier n'existe pas, Docker crée un répertoire portant ce nom et le client ne peut pas y lire de jeton.
Pour vérifier une source de jeton sans se connecter, ajoutez --check-config. Le client vérifie que le jeton est présent et bien formé (33 caractères, sans espace), affiche Localtonet headless configuration OK. et se termine. Il ne demande pas au serveur si le jeton est valide.
docker run --rm \
-e LOCALTONET_AUTH_TOKEN_FILE=/run/secrets/localtonet_auth_token \
-v "$(pwd)/auth-token:/run/secrets/localtonet_auth_token:ro" \
localtonet/localtonet --check-configDocker Compose #
La même configuration sous forme de fichier Compose. Placez le jeton dans un fichier nommé auth-token à côté de compose.yaml :
services:
localtonet:
image: localtonet/localtonet
restart: unless-stopped
environment:
LOCALTONET_AUTH_TOKEN_FILE: /run/secrets/localtonet_auth_token
volumes:
- ./auth-token:/run/secrets/localtonet_auth_token:rodocker compose up -d
docker compose logs -f localtonetLorsque le service que vous voulez publier se trouve dans le même projet Compose sur un hôte Linux, publiez son port sur l'hôte et exécutez le conteneur Localtonet avec le réseau de l'hôte. L'adresse locale du tunnel doit être une adresse IP ; un nom de service Compose tel que web ne peut donc pas être utilisé :
services:
web:
image: nginx
ports:
- "8080:80"
localtonet:
image: localtonet/localtonet
restart: unless-stopped
network_mode: host
environment:
LOCALTONET_AUTH_TOKEN_FILE: /run/secrets/localtonet_auth_token
volumes:
- ./auth-token:/run/secrets/localtonet_auth_token:roPour cet exemple, définissez l'adresse locale du tunnel sur 127.0.0.1 et son port local sur 8080.
Pour un NAS ou Home Assistant, des modèles prêts à l'emploi sont disponibles sur la page NAS et Home Assistant.
Accéder à votre service depuis le conteneur #
L'Adresse IP locale et le Port local du tunnel indiquent au client où se trouve votre service. Le client se connecte depuis l'intérieur du conteneur, où 127.0.0.1 désigne le conteneur lui-même et non votre machine. Saisissez une adresse IP : le client ne résout pas les noms Docker tels que host.docker.internal, un nom de service Compose ou un nom de conteneur. Utilisez la valeur qui correspond à l'endroit où le service s'exécute :
| Où le service s'exécute | Adresse locale à saisir | Ce qu'il faut en plus |
|---|---|---|
| Sur l'hôte Docker, Linux | 127.0.0.1 | Démarrez le conteneur avec --network host (Compose : network_mode: host). Le conteneur partage alors le réseau de l'hôte. |
| Sur l'hôte Docker, sans réseau hôte (y compris Docker Desktop sur Windows ou macOS) | L'adresse IP LAN de l'hôte, par exemple 192.168.1.10 | Le service doit écouter sur une adresse que le conteneur peut atteindre, et pas seulement sur 127.0.0.1, et le pare-feu de l'hôte doit autoriser la connexion. |
| Dans un autre conteneur | 127.0.0.1 avec --network host sur Linux, sinon l'adresse IP LAN de l'hôte | Publiez le port de ce conteneur sur l'hôte (-p, Compose : ports) et utilisez le port publié comme port local du tunnel. |
| Sur un autre appareil de votre réseau | L'adresse IP LAN de cet appareil, par exemple 192.168.1.20 | Rien. |
docker run -d \
--name localtonet \
--restart unless-stopped \
--network host \
localtonet/localtonet --authtoken <YOUR_TOKEN>Vous pouvez modifier l'adresse d'un tunnel existant dans ses paramètres, sous Adresse locale. Consultez la référence des paramètres.
Lire le journal #
docker logs -f localtonet affiche une ligne par changement. Chaque ligne après la première commence par un horodatage :
| Ligne | Signification |
|---|---|
Localtonet - headless log | Le client a démarré. |
Connection: … | L'état de la connexion à Localtonet. Une nouvelle ligne apparaît lorsqu'il change. |
AuthTokenName: … | Le nom du jeton avec lequel le conteneur s'est connecté, tel qu'il apparaît dans Mes jetons. |
OPEN …, ADDED … | Un tunnel de ce jeton. OPEN est utilisé pour les tunnels qui existent au démarrage du client, ADDED pour les tunnels qui apparaissent plus tard. |
STATUS … | L'état d'un tunnel a changé. |
CLOSED … | Un tunnel a été retiré de ce client. |
Authentication failed: AuthToken was rejected. | Localtonet n'a pas accepté le jeton. |
Le jeton lui-même n'est jamais écrit dans le journal.
Mise à jour #
Téléchargez de nouveau l'image et recréez le conteneur :
docker pull localtonet/localtonet
docker rm -f localtonet
docker run -d --name localtonet --restart unless-stopped localtonet/localtonet --authtoken <YOUR_TOKEN>Avec Compose, exécutez docker compose pull puis docker compose up -d. Pour toujours partir de l'image la plus récente, ajoutez --pull always à docker run.
Archives d'image pour les hôtes sans accès au registre #
Si l'hôte ne peut pas joindre Docker Hub, téléchargez l'image sous forme d'archive TAR sur une autre machine, copiez-la puis chargez-la :
| Architecture | Archive |
|---|---|
| AMD64 | localtonet-docker-amd64.tar |
| ARM64 | localtonet-docker-arm64.tar |
docker load --input localtonet-docker-amd64.tardocker load affiche ce qu'il a chargé. S'il affiche un ID d'image au lieu d'un nom, donnez un nom à l'image avant de l'exécuter :
docker tag <IMAGE_ID> localtonet/localtonet
docker run -d --name localtonet --restart unless-stopped localtonet/localtonet --authtoken <YOUR_TOKEN>Dépannage #
Le conteneur se termine immédiatement avec « Invalid Localtonet headless configuration »
Le message complet est Invalid Localtonet headless configuration. Check the token file or environment settings. Le client n'a trouvé aucun jeton utilisable : rien n'a été transmis, la valeur ne fait pas 33 caractères, elle contient un espace ou un saut de ligne au milieu, ou le chemin du fichier de jeton n'existe pas dans le conteneur. Si vous montez un fichier de jeton, vérifiez sur l'hôte qu'il s'agit bien d'un fichier et non d'un répertoire. Avec une politique de redémarrage, le conteneur redémarre en boucle tant que vous n'avez pas corrigé le jeton ; lisez donc docker logs localtonet.
Le journal affiche « Authentication failed: AuthToken was rejected. »
Le jeton est bien formé mais Localtonet ne l'accepte pas. Copiez-le de nouveau depuis Mes jetons et recréez le conteneur.
Le tunnel est démarré mais l'adresse publique n'atteint pas mon service
Vérifiez l'adresse locale du tunnel. 127.0.0.1 ne fonctionne qu'avec --network host sur Linux. Sinon, utilisez l'adresse IP LAN de l'hôte. Un nom tel que host.docker.internal ou le nom d'un autre conteneur ne fonctionne pas dans ce champ, comme expliqué dans Accéder à votre service depuis le conteneur.
Le conteneur perd sans cesse sa connexion
Assurez-vous qu'aucun autre client n'utilise le même jeton. Un second client qui se connecte avec le jeton déconnecte le premier. Créez un jeton par conteneur ou par appareil dans Mes jetons.