1.7 KiB

Raw Blame History

Headscale

An open source implementation of the Tailscale coordination server.

Status

Basic functionality (nodes can communicate with each other)
Node registration through the web flow
Network changes are relied to the nodes
Node registration via pre-auth keys
Multiuser support
ACLs
DNS

... and probably lots of stuff missing

Roadmap 🤷

Adding multiuser support seems doable. Rather than actual users, this multi-tenancy will probably look more like namespaces in Kubernetes - a logical partitioning of resources created with a CLI.

Pre-auth keys should also be feasible.

Suggestions/PRs welcomed!

Running it

Compile the headscale binary

go build cmd/headscale/headscale.go

Get youself a PostgreSQL DB running (yes, I know)

docker run --name headscale -e POSTGRES_DB=headscale -e \
  POSTGRES_USER=foo -e POSTGRES_PASSWORD=bar -p 5432:5432 -d postgres

Sort some stuff up (headscale Wireguard keys & the config.json file)

wg genkey > private.key
wg pubkey < private.key > public.key  # not needed 
cp config.json.example config.json

Run the server

./headscale serve

Add your first machine

tailscale up -login-server YOUR_HEADSCALE_URL

Navigate to the URL you will get with tailscale up, where you'll find your machine key.
Register your machine using the headscale CLI

./headscale register YOURMACHINEKEY

Disclaimer

I have nothing to do with Tailscale, or Tailscale Inc.
The purpose of writing this was to learn how Tailscale works.
I don't use Headscale myself.