Mirrors/juanfont.headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2024-12-20 19:09:07 +01:00
Code Issues Projects Releases Wiki Activity
An open source, self-hosted implementation of the Tailscale control server
41 Commits 53 Branches 132 Tags 41 MiB
Go 97.7%
HTML 1.4%
Nix 0.6%
Shell 0.2%
Makefile 0.1%
2733a34033
Go to file
Juan Font Alonso 2733a34033 Update readme with namespace info
2021-02-28 01:04:01 +01:00
cmd/headscale Initial multi-user support using namespaces 2021-02-28 00:58:09 +01:00
docker
.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 Initial multi-user support using namespaces 2021-02-28 00:58:09 +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 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
LICENSE
machine.go Initial multi-user support using namespaces 2021-02-28 00:58:09 +01:00
namespaces.go Initial multi-user support using namespaces 2021-02-28 00:58:09 +01:00
README.md Update readme with namespace info 2021-02-28 01:04:01 +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
  • Node registration via pre-auth keys
  • (WIP) 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

  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.