From 18156f2efdea88b9dccb0601414c15707d677bd7 Mon Sep 17 00:00:00 2001 From: Juan Font Alonso Date: Sun, 21 Feb 2021 20:42:32 +0100 Subject: [PATCH] README improved --- README.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index ee51ad8a..47c69873 100644 --- a/README.md +++ b/README.md @@ -13,37 +13,37 @@ An open source implementation of the Tailscale coordination server. ## Running it 1. Compile the headscale binary - ``` + ```shell go build cmd/headscale/headscale.go ``` 2. Get youself a PostgreSQL DB running. - ``` + ```shell docker run --name headscale -e POSTGRES_DB=headscale -e \ POSTGRES_USER=foo -e POSTGRES_PASSWORD=bar -p 5432:5432 -d postgres ``` 3. Sort some stuff up (headscale Wireguard keys & the config.json file) - ``` + ```shell 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 ``` 4. Run the server - ``` + ```shell ./headscale serve ``` 5. Add your first machine - ``` + ```shell 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. 7. Register your machine using the headscale CLI - ``` + ```shell ./headscale register YOURMACHINEKEY ```