Langsung ke konten
Localtonet Localtonet Dasbor

Referensi baris perintah

Bantuan untuk halaman ini
Di halaman ini 14 bagian
  1. Sebelum memulai
  2. Sintaks
  3. Ringkasan singkat
  4. Autentikasi
  5. --authtoken
  6. --ephemeral-token
  7. Manajemen layanan
  8. Mode headless
  9. --headless
  10. --authtoken-file
  11. --check-config
  12. Log headless
  13. Pemilihan jaringan
  14. --network
  15. --net dan --ip
  16. Proxy keluar
  17. --proxy
  18. --proxy-user
  19. Variabel lingkungan proxy
  20. --http-transport
  21. Terminal Perangkat
  22. --terminal
  23. --terminal-user
  24. --pairing-key
  25. localtonet ssh
  26. Diagnostik dan informasi
  27. --debug
  28. --version
  29. --help
  30. Variabel lingkungan
  31. Kode keluar
  32. Contoh
  33. Halaman terkait

Setiap opsi klien konsol localtonet: masuk dengan token, menjalankan sebagai layanan, menjalankan tanpa prompt, memilih jaringan atau proxy keluar, dan perintah Terminal Perangkat.

Sebelum memulai #

Halaman ini membahas klien konsol untuk Windows, macOS, dan Linux, termasuk klien di dalam image Docker dan paket Linux. Instal dari ringkasan instalasi. Tunnel tidak dibuat di baris perintah: Anda membuat, memulai, dan menghentikannya di dasbor, dengan API atau dengan server MCP. Klien menghubungkan perangkat ke akun Anda dan membawa lalu lintasnya.

Sintaks #

Bash
localtonet [options]
localtonet ssh <DEVICE> [--key <KEY>] [--stdio] [-- <COMMAND>]
  • Opsi dapat diberikan dalam urutan apa pun. Nama opsi tidak peka huruf besar/kecil, kecuali opsi localtonet ssh.
  • Nilai mengikuti opsinya setelah spasi atau tanda sama dengan: --authtoken <YOUR_TOKEN> dan --authtoken=<YOUR_TOKEN> sama saja.
  • Opsi yang membutuhkan nilai akan gagal dengan <option> requires a value. jika nilainya tidak ada.
  • --proxy, --proxy-user, dan --http-transport hanya boleh diberikan satu kali.
  • Placeholder seperti <YOUR_TOKEN> mewakili nilai milik Anda sendiri. Ketikkan tanpa tanda kurung siku.

Tanpa opsi, klien dimulai secara interaktif: klien memakai token yang tersimpan atau memintanya, terhubung, lalu menampilkan tabel status langsung.

Bash
localtonet

Ringkasan singkat #

OpsiFungsi
--authtoken <TOKEN>Masuk dengan AuthToken.
--ephemeral-tokenJangan simpan token di perangkat ini.
--install-service, --start-service, --stop-service, --status-service, --remove-serviceKelola layanan latar belakang.
--headlessJalankan tanpa prompt dan dengan baris log polos.
--authtoken-file <PATH>Baca token dari file (mode headless).
--check-configPeriksa sumber token lalu keluar (mode headless).
--networkTampilkan daftar antarmuka jaringan perangkat.
--net <NAME> --ip <ADDRESS>Kirim seluruh lalu lintas klien melalui satu antarmuka jaringan.
--proxy <none|env|URL>, --proxy-user <USER>Terhubung ke Localtonet melalui proxy keluar.
--http-transport <auto|https|raw>Pilih cara koneksi server dibawa melalui proxy.
--terminal <enable|disable|status>, --terminal-user <ACCOUNT>, --pairing-key <KEY>Aktifkan atau nonaktifkan Terminal Perangkat untuk perangkat ini.
ssh <DEVICE>Buka shell atau jalankan perintah di salah satu perangkat Anda.
--debugCetak diagnostik koneksi.
--versionCetak versi.
--help, -hCetak bantuan bawaan.

Autentikasi #

--authtoken #

Bash
localtonet --authtoken <YOUR_TOKEN>

Memasukkan perangkat dengan AuthToken dari Token Saya. Token terdiri dari 33 karakter. Klien menyimpannya di profil pengguna saat ini, sehingga lain kali cukup mengetik localtonet.

  • Tanpa --authtoken dan tanpa token tersimpan, klien menanyakan Please Enter AuthToken or PIN. Anda dapat mengetik token atau PIN enam digit yang ditampilkan dasbor untuk sebuah token.
  • Nilai yang bukan token valid dijawab dengan Wrong Token! dan pertanyaan diajukan lagi.
  • Saat klien berjalan, F12 menghapus token tersimpan lalu keluar. Ctrl + C keluar dan mempertahankannya.
  • Penulisan lama tanpa tanda hubung, authtoken <YOUR_TOKEN>, masih diterima.

Jaga kerahasiaan token Anda. Token memungkinkan klien Localtonet terhubung sebagai perangkat ini. Gunakan satu token per perangkat: klien kedua yang terhubung dengan token yang sama akan memutus klien pertama.

--ephemeral-token #

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

Memakai token hanya untuk satu kali jalan ini. Klien tidak menulis token ke pengaturan tersimpan dan tidak mengubah token yang sudah tersimpan. Gunakan untuk otomatisasi dan sesi sementara.

Manajemen layanan #

Opsi ini mendaftarkan klien ke layanan Windows, launchd di macOS, atau systemd di Linux. Opsi ini membutuhkan hak administrator (sudo di macOS dan Linux), dan masing-masing membutuhkan token, karena layanan dinamai berdasarkan token tersebut. Panduan lengkapnya ada di Jalankan sebagai layanan.

OpsiFungsinyaContoh
--install-serviceMemasang klien sebagai layanan yang dimulai saat boot, lalu menjalankannya. Opsi lain di baris perintah disimpan dalam layanan.localtonet --install-service --authtoken <YOUR_TOKEN>
--start-serviceMemulai layanan yang terpasang.localtonet --start-service --authtoken <YOUR_TOKEN>
--stop-serviceMenghentikan layanan.localtonet --stop-service --authtoken <YOUR_TOKEN>
--status-serviceMenampilkan status layanan, misalnya Running, Stopped, atau NotFound.localtonet --status-service --authtoken <YOUR_TOKEN>
--remove-serviceMenghentikan layanan dan menghapusnya.localtonet --remove-service --authtoken <YOUR_TOKEN>

Opsi layanan tidak dipakai dalam mode headless.

Mode headless #

Mode headless ditujukan untuk kontainer, sistem init, dan skrip. Klien tidak pernah mengajukan pertanyaan, tidak bereaksi terhadap tombol, tidak menyimpan token, dan menulis satu baris log polos untuk setiap perubahan, bukan tabel status. Image Docker serta paket Linux dan OpenWrt menjalankan klien dengan cara ini.

--headless #

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

Menjalankan klien dalam mode headless. Mengatur variabel lingkungan LOCALTONET_HEADLESS=1 memberi efek yang sama. Klien berhenti dengan bersih saat menerima sinyal penghentian.

Token berasal dari salah satu sumber ini:

SumberCatatan
--authtoken-file <PATH>File yang hanya berisi token. Spasi dan jeda baris di sekitarnya diabaikan.
LOCALTONET_AUTH_TOKEN_FILEVariabel lingkungan berisi path file semacam itu. Dipakai bila --authtoken-file tidak diberikan.
--authtoken <TOKEN>Token itu sendiri di baris perintah.
LOCALTONET_AUTH_TOKENVariabel lingkungan berisi token. Dipakai bila --authtoken tidak diberikan.

File token selalu diutamakan daripada token yang diberikan langsung. Jika file token disebutkan tetapi tidak dapat dibaca, klien berhenti; klien tidak beralih ke sumber lain.

Bila tidak ada token yang dapat dipakai, klien mencetak Invalid Localtonet headless configuration. Check the token file or environment settings. dan keluar dengan kode 2. Token yang dapat dipakai terdiri dari 33 karakter dan tidak mengandung spasi.

--authtoken-file #

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

Membaca token dari file, bukan dari baris perintah, agar tidak muncul di daftar proses atau riwayat shell. Lindungi file tersebut, misalnya dengan chmod 600. Opsi ini hanya dibaca dalam mode headless.

--check-config #

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

Memeriksa sumber token lalu keluar tanpa terhubung. Opsi ini mencetak Localtonet headless configuration OK. dan keluar dengan kode 0 bila token berformat benar ditemukan, dan sebaliknya mencetak kesalahan di atas dengan kode 2. Pemeriksaan ini bersifat lokal: tidak memberi tahu apakah Localtonet menerima token tersebut. Selalu gabungkan dengan --headless (atau LOCALTONET_HEADLESS=1); jika berdiri sendiri, opsi ini diabaikan.

Log headless #

BarisArtinya
Localtonet - headless logKlien telah dimulai.
Connection: …Status koneksi berubah.
AuthTokenName: …Nama token yang dipakai perangkat untuk masuk.
OPEN …, ADDED …Tunnel yang sudah ada saat dimulai, atau ditambahkan kemudian.
STATUS …Status sebuah tunnel berubah.
CLOSED …Sebuah tunnel dihapus dari klien ini.
Authentication failed: AuthToken was rejected.Localtonet tidak menerima token.

Setiap baris setelah baris pertama diawali stempel waktu. Token tidak pernah ditulis ke log.

Pemilihan jaringan #

Pada perangkat dengan lebih dari satu koneksi internet, misalnya Ethernet dan modem seluler, Anda dapat memilih koneksi mana yang dipakai klien. Halaman Pemilihan jaringan menjelaskan fitur ini dan pengaturan per tunnel.

--network #

Bash
localtonet --network

Menampilkan setiap antarmuka jaringan yang aktif beserta alamatnya, memeriksa apakah setiap alamat IPv4 menjangkau internet, lalu keluar. Setiap baris sudah ditulis sebagai opsi yang akan Anda berikan:

Keluaran
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
--------------------------------------------------

Alamat IPv6 ditampilkan dengan IPv6, internet check not available.

--net dan --ip #

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

Mengunci seluruh klien ke satu antarmuka jaringan. --net adalah nama antarmuka dan --ip adalah alamat milik antarmuka tersebut, persis seperti yang dicetak --network. Keduanya harus diberikan bersamaan. Nama antarmuka yang mengandung spasi dapat ditulis apa adanya atau dalam tanda kutip.

  • Jika pasangan itu tidak dapat diterapkan, klien menunggu hingga 30 detik agar antarmuka aktif, yang membantu saat klien dimulai ketika boot, lalu berhenti dengan alasannya dan kode keluar 2. Klien tidak melanjutkan di jaringan lain.
  • Jika hanya salah satu dari kedua opsi yang diberikan, klien mencetak --net and --ip must be given together; the default network is used. dan melanjutkan tanpa penguncian.
  • Di Linux, klien menambahkan aturan routing untuk alamat yang dikunci. Itu membutuhkan root, atau sudo tanpa kata sandi untuk perintah ip.
PesanArtinya
Network interface '…' was not found. Run 'localtonet --network' to list the interfaces.Nama setelah --net tidak cocok dengan antarmuka mana pun.
Network interface '…' is Down.Antarmuka ada tetapi tidak aktif.
'…' is not an address of network interface '…'.Alamat setelah --ip bukan milik antarmuka tersebut.
'…' is not an IP address.Nilai setelah --ip bukan alamat IP.

Untuk memakai koneksi berbeda bagi satu tunnel saja, bukan seluruh klien, atur pasangan yang sama pada pengaturan Argumen tunnel tersebut.

Proxy keluar #

Gunakan opsi ini bila perangkat hanya boleh menjangkau internet melalui proxy. Opsi ini berlaku untuk koneksi klien sendiri ke Localtonet. Opsi ini tidak mengubah cara klien menjangkau layanan lokal Anda.

--proxy #

NilaiFungsinya
Tidak diberikan, atau noneTerhubung langsung. Variabel lingkungan proxy diabaikan.
envMemakai variabel lingkungan proxy yang dijelaskan di bawah. Jika tidak ada yang diatur, atau ada yang tidak valid, klien berhenti dengan kesalahan alih-alih terhubung langsung.
URL proxyMemakai proxy tersebut untuk semuanya. Skema yang didukung: http://, https://, socks5://, dan 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
SkemaPerilakuPort defaultAutentikasi
http://Proxy HTTP, memakai CONNECT.80Tidak ada atau Basic
https://Membuka koneksi TLS terverifikasi ke proxy terlebih dahulu, lalu memakai CONNECT.443Tidak ada atau Basic
socks5://SOCKS5, TCP dan UDP. Nama host diselesaikan di perangkat Anda.1080Tidak ada, atau nama pengguna dan kata sandi
socks5h://SOCKS5, TCP dan UDP. Nama host diselesaikan oleh proxy.1080Tidak ada, atau nama pengguna dan kata sandi

Host proxy dapat berupa alamat IPv4, nama host, atau alamat IPv6 dalam tanda kurung siku. Kredensial dapat menjadi bagian dari URL sebagai user:password@host:port; lakukan URL-encode pada karakter khusus di dalamnya. Keluaran debug tidak pernah menyertakan kredensial.

--proxy-user #

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

Mengatur nama pengguna proxy dan meminta kata sandi dengan prompt tersembunyi (Proxy password:), sehingga kata sandi tidak ada di baris perintah. Kata sandi tidak disimpan.

  • Opsi ini membutuhkan --proxy env atau URL proxy, dan tidak dapat digabungkan dengan kredensial di dalam URL.
  • Opsi ini hanya berfungsi di terminal interaktif. Mode headless dan layanan tidak pernah memunculkan prompt: letakkan kredensial di URL proxy, atau gunakan --proxy env dengan URL proxy yang memuatnya.
  • --install-service menolak --proxy-user dan URL proxy yang berisi kata sandi, karena layanan tidak dapat menyimpannya. Pasang layanan dengan --proxy env dan sediakan variabelnya di lingkungan layanan.

Variabel lingkungan proxy #

Variabel ini hanya dibaca dengan --proxy env. Untuk setiap jenis koneksi, variabel pertama yang diatur yang dipakai:

KoneksiVariabel, berurutan
HTTP dan WebSockethttp_proxy, HTTP_PROXY, all_proxy, ALL_PROXY
HTTPS dan WebSocket amanhttps_proxy, HTTPS_PROXY, all_proxy, ALL_PROXY
TCP dan UDP mentahall_proxy, ALL_PROXY, https_proxy, HTTPS_PROXY, http_proxy, HTTP_PROXY

no_proxy (atau NO_PROXY, jika yang huruf kecil tidak diatur) mendaftar host yang dijangkau secara langsung:

  • Entri dipisahkan dengan koma. Sebuah host atau domain cocok dengan dirinya sendiri dan subdomainnya. Pencocokan mengabaikan huruf besar/kecil dan titik di awal.
  • Alamat IP cocok persis; alamat IPv6 boleh dalam tanda kurung siku. * melewati proxy untuk setiap host.
  • Rentang alamat (CIDR), entri dengan port, dan wildcard parsial tidak didukung dan dilaporkan sebagai kesalahan konfigurasi.
  • no_proxy tidak berpengaruh bila Anda memberikan URL proxy atau terhubung langsung.

--http-transport #

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

Mengatur cara klien membawa koneksi servernya saat proxy hanya meneruskan lalu lintas web biasa. Dengan transport HTTPS, klien mengirim lalu lintas itu sebagai permintaan HTTPS biasa ke gateway Localtonet, alih-alih membuka koneksi mentah berumur panjang melalui proxy.

NilaiFungsinya
auto (default)Di balik proxy HTTP atau HTTPS, klien memilih transport HTTPS bila server menawarkannya, dan jika tidak memakai CONNECT. Di balik proxy SOCKS5, klien memakai TCP dan UDP native terlebih dahulu dan dapat beralih ke transport HTTPS melalui proxy yang sama.
httpsMewajibkan transport HTTPS untuk koneksi server.
rawTidak pernah memakai transport HTTPS: hanya CONNECT atau SOCKS.

Nilai lain apa pun menghentikan klien dengan LOCALTONET_HTTP_TRANSPORT_MODE must be auto, https or raw.

Terminal Perangkat #

Terminal Perangkat memberi Anda shell di perangkat Anda sendiri dari dasbor atau lewat SSH. Fitur ini berjalan di Windows, Linux, dan macOS serta membutuhkan Localtonet Desktop v8.6 atau lebih baru. Halaman Terminal Perangkat menjelaskan fitur ini; berikut bagian baris perintahnya.

--terminal #

Bash
localtonet --terminal enable --authtoken <YOUR_TOKEN>
localtonet --terminal status --authtoken <YOUR_TOKEN>
localtonet --terminal disable --authtoken <YOUR_TOKEN>
NilaiFungsinya
enableMemasangkan perangkat ini dengan akun Anda. Perintah mencetak kode persetujuan lalu menunggu; buka Perangkat Saya, pilih Tambah perangkat, dan masukkan kodenya. Kode berlaku selama 15 menit. Setelah disetujui, perintah mencetak Terminal enabled. Shells will run as <account>.
disableMematikan terminal di perangkat ini dan menghapus perangkat dari akun Anda. Jika dasbor tidak dapat dijangkau, terminal tetap dimatikan secara lokal dan perintah meminta Anda menghapus perangkat di dasbor juga.
statusMenampilkan apakah terminal aktif dan akun mana yang dipakai shell.

Ketiga bentuk membutuhkan token, seperti start biasa: berikan --authtoken, atau hilangkan untuk memakai token tersimpan. Jika Localtonet berjalan sebagai layanan di perangkat, jalankan perintah dari terminal Administrator atau dengan sudo. Di terminal interaktif, klien terus berjalan sebagai klien biasa setelah enable, kecuali Localtonet sudah berjalan di perangkat dengan token ini.

--terminal-user #

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

Memilih akun tempat shell berjalan, ketika Anda mengaktifkan terminal sebagai root atau administrator. Tanpa opsi ini, enable dengan hak tinggi menanyakan Run shells as user:; dalam skrip, tempat tidak ada yang dapat ditanyakan, perintah berhenti dengan Choose the account for shells with --terminal-user. Tanpa --terminal-user, perintah tanpa hak tinggi memakai pengguna saat ini.

--pairing-key #

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

Memasangkan perangkat yang kode persetujuannya tidak dapat dibaca siapa pun, misalnya server yang Anda siapkan dengan skrip. Buat kunci di Perangkat Saya di bawah Tambah perangkat dengan Buat kunci sekali pakai. Kunci berlaku selama satu jam dan hanya dapat dipakai sekali. Dengan kunci pemasangan, perintah tidak mencetak kode dan tidak menunggu persetujuan.

localtonet ssh #

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

Membuka shell di salah satu perangkat Anda, atau menjalankan satu perintah di sana dan mengembalikan kode keluarnya. <DEVICE> adalah nama perangkat yang ditampilkan di Perangkat Saya. ssh harus menjadi kata pertama setelah localtonet.

BagianFungsinya
-- <COMMAND>Menjalankan perintah alih-alih membuka shell. Semua setelah -- adalah perintahnya.
--key <ACCESS_KEY>Kunci akses perangkat, dibuat di bawah Kunci di Perangkat Saya. Dengan kunci, tidak diperlukan persetujuan di browser.
--stdioTidak membuka shell. Hanya membawa koneksi mentah ke perangkat melalui input dan output standar, untuk dipakai sebagai ProxyCommand klien SSH.

Tanpa kunci, perintah mencetak Approve this connection in your browser: diikuti tautan, dan menunggu hingga lima menit agar Anda menyetujuinya. Jika koneksi tidak disetujui, perintah berakhir dengan The connection was not approved.

Diagnostik dan informasi #

--debug #

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

Mengaktifkan diagnostik koneksi pada standard error: rute proxy yang dipakai dan dari pengaturan mana asalnya, mode DNS, hasil handshake, dan status UDP. Kredensial dan isi permintaan tidak disertakan. --debug juga mengalihkan klien ke mode headless, sehingga tidak memunculkan prompt. Ini adalah flag dan tidak menerima nilai.

--version #

Bash
localtonet --version

Mencetak versi klien, misalnya v8.6, lalu keluar.

--help #

Bash
localtonet --help

Mencetak bantuan bawaan lalu keluar. -h melakukan hal yang sama.

Variabel lingkungan #

VariabelEfek
LOCALTONET_HEADLESS1 mengaktifkan mode headless.
LOCALTONET_AUTH_TOKENToken, dalam mode headless.
LOCALTONET_AUTH_TOKEN_FILEPath file token, dalam mode headless.
http_proxy, https_proxy, all_proxy, no_proxy, dan bentuk huruf besarnyaPengaturan proxy, hanya dengan --proxy env.

Kode keluar #

KodeArtinya
0Perintah selesai dengan normal.
1Perintah Terminal Perangkat gagal, misalnya kode persetujuan kedaluwarsa atau perangkat tidak dapat dijangkau.
2Opsi salah atau nilainya tidak ada, token headless tidak dapat dipakai, atau pasangan --net dan --ip tidak dapat diterapkan.

localtonet ssh <DEVICE> -- <COMMAND> mengembalikan kode keluar perintah jarak jauh.

Contoh #

Start pertama di desktop
localtonet --authtoken <YOUR_TOKEN>
Layanan latar belakang di Linux
sudo localtonet --install-service --authtoken <YOUR_TOKEN>
sudo localtonet --status-service --authtoken <YOUR_TOKEN>
Docker, token dari lingkungan
docker run -d --restart unless-stopped -e LOCALTONET_AUTH_TOKEN=<YOUR_TOKEN> localtonet/localtonet
Pakai modem seluler untuk semuanya
localtonet --network
localtonet --authtoken <YOUR_TOKEN> --net Mobile --ip 10.20.30.40
Di balik proxy perusahaan
export all_proxy=http://proxy.example.com:3128
localtonet --authtoken <YOUR_TOKEN> --proxy env
Dukungan