2021-02-25 05:23:36 +08:00
# Headscale
2020-06-21 17:58:25 +08:00
An open source implementation of the Tailscale coordination server.
2021-03-18 04:58:38 +08:00
## Overview
Tailscale is [a modern VPN ](https://tailscale.com/ ) built on top of [Wireguard ](https://www.wireguard.com/ ). It [works like an overlay network ](https://tailscale.com/blog/how-tailscale-works/ ) between the computers of your networks - using all kinds of [NAT traversal sorcery ](https://tailscale.com/blog/how-nat-traversal-works/ ).
Everything in Tailscale is open source, except the GUI clients for propietary OS (Windows and macOS/iOS), and the 'coordination/control server'.
The control server works as a public key exchange mechanism for the nodes in the Tailscale network. It also assigns the IP addresses of the clients, creates the boundaries between each user, enables sharing machines between users, and exposes the advertised routes of your nodes.
Headscale implements this coordination server.
2020-06-21 17:58:25 +08:00
2021-02-25 05:23:36 +08: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
2021-03-01 03:29:31 +08:00
- [x] ~~Multiuser~~ Namespace support
2021-03-14 18:38:42 +08:00
- [x] Basic routing (advertise & accept)
2021-03-01 03:29:31 +08:00
- [ ] Share nodes between ~~users~~ namespaces
2021-02-25 05:23:36 +08:00
- [ ] Node registration via pre-auth keys
- [ ] ACLs
- [ ] DNS
... and probably lots of stuff missing
## Roadmap 🤷
2021-03-01 03:29:31 +08:00
Basic multiuser support (multinamespace, actually) is now implemented. No node sharing or ACLs between namespaces yet though...
2021-02-25 05:23:36 +08:00
Pre-auth keys should also be feasible.
Suggestions/PRs welcomed!
2020-06-21 17:58:25 +08:00
## Running it
1. Compile the headscale binary
2021-02-22 03:42:32 +08:00
```shell
2020-06-21 17:58:25 +08:00
go build cmd/headscale/headscale.go
```
2021-02-25 05:23:36 +08:00
2. Get youself a PostgreSQL DB running (yes, [I know ](https://tailscale.com/blog/an-unlikely-database-migration/ ))
2020-06-21 17:58:25 +08:00
2021-02-22 03:42:32 +08:00
```shell
2020-06-21 17:58:25 +08: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 18:32:08 +08:00
3. Sort some stuff up (headscale Wireguard keys & the config.json file)
2021-02-22 03:42:32 +08:00
```shell
2020-06-21 18:32:08 +08:00
wg genkey > private.key
2021-02-25 05:23:36 +08:00
wg pubkey < private.key > public.key # not needed
2020-06-21 18:32:08 +08:00
cp config.json.example config.json
```
2021-02-28 08:04:01 +08:00
4. Create a namespace (equivalent to a user in tailscale.com)
```shell
./headscale namespace create myfirstnamespace
```
5. Run the server
2021-02-22 03:42:32 +08:00
```shell
2021-02-21 08:34:16 +08:00
./headscale serve
2020-06-21 17:58:25 +08:00
```
2021-02-28 08:04:01 +08:00
6. Add your first machine
2021-02-22 03:42:32 +08:00
```shell
2020-06-21 17:58:25 +08:00
tailscale up -login-server YOUR_HEADSCALE_URL
```
2021-02-21 08:34:16 +08:00
2021-02-28 08:04:01 +08:00
7. Navigate to the URL you will get with `tailscale up` , where you'll find your machine key.
2021-02-21 08:34:16 +08:00
2021-02-28 08:04:01 +08:00
8. In the server, register your machine to a namespace with the CLI
2021-02-22 03:42:32 +08:00
```shell
2021-02-28 08:04:01 +08:00
./headscale register YOURMACHINEKEY myfirstnamespace
2021-02-21 08:34:16 +08:00
```
2021-02-25 05:23:36 +08: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.
