myriation/headscale
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity

Update README.md

Browse source
This commit is contained in:
Juan Font 2020-06-21 11:58:25 +02:00 committed by GitHub
parent 8077923b68
commit ecf9c9b3db
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
README.md
View file

@ -1,2 +1,35 @@
# headscale
An opensource implementation of the Tailscale coordination server
An open source implementation of the Tailscale coordination server.
## Disclaimer
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
1. Compile the headscale binary
```
go build cmd/headscale/headscale.go
```
2. Get youself a PostgreSQL DB running.
```
docker run --name headscale -e POSTGRES_DB=headscale -e \
POSTGRES_USER=foo -e POSTGRES_PASSWORD=bar -p 5432:5432 -d postgres
```
3. Run it (asuming you have renamed the config.json.example to config.json)
```
./headcale
```
4. Add your first machine
```
tailscale up -login-server YOUR_HEADSCALE_URL
```