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

README improved

Browse source
This commit is contained in:
Juan Font Alonso 2021-02-21 20:42:32 +01:00
parent 52257e32a3
commit 18156f2efd
1 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -13,37 +13,37 @@ An open source implementation of the Tailscale coordination server.
## Running it ## Running it
1. Compile the headscale binary 1. Compile the headscale binary
``` ```shell
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.
``` ```shell
docker run --name headscale -e POSTGRES_DB=headscale -e \ docker run --name headscale -e POSTGRES_DB=headscale -e \
POSTGRES_USER=foo -e POSTGRES_PASSWORD=bar -p 5432:5432 -d postgres POSTGRES_USER=foo -e POSTGRES_PASSWORD=bar -p 5432:5432 -d postgres
``` ```
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
wg genkey > private.key wg genkey > private.key
wg pubkey < private.key > public.key wg pubkey < private.key > public.key # although not strictly needed
cp config.json.example config.json cp config.json.example config.json
``` ```
4. Run the server 4. Run the server
``` ```shell
./headscale serve ./headscale serve
``` ```
5. Add your first machine 5. Add your first machine
``` ```shell
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 can find your machine key.
7. Register your machine using the headscale CLI 7. Register your machine using the headscale CLI
``` ```shell
./headscale register YOURMACHINEKEY ./headscale register YOURMACHINEKEY
``` ```