TheArchive/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2024-11-23 18:15:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
An open source, self-hosted implementation of the Tailscale control server
23 Commits 52 Branches 130 Tags 30 MiB
Go 97.6%
HTML 1.5%
Nix 0.6%
Shell 0.2%
Makefile 0.1%
18156f2efd
Go to file
Juan Font Alonso 18156f2efd README improved
2021-02-21 20:42:32 +01:00
cmd/headscale headscale now has a CLI - registration of machines occurs there 2021-02-21 01:30:03 +01:00
docker added dockerfile 2020-07-27 22:07:23 +10:00
.air.conf Added .air.conf for hot-reload support 2020-07-04 13:40:13 +02:00
.gitignore Fixed gitignore 2021-02-21 01:31:50 +01:00
app.go headscale now has a CLI - registration of machines occurs there 2021-02-21 01:30:03 +01:00
config.json.example Load DERP servers from file 2021-02-20 23:57:06 +01:00
db.go Initial commit 2020-06-21 12:32:08 +02:00
derp.yaml Load DERP servers from file 2021-02-20 23:57:06 +01:00
go.mod headscale now has a CLI - registration of machines occurs there 2021-02-21 01:30:03 +01:00
go.sum headscale now has a CLI - registration of machines occurs there 2021-02-21 01:30:03 +01:00
handlers.go headscale now has a CLI - registration of machines occurs there 2021-02-21 01:30:03 +01:00
LICENSE Initial commit 2020-06-21 11:21:07 +02:00
machine.go Bumped dependencies 2021-02-20 22:43:07 +01:00
README.md README improved 2021-02-21 20:42:32 +01:00
utils.go Bumped dependencies 2021-02-20 22:43:07 +01:00

README.md

headscale

An open source implementation of the Tailscale coordination server.

Disclaimer

  1. I have nothing to do with Tailscale, or Tailscale Inc. Just a fan of their tech.
  2. The purpose of writing this was to learn a bit how Tailscale works. Hence the emojis in the log messages and other terrible code.
  3. I don't use Headscale myself (their Solo plan + DERP infra is way more convenient).
  4. Headscale adds all the machines under the same user. Be careful!

Running it

  1. Compile the headscale binary
go build cmd/headscale/headscale.go
  1. 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
  1. 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
  1. Run the server
./headscale serve
  1. Add your first machine
tailscale up -login-server YOUR_HEADSCALE_URL

  1. Navigate to the URL you will get with tailscale up, where you can find your machine key.

  2. Register your machine using the headscale CLI

./headscale register YOURMACHINEKEY