mirror of
https://github.com/juanfont/headscale.git
synced 2024-11-29 18:33:05 +00:00
An open source, self-hosted implementation of the Tailscale control server
cmd/headscale | ||
docker | ||
.gitignore | ||
app.go | ||
config.json.example | ||
db.go | ||
derp.yaml | ||
go.mod | ||
go.sum | ||
handlers.go | ||
LICENSE | ||
machine.go | ||
README.md | ||
utils.go |
headscale
An open source implementation of the Tailscale coordination server.
Disclaimer
- I have nothing to do with Tailscale, or Tailscale Inc. Just a fan of their tech.
- The purpose of writing this was to learn a bit how Tailscale works. Hence the emojis in the log messages and other terrible code.
- I don't use Headscale myself (their Solo plan + DERP infra is way more convenient).
- Headscale adds all the machines under the same user. Be careful!
Running it
- Compile the headscale binary
go build cmd/headscale/headscale.go
- Get youself a PostgreSQL DB running.
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 # although not strictly 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 can find your machine key. -
Register your machine using the headscale CLI
./headscale register YOURMACHINEKEY