devproje/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2024-11-26 08:53:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Readme improved

Browse source
This commit is contained in:
Juan Font Alonso 2021-02-24 22:23:36 +01:00
parent 6a397345aa
commit 5da39f9176
1 changed files with 31 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

40
README.md
View file

@ -1,13 +1,27 @@
# headscale # Headscale
An open source implementation of the Tailscale coordination server. An open source implementation of the Tailscale coordination server.
## Disclaimer ## 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
- [ ] 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!
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 ## Running it
@ -17,7 +31,7 @@ An open source implementation of the Tailscale coordination server.
go build cmd/headscale/headscale.go go build cmd/headscale/headscale.go
``` ```
2. Get youself a PostgreSQL DB running. 2. Get youself a PostgreSQL DB running (yes, [I know](https://tailscale.com/blog/an-unlikely-database-migration/))
```shell ```shell
docker run --name headscale -e POSTGRES_DB=headscale -e \ docker run --name headscale -e POSTGRES_DB=headscale -e \
@ -27,7 +41,7 @@ An open source implementation of the Tailscale coordination server.
3. Sort some stuff up (headscale Wireguard keys & the config.json file) 3. Sort some stuff up (headscale Wireguard keys & the config.json file)
```shell ```shell
wg genkey > private.key wg genkey > private.key
wg pubkey < private.key > public.key # although not strictly needed wg pubkey < private.key > public.key # not needed
cp config.json.example config.json cp config.json.example config.json
``` ```
@ -41,9 +55,17 @@ An open source implementation of the Tailscale coordination server.
tailscale up -login-server YOUR_HEADSCALE_URL tailscale up -login-server YOUR_HEADSCALE_URL
``` ```
6. Navigate to the URL you will get with `tailscale up`, where you can find your machine key. 6. Navigate to the URL you will get with `tailscale up`, where you'll find your machine key.
7. Register your machine using the headscale CLI 7. Register your machine using the headscale CLI
```shell ```shell
./headscale register YOURMACHINEKEY ./headscale register YOURMACHINEKEY
``` ```
## 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.