# Headscale

Headscale is an open-source, self-hosted implementation of the Tailscale control server. It is open source and self-hosted, installable on Kubernetes (Helm), Proxmox, TrueNAS and Unraid.

Canonical page: https://ourlocalhost.com/app/128/headscale

## Description

Headscale is an open-source, self-hosted implementation of the Tailscale control server. It lets self-hosters and hobbyists run their own control server for a single Tailnet, providing an open, self-managed WireGuard-based overlay network for personal projects or small organisations.

## Platform availability

Available on 4 of 9 platforms: Unraid, TrueNAS, Proxmox, Helm.

## Health score

79/100 (Good), based on 5 of 5 factors.
- Maintained: 100 (last commit 17 days ago)
- Popular: 93 (44,388 GitHub stars)
- Easy to install: 65 (4 install platforms, install notes, Docker image)
- Light to run: 40 (4 GB minimum RAM, runs on ARM)
- Security check: 63 (no serious findings, 13 minor, CI, tests, OpenSSF Scorecard 5.3/10)

## Links

- Official website: https://headscale.net
- Kubernetes (Helm): https://artifacthub.io/packages/helm/gabe565/headscale
- Proxmox: https://community-scripts.github.io/ProxmoxVE/scripts?id=headscale
- TrueNAS: https://apps.truenas.com/catalog/headscale/
- Unraid: https://ca.unraid.net/apps/headscale-1xxirrq19qwq2y?q=headscale
- GitHub: https://github.com/juanfont/headscale

## Common questions

### Do I need to create the configuration file before starting Headscale?

Yes, you should create the config file and fill in required settings before enabling Headscale. Without a valid config, the server may fail to start or refuse devices and users.

### Which Headscale folders should I back up?

Back up the config directory at /etc/headscale and the data directory at /var/lib/headscale. If those folders are lost, the network records and keys are gone.

### Does Headscale support multiple tailnets?

No, the design goal is a narrow scope with a single Tailscale network. That suits personal use or a small organization.

### What ports and folders should I expose when running Headscale in Docker?

Mount local config and lib folders into the container and publish ports 8080 and 9090. Port 8080 serves the admin/API interface, while 9090 serves metrics.

### Can I use standard Tailscale clients with Headscale?

Users report that standard Tailscale clients can be used, but connecting to a Headscale server may require workarounds.

## Alternatives

- LogMeIn Hamachi: Seamlessly connects devices and networks, extending LAN-like connectivity to mobile users and teams with a secure, hosted VPN service.
- NetBird: NetBird is an open-source Zero Trust networking platform that makes it easy for engineers to create fast, secure, and private networks with…
- SoftEther VPN: SoftEther VPN ("SoftEther" means "Software Ethernet") is one of the world's most powerful and easy-to-use multi-protoco…
- Tailscale: Private networks made easy.
- ZeroTier: ZeroTier is an open-source, cross-platform virtual LAN/VPN service that connects your devices and servers into one private network, so you…
- defguard
- ngrok: ngrok creates secure tunnels from the internet to your local network, letting you expose local development servers, APIs, and applications…

---
Source: Our Local Host (https://ourlocalhost.com/app/128/headscale), the self-hosted and open-source app directory.