2021-02-24 14:23:36 -07:00
# Headscale
2020-06-21 03:58:25 -06:00
An open source implementation of the Tailscale coordination server.
2021-02-24 14:23:36 -07:00
## Status
- [x] Basic functionality (nodes can communicate with each other)
- [x] Node registration through the web flow
- [x] Network changes are relied to the nodes
- [ ] Node registration via pre-auth keys
2021-02-27 17:04:01 -07:00
- [ ] (WIP) Multiuser support
2021-02-24 14:23:36 -07:00
- [ ] 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!
2020-06-21 03:58:25 -06:00
## Running it
1. Compile the headscale binary
2021-02-21 12:42:32 -07:00
```shell
2020-06-21 03:58:25 -06:00
go build cmd/headscale/headscale.go
```
2021-02-24 14:23:36 -07:00
2. Get youself a PostgreSQL DB running (yes, [I know ](https://tailscale.com/blog/an-unlikely-database-migration/ ))
2020-06-21 03:58:25 -06:00
2021-02-21 12:42:32 -07:00
```shell
2020-06-21 03:58:25 -06:00
docker run --name headscale -e POSTGRES_DB=headscale -e \
POSTGRES_USER=foo -e POSTGRES_PASSWORD=bar -p 5432:5432 -d postgres
```
2020-06-21 04:32:08 -06:00
3. Sort some stuff up (headscale Wireguard keys & the config.json file)
2021-02-21 12:42:32 -07:00
```shell
2020-06-21 04:32:08 -06:00
wg genkey > private.key
2021-02-24 14:23:36 -07:00
wg pubkey < private.key > public.key # not needed
2020-06-21 04:32:08 -06:00
cp config.json.example config.json
```
2021-02-27 17:04:01 -07:00
4. Create a namespace (equivalent to a user in tailscale.com)
```shell
./headscale namespace create myfirstnamespace
```
5. Run the server
2021-02-21 12:42:32 -07:00
```shell
2021-02-20 17:34:16 -07:00
./headscale serve
2020-06-21 03:58:25 -06:00
```
2021-02-27 17:04:01 -07:00
6. Add your first machine
2021-02-21 12:42:32 -07:00
```shell
2020-06-21 03:58:25 -06:00
tailscale up -login-server YOUR_HEADSCALE_URL
```
2021-02-20 17:34:16 -07:00
2021-02-27 17:04:01 -07:00
7. Navigate to the URL you will get with `tailscale up` , where you'll find your machine key.
2021-02-20 17:34:16 -07:00
2021-02-27 17:04:01 -07:00
8. In the server, register your machine to a namespace with the CLI
2021-02-21 12:42:32 -07:00
```shell
2021-02-27 17:04:01 -07:00
./headscale register YOURMACHINEKEY myfirstnamespace
2021-02-20 17:34:16 -07:00
```
2021-02-24 14:23:36 -07:00
## 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.