Naar de inhoud
Localtonet Localtonet Dashboard

Opdrachtregelreferentie

Hulp bij deze pagina
Op deze pagina 14 secties
  1. Voordat je begint
  2. Syntaxis
  3. Kort overzicht
  4. Authenticatie
  5. --authtoken
  6. --ephemeral-token
  7. Servicebeheer
  8. Headless-modus
  9. --headless
  10. --authtoken-file
  11. --check-config
  12. Het headless-logboek
  13. Netwerkselectie
  14. --network
  15. --net en --ip
  16. Uitgaande proxy
  17. --proxy
  18. --proxy-user
  19. Proxy-omgevingsvariabelen
  20. --http-transport
  21. Apparaatterminal
  22. --terminal
  23. --terminal-user
  24. --pairing-key
  25. localtonet ssh
  26. Diagnostiek en informatie
  27. --debug
  28. --version
  29. --help
  30. Omgevingsvariabelen
  31. Exitcodes
  32. Voorbeelden
  33. Gerelateerde pagina's

Alle opties van de localtonet-consoleclient: aanmelden met een token, uitvoeren als service, uitvoeren zonder prompts, een netwerk of uitgaande proxy kiezen en de opdrachten van de Apparaatterminal.

Voordat je begint #

Deze pagina behandelt de consoleclient voor Windows, macOS en Linux, inclusief de client in de Docker-image en de Linux-pakketten. Installeer hem via het installatieoverzicht. Tunnels maak je niet op de opdrachtregel aan: je maakt, start en stopt ze in het dashboard, met de API of met de MCP-server. De client verbindt een apparaat met je account en verzorgt het verkeer.

Syntaxis #

Bash
localtonet [options]
localtonet ssh <DEVICE> [--key <KEY>] [--stdio] [-- <COMMAND>]
  • Opties kunnen in willekeurige volgorde worden opgegeven. Optienamen zijn niet hoofdlettergevoelig, behalve de opties van localtonet ssh.
  • Een waarde volgt na een spatie of een gelijkteken op de optie: --authtoken <YOUR_TOKEN> en --authtoken=<YOUR_TOKEN> zijn hetzelfde.
  • Een optie die een waarde nodig heeft, mislukt met <option> requires a value. als de waarde ontbreekt.
  • --proxy, --proxy-user en --http-transport mogen maar één keer worden opgegeven.
  • Plaatshouders zoals <YOUR_TOKEN> staan voor je eigen waarden. Typ ze zonder de punthaken.

Zonder opties start de client interactief: hij gebruikt het opgeslagen token of vraagt om een token, maakt verbinding en toont een live statustabel.

Bash
localtonet

Kort overzicht #

OptieDoel
--authtoken <TOKEN>Meld je aan met een AuthToken.
--ephemeral-tokenSla het token niet op dit apparaat op.
--install-service, --start-service, --stop-service, --status-service, --remove-serviceBeheer de achtergrondservice.
--headlessVoer uit zonder prompts en met eenvoudige logregels.
--authtoken-file <PATH>Lees het token uit een bestand (headless-modus).
--check-configControleer de tokenbron en sluit af (headless-modus).
--networkToon de netwerkinterfaces van het apparaat.
--net <NAME> --ip <ADDRESS>Stuur al het verkeer van de client via één netwerkinterface.
--proxy <none|env|URL>, --proxy-user <USER>Verbind met Localtonet via een uitgaande proxy.
--http-transport <auto|https|raw>Kies hoe serververbindingen via een proxy worden verzorgd.
--terminal <enable|disable|status>, --terminal-user <ACCOUNT>, --pairing-key <KEY>Zet de Apparaatterminal voor dit apparaat aan of uit.
ssh <DEVICE>Open een shell of voer een opdracht uit op een van je apparaten.
--debugToon verbindingsdiagnostiek.
--versionToon de versie.
--help, -hToon de ingebouwde help.

Authenticatie #

--authtoken #

Bash
localtonet --authtoken <YOUR_TOKEN>

Meldt het apparaat aan met een AuthToken uit Mijn tokens. Een token is 33 tekens lang. De client slaat het op in het profiel van de huidige gebruiker, dus de volgende keer volstaat een gewone localtonet.

  • Zonder --authtoken en zonder opgeslagen token vraagt de client Please Enter AuthToken or PIN. Je kunt het token typen of een pincode van zes cijfers die het dashboard bij een token toont.
  • Op een waarde die geen geldig token is, antwoordt de client met Wrong Token! en de vraag wordt opnieuw gesteld.
  • Terwijl de client draait, verwijdert F12 het opgeslagen token en sluit de client af. Ctrl + C sluit af en bewaart het token.
  • De oudere schrijfwijze zonder streepjes, authtoken <YOUR_TOKEN>, wordt nog steeds geaccepteerd.

Houd je token privé. Hiermee kan de Localtonet-client als dit apparaat verbinding maken. Gebruik één token per apparaat: een tweede client die met hetzelfde token verbindt, verbreekt de verbinding van de eerste.

--ephemeral-token #

Bash
localtonet --authtoken <YOUR_TOKEN> --ephemeral-token

Gebruikt het token alleen voor deze run. De client schrijft het token niet naar de opgeslagen instellingen en wijzigt een al opgeslagen token niet. Gebruik dit voor automatisering en tijdelijke sessies.

Servicebeheer #

Deze opties registreren de client bij Windows-services, launchd op macOS of systemd op Linux. Ze vereisen beheerdersrechten (sudo op macOS en Linux) en elke optie heeft het token nodig, omdat de service naar het token is vernoemd. De volledige handleiding is Uitvoeren als service.

OptieWat het doetVoorbeeld
--install-serviceInstalleert de client als service die bij het opstarten start, en start hem. De andere opties op de opdrachtregel worden in de service opgeslagen.localtonet --install-service --authtoken <YOUR_TOKEN>
--start-serviceStart de geïnstalleerde service.localtonet --start-service --authtoken <YOUR_TOKEN>
--stop-serviceStopt de service.localtonet --stop-service --authtoken <YOUR_TOKEN>
--status-serviceToont de status van de service, bijvoorbeeld Running, Stopped of NotFound.localtonet --status-service --authtoken <YOUR_TOKEN>
--remove-serviceStopt de service en verwijdert hem.localtonet --remove-service --authtoken <YOUR_TOKEN>

De serviceopties worden niet gebruikt in headless-modus.

Headless-modus #

De headless-modus is bedoeld voor containers, init-systemen en scripts. De client stelt nooit een vraag, reageert niet op toetsen, slaat het token niet op en schrijft per wijziging één eenvoudige logregel in plaats van de statustabel. De Docker-image en de Linux- en OpenWrt-pakketten voeren de client op deze manier uit.

--headless #

Bash
localtonet --headless --authtoken-file /etc/localtonet/auth-token

Start de client in headless-modus. Het instellen van de omgevingsvariabele LOCALTONET_HEADLESS=1 heeft hetzelfde effect. De client stopt netjes wanneer hij een beëindigingssignaal ontvangt.

Het token komt uit een van deze bronnen:

BronOpmerkingen
--authtoken-file <PATH>Een bestand dat alleen het token bevat. Spaties en regeleinden eromheen worden genegeerd.
LOCALTONET_AUTH_TOKEN_FILEOmgevingsvariabele met het pad naar zo'n bestand. Wordt gebruikt als --authtoken-file niet is opgegeven.
--authtoken <TOKEN>Het token zelf op de opdrachtregel.
LOCALTONET_AUTH_TOKENOmgevingsvariabele met het token. Wordt gebruikt als --authtoken niet is opgegeven.

Een tokenbestand wint altijd van een direct opgegeven token. Als een tokenbestand wordt genoemd maar niet kan worden gelezen, stopt de client; hij valt niet terug op een andere bron.

Als er geen bruikbaar token is gevonden, toont de client Invalid Localtonet headless configuration. Check the token file or environment settings. en sluit af met code 2. Een bruikbaar token is 33 tekens lang en bevat geen spaties.

--authtoken-file #

Bash
localtonet --headless --authtoken-file <PATH>

Leest het token uit een bestand in plaats van van de opdrachtregel, zodat het niet in proceslijsten of de shellgeschiedenis verschijnt. Beveilig het bestand, bijvoorbeeld met chmod 600. Deze optie wordt alleen in headless-modus gelezen.

--check-config #

Bash
localtonet --headless --authtoken-file /etc/localtonet/auth-token --check-config

Controleert de tokenbron en sluit af zonder verbinding te maken. Als er een correct opgebouwd token is gevonden, toont het Localtonet headless configuration OK. en sluit het af met code 0; anders toont het de fout hierboven met code 2. De controle is lokaal: ze vertelt je niet of Localtonet het token accepteert. Combineer de optie altijd met --headless (of LOCALTONET_HEADLESS=1); op zichzelf wordt ze genegeerd.

Het headless-logboek #

RegelBetekenis
Localtonet - headless logDe client is gestart.
Connection: …De verbindingsstatus is gewijzigd.
AuthTokenName: …De naam van het token waarmee het apparaat zich heeft aangemeld.
OPEN …, ADDED …Een tunnel die bij de start al bestond of later is toegevoegd.
STATUS …Een tunnel heeft een andere status gekregen.
CLOSED …Een tunnel is van deze client verwijderd.
Authentication failed: AuthToken was rejected.Localtonet heeft het token niet geaccepteerd.

Elke regel na de eerste begint met een tijdstempel. Het token wordt nooit in het logboek geschreven.

Netwerkselectie #

Op een apparaat met meer dan één internetverbinding, bijvoorbeeld Ethernet en een mobiele modem, kun je kiezen welke verbinding de client gebruikt. De pagina Netwerkselectie legt de functie en de instelling per tunnel uit.

--network #

Bash
localtonet --network

Toont alle actieve netwerkinterfaces met hun adressen, controleert of elk IPv4-adres internet bereikt en sluit af. Elke regel is al geschreven als de opties die je zou opgeven:

Uitvoer
NetworkName: Ethernet
--net Ethernet --ip 192.168.1.20   --> Internet available (public IP 203.0.113.10)
--------------------------------------------------
NetworkName: Mobile
--net Mobile --ip 10.20.30.40   --> No internet access
--------------------------------------------------

IPv6-adressen worden getoond met IPv6, internet check not available.

--net en --ip #

Bash
localtonet --authtoken <YOUR_TOKEN> --net Ethernet --ip 192.168.1.20

Koppelt de hele client aan één netwerkinterface. --net is de interfacenaam en --ip is een adres van die interface, precies zoals --network ze toont. Beide moeten samen worden opgegeven. Een interfacenaam met spaties kan zoals hij is of tussen aanhalingstekens worden geschreven.

  • Als het paar niet kan worden toegepast, wacht de client tot 30 seconden tot de interface actief is, wat helpt als hij bij het opstarten start, en stopt dan met de reden en exitcode 2. Hij gaat niet verder op een ander netwerk.
  • Als slechts een van de twee opties is opgegeven, toont de client --net and --ip must be given together; the default network is used. en gaat verder zonder koppeling.
  • Op Linux voegt de client routeringsregels toe voor het vastgezette adres. Daarvoor is root nodig, of sudo zonder wachtwoord voor de opdracht ip.
BerichtBetekenis
Network interface '…' was not found. Run 'localtonet --network' to list the interfaces.De naam na --net komt niet overeen met een interface.
Network interface '…' is Down.De interface bestaat, maar is niet actief.
'…' is not an address of network interface '…'.Het adres na --ip hoort niet bij die interface.
'…' is not an IP address.De waarde na --ip is geen IP-adres.

Als je voor één tunnel een andere verbinding wilt gebruiken in plaats van voor de hele client, stel dan hetzelfde paar in bij de instelling Argumenten van die tunnel.

Uitgaande proxy #

Gebruik deze opties als het apparaat alleen via een proxy internet mag bereiken. Ze gelden voor de eigen verbindingen van de client met Localtonet. Ze veranderen niet hoe de client je lokale service bereikt.

--proxy #

WaardeWat het doet
Niet opgegeven, of noneVerbindt rechtstreeks. Proxy-omgevingsvariabelen worden genegeerd.
envGebruikt de hieronder beschreven proxy-omgevingsvariabelen. Als geen ervan is ingesteld, of een ervan ongeldig is, stopt de client met een fout in plaats van rechtstreeks te verbinden.
Een proxy-URLGebruikt die proxy voor alles. Ondersteunde schema's: http://, https://, socks5:// en socks5h://.
Bash
localtonet --authtoken <YOUR_TOKEN> --proxy http://proxy.example.com:3128
localtonet --authtoken <YOUR_TOKEN> --proxy socks5h://proxy.example.com:1080
localtonet --authtoken <YOUR_TOKEN> --proxy env
SchemaGedragStandaardpoortAuthenticatie
http://HTTP-proxy, met CONNECT.80Geen of Basic
https://Opent eerst een geverifieerde TLS-verbinding met de proxy en gebruikt daarna CONNECT.443Geen of Basic
socks5://SOCKS5, TCP en UDP. Hostnamen worden op je apparaat omgezet.1080Geen, of gebruikersnaam en wachtwoord
socks5h://SOCKS5, TCP en UDP. Hostnamen worden door de proxy omgezet.1080Geen, of gebruikersnaam en wachtwoord

De proxyhost kan een IPv4-adres, een hostnaam of een IPv6-adres tussen vierkante haken zijn. Inloggegevens kunnen deel van de URL zijn als user:password@host:port; codeer speciale tekens daarin als URL. De debuguitvoer bevat nooit inloggegevens.

--proxy-user #

Bash
localtonet --authtoken <YOUR_TOKEN> --proxy socks5h://proxy.example.com:1080 --proxy-user <PROXY_USER>

Stelt de gebruikersnaam voor de proxy in en vraagt het wachtwoord met een verborgen prompt (Proxy password:), zodat het wachtwoord niet op de opdrachtregel staat. Het wachtwoord wordt niet opgeslagen.

  • Hiervoor is --proxy env of een proxy-URL nodig, en de optie kan niet worden gecombineerd met inloggegevens in de URL.
  • Dit werkt alleen in een interactieve terminal. De headless-modus en services vragen nooit iets: zet de inloggegevens in de proxy-URL, of gebruik --proxy env met een proxy-URL die ze bevat.
  • --install-service weigert --proxy-user en proxy-URL's met een wachtwoord, omdat een service die niet kan opslaan. Installeer de service met --proxy env en geef de variabelen op in de omgeving van de service.

Proxy-omgevingsvariabelen #

Deze worden alleen gelezen met --proxy env. Voor elk type verbinding wordt de eerste variabele gebruikt die is ingesteld:

VerbindingVariabelen, op volgorde
HTTP en WebSockethttp_proxy, HTTP_PROXY, all_proxy, ALL_PROXY
HTTPS en beveiligde WebSockethttps_proxy, HTTPS_PROXY, all_proxy, ALL_PROXY
Onbewerkt TCP en UDPall_proxy, ALL_PROXY, https_proxy, HTTPS_PROXY, http_proxy, HTTP_PROXY

no_proxy (of NO_PROXY, als die in kleine letters niet is ingesteld) geeft hosts op die rechtstreeks worden bereikt:

  • Items worden gescheiden door komma's. Een host of domein komt overeen met zichzelf en zijn subdomeinen. Bij het vergelijken worden hoofdletters en een voorafgaande punt genegeerd.
  • IP-adressen komen exact overeen; IPv6-adressen mogen tussen vierkante haken staan. * omzeilt de proxy voor elke host.
  • Adresbereiken (CIDR), items met een poort en gedeeltelijke jokertekens worden niet ondersteund en gemeld als configuratiefout.
  • no_proxy heeft geen effect als je een proxy-URL opgeeft of rechtstreeks verbindt.

--http-transport #

Bash
localtonet --authtoken <YOUR_TOKEN> --proxy http://proxy.example.com:3128 --http-transport https

Bepaalt hoe de client zijn serververbindingen verzorgt wanneer een proxy alleen gewoon webverkeer doorlaat. Met HTTPS-transport stuurt de client dat verkeer als normale HTTPS-verzoeken naar een Localtonet-gateway in plaats van langlevende onbewerkte verbindingen via de proxy te openen.

WaardeWat het doet
auto (standaard)Achter een HTTP- of HTTPS-proxy geeft de client de voorkeur aan HTTPS-transport als de server dat aanbiedt, en gebruikt anders CONNECT. Achter een SOCKS5-proxy gebruikt hij eerst native TCP en UDP en kan hij via dezelfde proxy terugvallen op HTTPS-transport.
httpsVereist HTTPS-transport voor de serververbindingen.
rawGebruikt nooit HTTPS-transport: alleen CONNECT of SOCKS.

Elke andere waarde stopt de client met LOCALTONET_HTTP_TRANSPORT_MODE must be auto, https or raw.

Apparaatterminal #

De Apparaatterminal geeft je vanuit het dashboard of via SSH een shell op je eigen apparaten. Hij draait op Windows, Linux en macOS en vereist Localtonet Desktop v8.6 of nieuwer. De pagina Apparaatterminal beschrijft de functie; dit zijn de onderdelen op de opdrachtregel.

--terminal #

Bash
localtonet --terminal enable --authtoken <YOUR_TOKEN>
localtonet --terminal status --authtoken <YOUR_TOKEN>
localtonet --terminal disable --authtoken <YOUR_TOKEN>
WaardeWat het doet
enableKoppelt dit apparaat aan je account. De opdracht toont een goedkeuringscode en wacht; open Mijn apparaten, kies Apparaat toevoegen en voer de code in. De code is 15 minuten geldig. Na goedkeuring toont de opdracht Terminal enabled. Shells will run as <account>.
disableZet de terminal op dit apparaat uit en verwijdert het apparaat uit je account. Als het dashboard niet bereikbaar is, wordt de terminal lokaal toch uitgezet en vraagt de opdracht je het apparaat ook in het dashboard te verwijderen.
statusToont of de terminal is ingeschakeld en als welk account shells draaien.

Alle drie de vormen hebben een token nodig, zoals een gewone start: geef --authtoken op, of laat het weg om het opgeslagen token te gebruiken. Als Localtonet als service op het apparaat draait, voer de opdracht dan uit vanuit een terminal als beheerder of met sudo. In een interactieve terminal blijft de client na enable als gewone client draaien, tenzij Localtonet al met dit token op het apparaat draait.

--terminal-user #

Bash
sudo localtonet --terminal enable --authtoken <YOUR_TOKEN> --terminal-user <ACCOUNT>

Kiest het account waaronder shells draaien, wanneer je de terminal als root of beheerder inschakelt. Zonder deze optie vraagt een enable met verhoogde rechten Run shells as user:; in een script, waar niets kan worden gevraagd, stopt hij met Choose the account for shells with --terminal-user. Zonder --terminal-user gebruikt een opdracht zonder verhoogde rechten de huidige gebruiker.

--pairing-key #

Bash
localtonet --terminal enable --authtoken <YOUR_TOKEN> --terminal-user <ACCOUNT> --pairing-key <PAIRING_KEY>

Koppelt een apparaat waar niemand een goedkeuringscode kan lezen, bijvoorbeeld een server die je met een script instelt. Maak de sleutel in Mijn apparaten onder Apparaat toevoegen met Eenmalige sleutel maken. Hij is één uur geldig en kan één keer worden gebruikt. Met een koppelsleutel toont de opdracht geen code en wacht hij niet op goedkeuring.

localtonet ssh #

Bash
localtonet ssh <DEVICE>
localtonet ssh <DEVICE> -- uptime
localtonet ssh <DEVICE> --key <ACCESS_KEY> -- uptime

Opent een shell op een van je apparaten, of voert daar één opdracht uit en geeft de exitcode ervan terug. <DEVICE> is de apparaatnaam die in Mijn apparaten staat. ssh moet het eerste woord na localtonet zijn.

OnderdeelWat het doet
-- <COMMAND>Voert de opdracht uit in plaats van een shell te openen. Alles na -- is de opdracht.
--key <ACCESS_KEY>Een toegangssleutel van het apparaat, gemaakt onder Sleutels in Mijn apparaten. Met een sleutel is geen goedkeuring in de browser nodig.
--stdioOpent geen shell. Het voert alleen de onbewerkte verbinding naar het apparaat over standaardinvoer en -uitvoer, voor gebruik als ProxyCommand van een SSH-client.

Zonder sleutel toont de opdracht Approve this connection in your browser: gevolgd door een link, en wacht tot vijf minuten tot je de verbinding goedkeurt. Als de verbinding niet wordt goedgekeurd, eindigt de opdracht met The connection was not approved.

Diagnostiek en informatie #

--debug #

Bash
localtonet --debug --proxy env --authtoken <YOUR_TOKEN>

Schakelt verbindingsdiagnostiek in op standaardfout: de gebruikte proxyroutes en uit welke instelling ze komen, de DNS-modus, handshakeresultaten en de UDP-status. Inloggegevens en verzoekinhoud worden weggelaten. --debug schakelt de client ook over op headless-modus, dus hij stelt geen vragen. Het is een vlag en heeft geen waarde.

--version #

Bash
localtonet --version

Toont de clientversie, bijvoorbeeld v8.6, en sluit af.

--help #

Bash
localtonet --help

Toont de ingebouwde help en sluit af. -h doet hetzelfde.

Omgevingsvariabelen #

VariabeleEffect
LOCALTONET_HEADLESS1 schakelt de headless-modus in.
LOCALTONET_AUTH_TOKENHet token, in headless-modus.
LOCALTONET_AUTH_TOKEN_FILEPad naar een tokenbestand, in headless-modus.
http_proxy, https_proxy, all_proxy, no_proxy en hun vormen in hoofdlettersProxyinstellingen, alleen met --proxy env.

Exitcodes #

CodeBetekenis
0De opdracht is normaal voltooid.
1Een opdracht van de Apparaatterminal is mislukt, bijvoorbeeld doordat de goedkeuringscode is verlopen of het apparaat niet bereikbaar was.
2Een optie is onjuist of mist zijn waarde, het headless-token is onbruikbaar, of het paar --net en --ip kon niet worden toegepast.

localtonet ssh <DEVICE> -- <COMMAND> geeft de exitcode van de opdracht op afstand terug.

Voorbeelden #

Eerste start op een desktop
localtonet --authtoken <YOUR_TOKEN>
Achtergrondservice op Linux
sudo localtonet --install-service --authtoken <YOUR_TOKEN>
sudo localtonet --status-service --authtoken <YOUR_TOKEN>
Docker, token uit de omgeving
docker run -d --restart unless-stopped -e LOCALTONET_AUTH_TOKEN=<YOUR_TOKEN> localtonet/localtonet
Gebruik de mobiele modem voor alles
localtonet --network
localtonet --authtoken <YOUR_TOKEN> --net Mobile --ip 10.20.30.40
Achter een bedrijfsproxy
export all_proxy=http://proxy.example.com:3128
localtonet --authtoken <YOUR_TOKEN> --proxy env
Support