Naar de inhoud
Localtonet Localtonet Dashboard

Localtonet uitvoeren als service

Hulp bij deze pagina
Op deze pagina 8 secties
  1. Voordat je begint
  2. De service installeren
  3. Windows
  4. De servicenaam
  5. Wat de service uitvoert
  6. De service beheren
  7. Windows
  8. Waar de service is geregistreerd en waar zijn logboeken staan
  9. Het token wijzigen
  10. Goed om te weten
  11. Probleemoplossing
  12. Gerelateerde pagina's

Installeer de Localtonet-client als achtergrondservice, zodat hij met het apparaat start, blijft draaien nadat je je hebt afgemeld en geen geopende terminal nodig heeft. Eén opdracht registreert hem bij Windows-services, launchd op macOS of systemd op Linux.

Voordat je begint #

  • De consoleclient is op het apparaat geïnstalleerd: Windows, macOS of Linux.
  • Een AuthToken voor dit apparaat uit Mijn tokens.
  • Beheerdersrechten: een terminal geopend met Als administrator uitvoeren op Windows, sudo op macOS en Linux.
  • Op Linux een distributie die systemd gebruikt. Termux wordt niet ondersteund; gebruik daar de Android-app.

Geïnstalleerd vanuit een DEB- of RPM-pakket, op OpenWrt of in Docker? Die hebben hun eigen manier om bij het opstarten te starten. Zie DEB- en RPM-pakketten, OpenWrt en Docker in plaats van deze pagina.

De service installeren #

Voer de client één keer uit met --install-service en je token. Vervang <YOUR_TOKEN> door je AuthToken. Zet --authtoken altijd in deze opdracht: de service verbindt met het token waarmee je hem installeert.

Windows #

Open Opdrachtprompt of PowerShell als beheerder in de map die localtonet bevat en voer dit uit:

Opdrachtprompt of PowerShell (beheerder)
localtonet --install-service --authtoken <YOUR_TOKEN>

De client maakt een Windows-service met automatische start en start hem. De service is zichtbaar in services.msc met de beschrijving Localtonet Service. Als de service uitvalt, start Windows hem na een minuut opnieuw.

macOS

Bash
sudo localtonet --install-service --authtoken <YOUR_TOKEN>

De client schrijft een launchd-taak naar /Library/LaunchDaemons/<SERVICE_NAME>.plist, laadt hem en start hem. De taak start bij het opstarten, en launchd start hem opnieuw als hij met een fout stopt.

Linux

Bash
sudo localtonet --install-service --authtoken <YOUR_TOKEN>

De client schrijft een systemd-unit naar /etc/systemd/system/<SERVICE_NAME>.service, schakelt hem in en start hem. De unit start bij het opstarten, en systemd start hem vijf seconden na een storing opnieuw.

Als sudo localtonet niet kan vinden, voer het dan uit met zijn pad, bijvoorbeeld sudo ./localtonet vanuit de map die het bevat.

Bij succes toont de client de naam van de service:

Uitvoer
[CLI] Installed service 'Localtonet_AbCdEfGhI'

Installeren start de service ook, dus een aparte startopdracht is niet nodig. Je kunt nu in het dashboard tunnels voor dit token maken en starten.

De servicenaam #

De service heet Localtonet_ gevolgd door de eerste negen tekens van het token, bijvoorbeeld Localtonet_AbCdEfGhI. Deze pagina schrijft er <SERVICE_NAME> voor. Omdat de naam van het token komt, kun je op hetzelfde apparaat één service per token installeren, en heeft elke beheeropdracht hetzelfde token nodig om zijn service te vinden.

Wat de service uitvoert #

De service start hetzelfde bestand localtonet vanaf dezelfde locatie, met de opties die je bij de installatieopdracht hebt opgegeven. Daaruit volgen twee dingen:

  • Verplaats of verwijder het bestand niet. De servicedefinitie bevat het volledige pad ervan. Als het bestand op Linux in /root staat, kopieert het installatieprogramma het naar /usr/local/lib/<SERVICE_NAME>/ en voert de service die kopie uit.
  • Andere opties blijven bewaard. Opties zoals --net en --ip of --proxy env in de installatieopdracht worden in de service opgeslagen en bij elke start gebruikt. Zie de CLI-referentie.

De service beheren #

Gebruik hetzelfde token met een van deze opties. Zet op macOS en Linux sudo ervoor. Gebruik op Windows voor alles behalve de status een terminal als beheerder.

OpdrachtWat het doetUitvoer bij succes
localtonet --status-service --authtoken <YOUR_TOKEN>Toont de status van de service.[CLI] Service '<SERVICE_NAME>' status: Running
localtonet --stop-service --authtoken <YOUR_TOKEN>Stopt de service. De tunnels gaan offline. Hij start weer bij de volgende keer opstarten.[CLI] Stopped service '<SERVICE_NAME>'.
localtonet --start-service --authtoken <YOUR_TOKEN>Start een gestopte service.[CLI] Started service '<SERVICE_NAME>'.
localtonet --remove-service --authtoken <YOUR_TOKEN>Stopt de service en verwijdert de registratie ervan. Het bestand localtonet zelf blijft staan.[CLI] Removed service '<SERVICE_NAME>'.

De status is een van deze waarden:

StatusBetekenis
RunningDe service draait.
StoppedDe service is geïnstalleerd maar draait niet.
InstallingDe service start.
NotFoundVoor dit token is geen service geïnstalleerd.
PausedAlleen Windows: de service is gepauzeerd.
ErrorDe service is mislukt, of zijn status kon niet worden gelezen.
UnknownDe servicemanager gaf een status terug die de client niet herkent.

Je kunt ook de hulpmiddelen van het besturingssysteem gebruiken met de servicenaam:

Windows #

Open services.msc en zoek <SERVICE_NAME>, of gebruik sc in een terminal als beheerder:

Opdrachtprompt (beheerder)
sc query <SERVICE_NAME>
sc stop <SERVICE_NAME>
sc start <SERVICE_NAME>

macOS

Bash
sudo launchctl print system/<SERVICE_NAME>

Linux

Bash
systemctl status <SERVICE_NAME>
sudo systemctl restart <SERVICE_NAME>

Waar de service is geregistreerd en waar zijn logboeken staan #

SysteemRegistratieLogboeken
WindowsEen Windows-service met de naam <SERVICE_NAME>, starttype automatisch, draaiend onder het account LocalSystem.De service heeft geen consolevenster en het installatieprogramma stelt geen logbestand in. Controleer de status van de service, en het apparaat en zijn tunnels in het dashboard.
macOS/Library/LaunchDaemons/<SERVICE_NAME>.plist, een systeembrede launchd-taak./var/log/<SERVICE_NAME>.out.log en /var/log/<SERVICE_NAME>.err.log
Linux/etc/systemd/system/<SERVICE_NAME>.service, ingeschakeld voor multi-user.target.Het systemd-journal: journalctl -u <SERVICE_NAME> -f

De service toont niet de tunneltabel die de client in een terminal laat zien. Gebruik het dashboard voor de status van je apparaat en zijn tunnels.

Het token wijzigen #

Om het token van een apparaat te wijzigen, verwijder je de service met het oude token en installeer je hem opnieuw met het nieuwe:

Bash
sudo localtonet --remove-service --authtoken <OLD_TOKEN>
sudo localtonet --install-service --authtoken <NEW_TOKEN>

Goed om te weten #

  • Eén client per token. Start, zolang de service draait, geen andere Localtonet-client met hetzelfde token, op dit apparaat of een ander. Een tweede client die met een token verbindt, verbreekt de verbinding van de eerste.
  • De client bijwerken. De service blijft het bestand uitvoeren waarnaar zijn definitie verwijst. Stop de service, vervang dat bestand door de nieuwe versie en start de service opnieuw.
  • Proxywachtwoorden worden niet opgeslagen. De installatieopdracht weigert een proxy-URL met een wachtwoord en de optie --proxy-user. Installeer met --proxy env en stel de proxyvariabelen in in de omgeving van de service.
  • Apparaatterminal. Als het apparaat Localtonet als service draait, voer dan localtonet --terminal enable uit vanuit een terminal als beheerder of met sudo, zodat de service het resultaat kan gebruiken. Zie Apparaatterminal.

Probleemoplossing #

BerichtOorzaak en oplossing
[CLI] Install failed: '…' requires elevated (admin/root) privileges.De opdracht is uitgevoerd zonder beheerdersrechten. Open de terminal als beheerder op Windows, of gebruik sudo op macOS en Linux. Op Windows en Linux verschijnt hetzelfde bericht voor starten, stoppen en verwijderen.
[CLI] Install failed: gevolgd door Service '<SERVICE_NAME>' already exists. (Windows), Systemd unit already exists for … (Linux) of Plist already exists for … (macOS)Er is al een service voor dit token geïnstalleerd. Gebruik --start-service om hem te starten, of eerst --remove-service als je hem opnieuw wilt installeren.
Service installation cannot persist proxy passwords. Use --proxy env and supply credentials in the service's runtime environment.De installatieopdracht bevatte --proxy-user of een proxy-URL met een wachtwoord. Gebruik in plaats daarvan --proxy env.
[CLI] Start failed: … op Windows direct na het installerenDe service draait al, omdat installeren hem start. Controleer met --status-service.
De status is NotFoundEr bestaat geen service voor het token dat je hebt opgegeven. Controleer of het het token is waarmee je de service hebt geïnstalleerd.
De status is Running maar het apparaat is offline in het dashboardControleer het token: kopieer het opnieuw uit Mijn tokens, verwijder de service en installeer hem opnieuw. Zorg er ook voor dat geen andere client hetzelfde token gebruikt.
Support