Self-host Headscale on a VPS

Self-hosted Tailscale control server, configured entirely through environment variables. Embedded DERP and STUN are off (the platform has no UDP), so clients relay through the public Tailscale DERP map over HTTPS. Create users and pre-auth keys with the CLI in the container (headscale users create, headscale preauthkeys create).

levelrail-cli templates deploy headscale --name my-headscale

Specification

Status
Verified on arm64 with image tag v0.29.6
Category
Infrastructure
Services
headscale
Ports
8080
Volumes
1
Memory
about 256 MiB
arm64
tested
amd64
image published
Settings to fill in
none
License
not yet recorded

About Headscale

Self-hosted Tailscale control server, configured entirely through environment variables. Embedded DERP and STUN are off (the platform has no UDP), so clients relay through the public Tailscale DERP map over HTTPS. Create users and pre-auth keys with the CLI in the container (headscale users create, headscale preauthkeys create).

What it deploys

Headscale runs as one service in a single Compose app, listening on port 8080, with 1 named volume mount.

ServiceImageTagPortsVolumes
headscale headscale/headscale v0.29.6 8080 data -> /var/lib/headscale

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Verified. Verified on arm64 with image tag v0.29.6. Verified means our CI ran this exact image version and it answered on its health path. Evidence

Settings and environment

You do not have to fill in anything. Values are never shown here.

ServiceVariableValue
headscaleHEADSCALE_DATABASE_SQLITE_PATHPreset by the template
headscaleHEADSCALE_DATABASE_TYPEPreset by the template
headscaleHEADSCALE_DERP_URLSPreset by the template
headscaleHEADSCALE_DNS_BASE_DOMAINPreset by the template
headscaleHEADSCALE_DNS_OVERRIDE_LOCAL_DNSPreset by the template
headscaleHEADSCALE_LISTEN_ADDRPreset by the template
headscaleHEADSCALE_NOISE_PRIVATE_KEY_PATHPreset by the template
headscaleHEADSCALE_PREFIXES_V4Preset by the template
headscaleHEADSCALE_PREFIXES_V6Preset by the template
headscaleHEADSCALE_SERVER_URLPreset by the template
headscaleHEADSCALE_UNIX_SOCKETPreset by the template

Install Headscale on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get headscale
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

    levelrail-cli templates deploy headscale --name my-headscale

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Headscale.

More in Infrastructure

All Infrastructure templates