From 6b7c74133d383ef56180649ca9ba4e312e804871 Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Sun, 2 Jan 2022 19:53:49 +0000 Subject: [PATCH] Use markdown numbering so github gets it --- docs/running-headscale-container.md | 10 +++++----- docs/running-headscale-linux.md | 22 +++++++++++----------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/running-headscale-container.md b/docs/running-headscale-container.md index 8b15c06d..fe7298a4 100644 --- a/docs/running-headscale-container.md +++ b/docs/running-headscale-container.md @@ -17,13 +17,13 @@ not work with alternatives like [Podman](https://podman.io). mkdir config ``` -1. Create an empty SQlite datebase: +2. Create an empty SQlite datebase: ```shell touch config/db.sqlite ``` -1. Create a `headscale` configuration: +3. Create a `headscale` configuration: ```shell touch config/config.yaml @@ -31,7 +31,7 @@ touch config/config.yaml It is strongly recommended to copy the [example configuration](../config.yaml) from the [headscale repository](../) -1. Start the headscale server: +4. Start the headscale server: ```shell docker run \ @@ -48,7 +48,7 @@ docker run \ This command will mount `config/` under `/etc/headscale`, forward port 8080 out of the container so the `headscale` instance becomes available and then detach so headscale runs in the background. -1. Verify `headscale` is running: +5. Verify `headscale` is running: Follow the container logs: @@ -68,7 +68,7 @@ Verify `headscale` is available: curl http://127.0.0.1:8080/metrics ``` -1. Create a namespace ([tailnet](https://tailscale.com/kb/1136/tailnet/)): +6. 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 5eb2dbdb..59264653 100644 --- a/docs/running-headscale-linux.md +++ b/docs/running-headscale-linux.md @@ -15,13 +15,13 @@ wget --output-document=/usr/local/bin/headscale \ https://github.com/juanfont/headscale/releases/download/v/headscale__linux_ ``` -1. Make `headscale` executable: +2. Make `headscale` executable: ```shell chmod +x /usr/local/bin/headscale ``` -1. Prepare a direction to hold `headscale` configuration and the [SQLite](https://www.sqlite.org/) database: +3. Prepare a direction to hold `headscale` configuration and the [SQLite](https://www.sqlite.org/) database: ```shell # Directory for configuration @@ -32,13 +32,13 @@ mkdir -p /etc/headscale mkdir -p /var/lib/headscale ``` -1. Create an empty SQlite datebase: +4. Create an empty SQlite datebase: ```shell touch /var/lib/headscale/db.sqlite ``` -1. Create a `headscale` configuration: +5. Create a `headscale` configuration: ```shell touch /etc/headscale/config.yaml @@ -47,7 +47,7 @@ touch /etc/headscale/config.yaml It is strongly recommended to copy and modifiy the [example configuration](../config.yaml) from the [headscale repository](../) -1. Start the headscale server: +6. Start the headscale server: ```shell headscale serve @@ -60,7 +60,7 @@ Alternatively use terminal emulators like [tmux](https://github.com/tmux/tmux) o 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: +7. Verify `headscale` is running: Verify `headscale` is available: @@ -68,7 +68,7 @@ Verify `headscale` is available: curl http://127.0.0.1:8080/metrics ``` -1. Create a namespace ([tailnet](https://tailscale.com/kb/1136/tailnet/)): +8. Create a namespace ([tailnet](https://tailscale.com/kb/1136/tailnet/)): ```shell headscale namespaces create myfirstnamespace @@ -136,26 +136,26 @@ RuntimeDirectory=headscale WantedBy=multi-user.target ``` -1. In `/etc/headscale/config.yaml`, override the default `headscale` unix socket with a SystemD friendly path: +2. In `/etc/headscale/config.yaml`, override the default `headscale` unix socket with a SystemD friendly path: ```yaml unix_socket: /var/run/headscale/headscale.sock ``` -1. Reload SystemD to load the new configuration file: +3. Reload SystemD to load the new configuration file: ```shell systemctl daemon-reload ``` -1. Enable and start the new `headscale` service: +4. Enable and start the new `headscale` service: ```shell systemctl enable headscale systemctl start headscale ``` -1. Verify the headscale service: +5. Verify the headscale service: ```shell systemctl status headscale