myriation/headscale
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity
The custom version of headscale utilized by myriation. This follows upstream main, with a couple of open PRs manually merged in. https://ts.myriation.xyz
44 commits 1 branch 0 tags 8.5 MiB
Go 96.6%
HTML 2.4%
Nix 0.6%
Shell 0.2%
Makefile 0.2%
Find a file
Juan Font Alonso 1fad8e6e5b Added basic routes functionality
2021-03-14 11:38:42 +01:00
cmd/headscale Added basic routes functionality 2021-03-14 11:38:42 +01:00
docker added dockerfile 2020-07-27 22:07:23 +10:00
.gitignore Fixed gitignore 2021-02-21 01:31:50 +01:00
api.go Initial multi-user support using namespaces 2021-02-28 00:58:09 +01:00
app.go Added basic routes functionality 2021-03-14 11:38:42 +01:00
config.json.example Load DERP servers from file 2021-02-20 23:57:06 +01:00
db.go Initial multi-user support using namespaces 2021-02-28 00:58:09 +01:00
derp.yaml Load DERP servers from file 2021-02-20 23:57:06 +01:00
go.mod Update in preparation of supporting exit nodes 2021-03-10 22:33:37 +01:00
go.sum Update in preparation of supporting exit nodes 2021-03-10 22:33:37 +01:00
LICENSE Initial commit 2020-06-21 11:21:07 +02:00
machine.go Added basic routes functionality 2021-03-14 11:38:42 +01:00
namespaces.go Initial multi-user support using namespaces 2021-02-28 00:58:09 +01:00
README.md Added basic routes functionality 2021-03-14 11:38:42 +01:00
utils.go Seed the random IP address generator 2021-02-21 22:11:27 +01:00

README.md

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
  • Multiuser Namespace support
  • Basic routing (advertise & accept)
  • Share nodes between users namespaces
  • Node registration via pre-auth keys
  • ACLs
  • DNS

... and probably lots of stuff missing

Roadmap 🤷

Basic multiuser support (multinamespace, actually) is now implemented. No node sharing or ACLs between namespaces yet though...

Pre-auth keys should also be feasible.

Suggestions/PRs welcomed!

Running it

  1. Compile the headscale binary
go build cmd/headscale/headscale.go
  1. 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
  1. 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
  1. Create a namespace (equivalent to a user in tailscale.com)
./headscale namespace create myfirstnamespace
  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'll find your machine key.

  2. In the server, register your machine to a namespace with the CLI

./headscale register YOURMACHINEKEY myfirstnamespace

Disclaimer

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