From bea52678e3313b2c6f788c69b608b998a582c0d5 Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Wed, 19 Apr 2023 16:49:10 +0200 Subject: [PATCH] move current linux documentation into "manual" Signed-off-by: Kristoffer Dalby --- ...adscale-linux.md => running-headscale-linux-manual.md} | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) rename docs/{running-headscale-linux.md => running-headscale-linux-manual.md} (91%) diff --git a/docs/running-headscale-linux.md b/docs/running-headscale-linux-manual.md similarity index 91% rename from docs/running-headscale-linux.md rename to docs/running-headscale-linux-manual.md index 744bf725..374fea89 100644 --- a/docs/running-headscale-linux.md +++ b/docs/running-headscale-linux-manual.md @@ -1,5 +1,9 @@ # Running headscale on Linux +## Note: Outdated and "advanced" +This documentation is considered the "legacy"/advanced/manual version of the documentation, you most likely do not +want to use this documentation and rather look at the distro specific documentation (TODO LINK)[]. + ## Goal This documentation has the goal of showing a user how-to set up and run `headscale` on Linux. @@ -94,7 +98,7 @@ tailscale up --login-server YOUR_HEADSCALE_URL Register the machine: ```shell -headscale --user myfirstuser nodes register --key +headscale --user myfirstuser nodes register --key ``` ### Register machine using a pre authenticated key @@ -113,6 +117,8 @@ tailscale up --login-server --authkey ## Running `headscale` in the background with SystemD +:warning: **Deprecated**: This part is very outdated and you should use the [pre-packaged Headscale for this](./running-headscale-linux.md + This section demonstrates 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.