From 85641a5838cf4fde679003771206aa0de4192253 Mon Sep 17 00:00:00 2001 From: Florian Preinstorfer Date: Tue, 17 Sep 2024 17:54:45 +0200 Subject: [PATCH] Move container documentation to setup section --- .../install/container.md} | 22 +++++-------------- 1 file changed, 6 insertions(+), 16 deletions(-) rename docs/{running-headscale-container.md => setup/install/container.md} (88%) diff --git a/docs/running-headscale-container.md b/docs/setup/install/container.md similarity index 88% rename from docs/running-headscale-container.md rename to docs/setup/install/container.md index 4357ab55..c987f440 100644 --- a/docs/running-headscale-container.md +++ b/docs/setup/install/container.md @@ -7,8 +7,6 @@ **It might be outdated and it might miss necessary steps**. -## Goal - This documentation has the goal of showing a user how-to set up and run `headscale` in a container. [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). The Docker image can be found on Docker Hub [here](https://hub.docker.com/r/headscale/headscale). @@ -22,21 +20,13 @@ not work with alternatives like [Podman](https://podman.io). The Docker image ca cd ./headscale ``` -1. **(Strongly Recommended)** Download a copy of the [example configuration](https://github.com/juanfont/headscale/blob/main/config-example.yaml) from the headscale repository. +1. Download the example configuration for your chosen version and save it as: `/etc/headscale/config.yaml`. Adjust the + configuration to suit your local environment. See [Configuration](../../ref/configuration.md) for details. - - Using `wget`: - - ```shell - wget -O ./config/config.yaml https://raw.githubusercontent.com/juanfont/headscale/main/config-example.yaml - ``` - - - Using `curl`: - - ```shell - curl https://raw.githubusercontent.com/juanfont/headscale/main/config-example.yaml -o ./config/config.yaml - ``` - - Modify the config file to your preferences before launching Docker container. + ```shell + sudo mkdir -p /etc/headscale + sudo nano /etc/headscale/config.yaml + ``` Alternatively, you can mount `/var/lib` and `/var/run` from your host system by adding `--volume $(pwd)/lib:/var/lib/headscale` and `--volume $(pwd)/run:/var/run/headscale`