From 8da029bd14fb8f5cc4d5277ead8da988f2aef6ff Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Sun, 2 Jan 2022 19:48:57 +0000 Subject: [PATCH] Add missing links --- docs/running-headscale-container.md | 8 ++++---- docs/running-headscale-linux.md | 14 +++++++------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/running-headscale-container.md b/docs/running-headscale-container.md index c1f4099..8b15c06 100644 --- a/docs/running-headscale-container.md +++ b/docs/running-headscale-container.md @@ -6,12 +6,12 @@ it is up to date, or working. ## Goal This documentation has the goal of showing a user how-to set up and run `headscale` in a container. -[Docker]() is used as the reference container implementation, but there is no reason that it should -not work with alternatives like [Podman](). +[Docker](https://www.docker.com) is used as the reference container implementation, but there is no reason that it should +not work with alternatives like [Podman](https://podman.io). ## Configure and run `headscale` -1. Prepare a direction to hold `headscale` configuration and the [SQlite]() database: +1. Prepare a direction to hold `headscale` configuration and the [SQLite](https://www.sqlite.org/) database: ```shell mkdir config @@ -68,7 +68,7 @@ Verify `headscale` is available: curl http://127.0.0.1:8080/metrics ``` -1. Create a namespace ([tailnet]()): +1. Create a namespace ([tailnet](https://tailscale.com/kb/1136/tailnet/)): ```shell docker exec headscale -- headscale namespaces create myfirstnamespace diff --git a/docs/running-headscale-linux.md b/docs/running-headscale-linux.md index 0f0d570..5eb2dbd 100644 --- a/docs/running-headscale-linux.md +++ b/docs/running-headscale-linux.md @@ -3,12 +3,12 @@ ## Goal This documentation has the goal of showing a user how-to set up and run `headscale` on Linux. -In additional to the "get up and running section", there is an optional [SystemD section]() +In additional to the "get up and running section", there is an optional [SystemD section](#running-headscale-in-the-background-with-systemd) describing how to make `headscale` run properly in a server environment. ## Configure and run `headscale` -1. Download the latest [`headscale` binary from GitHub's release page](): +1. Download the latest [`headscale` binary from GitHub's release page](https://github.com/juanfont/headscale/releases): ```shell wget --output-document=/usr/local/bin/headscale \ @@ -21,7 +21,7 @@ wget --output-document=/usr/local/bin/headscale \ chmod +x /usr/local/bin/headscale ``` -1. Prepare a direction to hold `headscale` configuration and the [SQlite]() database: +1. Prepare a direction to hold `headscale` configuration and the [SQLite](https://www.sqlite.org/) database: ```shell # Directory for configuration @@ -56,9 +56,9 @@ from the [headscale repository](../) This command will start `headscale` in the current terminal session. To continue the tutorial, open a new terminal and let it run in the background. -Alternatively use terminal emulators like [tmux]() or [screen](). +Alternatively use terminal emulators like [tmux](https://github.com/tmux/tmux) or [screen](https://www.gnu.org/software/screen/). -To run `headscale` in the background, please follow the steps in the [SystemD section]() before continuing. +To run `headscale` in the background, please follow the steps in the [SystemD section](#running-headscale-in-the-background-with-systemd) before continuing. 1. Verify `headscale` is running: @@ -68,7 +68,7 @@ Verify `headscale` is available: curl http://127.0.0.1:8080/metrics ``` -1. Create a namespace ([tailnet]()): +1. Create a namespace ([tailnet](https://tailscale.com/kb/1136/tailnet/)): ```shell headscale namespaces create myfirstnamespace @@ -104,7 +104,7 @@ tailscale up --login-server --authkey ## Running `headscale` in the background with SystemD -In this section it will be demonstrated how to run `headscale` as a service in the background with [SystemD](). +In this section it will be demonstrated how to run `headscale` as a service in the background with [SystemD](https://www.freedesktop.org/wiki/Software/systemd/). This should work on most modern Linux distributions. 1. Create a SystemD service configuration at `/etc/systemd/system/headscale.service` containing: