Skip to content
LabTether

5-Minute Quickstart

Go from zero to a working LabTether hub with metrics flowing.

1. Start LabTether

Download the release installer, review it, and pin the release you intend to run:

curl --proto '=https' --tlsv1.2 -fsSLo install-labtether.sh https://labtether.com/install.sh
less install-labtether.sh
LABTETHER_VERSION=vX.Y.Z bash install-labtether.sh

The installer verifies the coordinated release checksums and deploys immutable image digests. If GitHub CLI (gh) is installed, it also verifies signed provenance for every release input against LabTether's tag-triggered release workflow. Security-sensitive or automated installs can require that proof explicitly:

LABTETHER_VERSION=vX.Y.Z LABTETHER_REQUIRE_ATTESTATION=true bash install-labtether.sh

It starts the hub API, web console, and managed PostgreSQL database; runtime secrets are generated on first boot. When it finishes, it prints a local Docker Compose command for retrieving the one-time owner setup token. The installer does not print the token itself.

Open http://localhost:3000 in your browser.

2. Create your account

On the Docker host, run the setup-token retrieval command printed by the installer. Copy the token directly into the setup wizard, then enter a username and password for the owner account. The token is required for a fresh default install, is accepted only before the first user exists, and should not be shared or saved in shell history.

The second step offers optional Tailscale HTTPS for remote access. You can skip this and configure it later in Settings.

3. Explore the dashboard

After setup, you'll see the dashboard with a First-Run Checklist tracking your progress. The dashboard shows fleet health, topology, activity, and resource hotspots — all of which populate as you add devices.

4. Add your first device

Click + Add Device in the top right. You have two main paths:

Best for Linux hosts you want full control over — terminal, desktop, file management, metrics.

  1. Select Agent in the Add Device modal
  2. Generate a one-time enrollment token and copy the generated install workflow
  3. Run the workflow on the target machine with sudo, then paste the token at its hidden prompt
  4. The workflow passes the token through a private temporary file rather than placing it in the command line, and the device appears in Devices within seconds

Option B: Add a connector

Best for Proxmox, TrueNAS, Docker, or Portainer — no agent install needed.

  1. Select your platform (e.g., Proxmox VE)
  2. Enter the API URL and credentials
  3. Click Test Connection
  4. Save — resources are discovered automatically

5. Verify it works

Once your first device is connected:

  • Dashboard shows it online with CPU, memory, and disk metrics
  • Topology maps its relationships
  • Terminal lets you open a browser-based shell session
  • Alerts fire automatically if built-in rules are triggered

You're running. The First-Run Checklist tracks the remaining milestones — work through them at your own pace.

Next steps