Exécuter Localtonet en tant que service
Sur cette page 8 sections
Installez le client Localtonet comme service d'arrière-plan pour qu'il démarre avec l'appareil, continue de fonctionner après votre déconnexion et ne nécessite aucun terminal ouvert. Une seule commande l'enregistre auprès des services Windows, de launchd sur macOS ou de systemd sur Linux.
Avant de commencer #
- Le client console est installé sur l'appareil : Windows, macOS ou Linux.
- Un AuthToken pour cet appareil provenant de Mes jetons.
- Des droits d'administrateur : un terminal ouvert avec Exécuter en tant qu'administrateur sous Windows,
sudosous macOS et Linux. - Sous Linux, une distribution qui utilise systemd. Termux n'est pas pris en charge ; utilisez-y l'application Android.
Installé depuis un paquet DEB ou RPM, sur OpenWrt ou dans Docker ? Ces cas fournissent leur propre moyen de démarrer au boot. Consultez Paquets DEB et RPM, OpenWrt et Docker au lieu de cette page.
Installer le service #
Exécutez une fois le client avec --install-service et votre jeton. Remplacez <YOUR_TOKEN> par votre AuthToken. Placez toujours --authtoken dans cette commande : le service se connecte avec le jeton avec lequel vous l'installez.
Windows #
Ouvrez l'Invite de commandes ou PowerShell en tant qu'administrateur dans le dossier qui contient localtonet, puis exécutez :
localtonet --install-service --authtoken <YOUR_TOKEN>Le client crée un service Windows à démarrage automatique et le démarre. Le service est visible dans services.msc avec la description Localtonet Service. Si le service échoue, Windows le redémarre après une minute.
macOS
sudo localtonet --install-service --authtoken <YOUR_TOKEN>Le client écrit une tâche launchd dans /Library/LaunchDaemons/<SERVICE_NAME>.plist, la charge et la démarre. La tâche démarre au boot, et launchd la relance si elle se termine avec une erreur.
Linux
sudo localtonet --install-service --authtoken <YOUR_TOKEN>Le client écrit une unité systemd dans /etc/systemd/system/<SERVICE_NAME>.service, l'active et la démarre. L'unité démarre au boot, et systemd la relance cinq secondes après un échec.
Si sudo ne trouve pas localtonet, exécutez-le avec son chemin, par exemple sudo ./localtonet depuis le dossier qui le contient.
En cas de succès, le client affiche le nom du service :
[CLI] Installed service 'Localtonet_AbCdEfGhI'L'installation démarre aussi le service ; aucune commande de démarrage distincte n'est donc nécessaire. Vous pouvez maintenant créer et démarrer des tunnels pour ce jeton dans le tableau de bord.
Le nom du service #
Le service s'appelle Localtonet_ suivi des neuf premiers caractères du jeton, par exemple Localtonet_AbCdEfGhI. Cette page écrit <SERVICE_NAME> pour le désigner. Comme le nom provient du jeton, vous pouvez installer un service par jeton sur le même appareil, et chaque commande de gestion a besoin du même jeton pour trouver son service.
Ce que le service exécute #
Le service démarre le même fichier localtonet au même emplacement, avec les options que vous avez données dans la commande d'installation. Deux conséquences :
- Ne déplacez pas et ne supprimez pas le fichier. La définition du service contient son chemin complet. Sous Linux, si le fichier se trouve dans
/root, l'installateur le copie dans/usr/local/lib/<SERVICE_NAME>/et le service exécute cette copie. - Les autres options sont conservées. Des options telles que
--netet--ipou--proxy envdans la commande d'installation sont stockées dans le service et utilisées à chaque démarrage. Voir la Référence CLI.
Gérer le service #
Utilisez le même jeton avec l'une de ces options. Sous macOS et Linux, faites précéder de sudo. Sous Windows, utilisez un terminal Administrateur pour tout sauf l'état.
| Commande | Fonction | Sortie en cas de succès |
|---|---|---|
localtonet --status-service --authtoken <YOUR_TOKEN> | Affiche l'état du service. | [CLI] Service '<SERVICE_NAME>' status: Running |
localtonet --stop-service --authtoken <YOUR_TOKEN> | Arrête le service. Ses tunnels passent hors ligne. Il redémarre au prochain boot. | [CLI] Stopped service '<SERVICE_NAME>'. |
localtonet --start-service --authtoken <YOUR_TOKEN> | Démarre un service arrêté. | [CLI] Started service '<SERVICE_NAME>'. |
localtonet --remove-service --authtoken <YOUR_TOKEN> | Arrête le service et supprime son enregistrement. Le fichier localtonet lui-même reste. | [CLI] Removed service '<SERVICE_NAME>'. |
L'état est l'une de ces valeurs :
| État | Signification |
|---|---|
Running | Le service est en cours d'exécution. |
Stopped | Le service est installé mais ne s'exécute pas. |
Installing | Le service est en cours de démarrage. |
NotFound | Aucun service n'est installé pour ce jeton. |
Paused | Windows uniquement : le service a été suspendu. |
Error | Le service a échoué, ou son état n'a pas pu être lu. |
Unknown | Le gestionnaire de services a renvoyé un état que le client ne reconnaît pas. |
Vous pouvez aussi utiliser les outils du système d'exploitation avec le nom du service :
Windows #
Ouvrez services.msc et trouvez <SERVICE_NAME>, ou utilisez sc dans un terminal Administrateur :
sc query <SERVICE_NAME>
sc stop <SERVICE_NAME>
sc start <SERVICE_NAME>macOS
sudo launchctl print system/<SERVICE_NAME>Linux
systemctl status <SERVICE_NAME>
sudo systemctl restart <SERVICE_NAME>Où le service est enregistré et où se trouvent ses journaux #
| Système | Enregistrement | Journaux |
|---|---|---|
| Windows | Un service Windows nommé <SERVICE_NAME>, de type de démarrage automatique, exécuté sous le compte LocalSystem. | Le service n'a pas de fenêtre de console et l'installateur ne configure aucun fichier journal. Vérifiez l'état du service, ainsi que l'appareil et ses tunnels dans le tableau de bord. |
| macOS | /Library/LaunchDaemons/<SERVICE_NAME>.plist, une tâche launchd à l'échelle du système. | /var/log/<SERVICE_NAME>.out.log et /var/log/<SERVICE_NAME>.err.log |
| Linux | /etc/systemd/system/<SERVICE_NAME>.service, activée pour multi-user.target. | Le journal systemd : journalctl -u <SERVICE_NAME> -f |
Le service n'affiche pas le tableau des tunnels que le client montre dans un terminal. Pour l'état de votre appareil et de ses tunnels, utilisez le tableau de bord.
Changer le jeton #
Pour changer le jeton d'un appareil, supprimez le service avec l'ancien jeton et installez-le à nouveau avec le nouveau :
sudo localtonet --remove-service --authtoken <OLD_TOKEN>
sudo localtonet --install-service --authtoken <NEW_TOKEN>À savoir #
- Un client par jeton. Tant que le service s'exécute, ne démarrez pas un autre client Localtonet avec le même jeton, sur cet appareil ou sur un autre. Un second client qui se connecte avec un jeton déconnecte le premier.
- Mise à jour du client. Le service continue d'exécuter le fichier désigné par sa définition. Arrêtez le service, remplacez ce fichier par la nouvelle version, puis redémarrez le service.
- Les mots de passe de proxy ne sont pas stockés. La commande d'installation refuse une URL de proxy contenant un mot de passe ainsi que l'option
--proxy-user. Installez avec--proxy envet définissez les variables de proxy dans l'environnement du service. - Terminal d'appareil. Si l'appareil exécute Localtonet en tant que service, lancez
localtonet --terminal enabledepuis un terminal Administrateur ou avecsudo, afin que le service puisse utiliser le résultat. Voir Terminal d'appareil.
Dépannage #
| Message | Cause et solution |
|---|---|
[CLI] Install failed: '…' requires elevated (admin/root) privileges. | La commande a été exécutée sans droits d'administrateur. Ouvrez le terminal en tant qu'administrateur sous Windows, ou utilisez sudo sous macOS et Linux. Sous Windows et Linux, le même message apparaît pour le démarrage, l'arrêt et la suppression. |
[CLI] Install failed: suivi de Service '<SERVICE_NAME>' already exists. (Windows), Systemd unit already exists for … (Linux) ou Plist already exists for … (macOS) | Un service pour ce jeton est déjà installé. Utilisez --start-service pour le démarrer, ou --remove-service d'abord si vous voulez l'installer à nouveau. |
Service installation cannot persist proxy passwords. Use --proxy env and supply credentials in the service's runtime environment. | La commande d'installation contenait --proxy-user ou une URL de proxy avec un mot de passe. Utilisez plutôt --proxy env. |
[CLI] Start failed: … sous Windows juste après l'installation | Le service est déjà en cours d'exécution, car l'installation le démarre. Vérifiez avec --status-service. |
L'état est NotFound | Aucun service n'existe pour le jeton que vous avez transmis. Vérifiez qu'il s'agit du jeton avec lequel vous avez installé le service. |
L'état est Running mais l'appareil est hors ligne dans le tableau de bord | Vérifiez le jeton : copiez-le à nouveau depuis Mes jetons, supprimez le service et installez-le de nouveau. Assurez-vous aussi qu'aucun autre client n'utilise le même jeton. |