From be2487f4c00adc153afd8cf7a8e1a9cb2ade354a Mon Sep 17 00:00:00 2001 From: Moritz Poldrack <33086936+mpldr@users.noreply.github.com> Date: Sat, 16 Apr 2022 23:52:06 +0200 Subject: [PATCH 1/4] Clarified systemd friendly path Suggested-by: Rendezvous --- docs/running-headscale-linux.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/running-headscale-linux.md b/docs/running-headscale-linux.md index 98a67f1..166851b 100644 --- a/docs/running-headscale-linux.md +++ b/docs/running-headscale-linux.md @@ -150,7 +150,7 @@ or run all headscale commands as the headscale user: su - headscale ``` -2. 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 path that is writable by the `headscale` user or group: ```yaml unix_socket: /var/run/headscale/headscale.sock @@ -165,8 +165,7 @@ systemctl daemon-reload 4. Enable and start the new `headscale` service: ```shell -systemctl enable headscale -systemctl start headscale +systemctl enable --now headscale ``` 5. Verify the headscale service: From 41a8c14acb9657f10238da74c9177642cad1b286 Mon Sep 17 00:00:00 2001 From: Moritz Poldrack <33086936+mpldr@users.noreply.github.com> Date: Sat, 16 Apr 2022 23:56:57 +0200 Subject: [PATCH 2/4] add information on how to create a headscale user --- docs/running-headscale-linux.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/running-headscale-linux.md b/docs/running-headscale-linux.md index 166851b..55b002f 100644 --- a/docs/running-headscale-linux.md +++ b/docs/running-headscale-linux.md @@ -30,6 +30,8 @@ mkdir -p /etc/headscale # Directory for Database, and other variable data (like certificates) mkdir -p /var/lib/headscale +# or if you create a headscale user: +useradd -md /var/lib/headscale/ -rUs /usr/bin/nologin headscale ``` 4. Create an empty SQLite database: From 7ce0bd053c2ceebbdac931d2a01799dfba65a8a7 Mon Sep 17 00:00:00 2001 From: Moritz Poldrack <33086936+mpldr@users.noreply.github.com> Date: Sat, 16 Apr 2022 23:58:05 +0200 Subject: [PATCH 3/4] removed leading whitespace --- docs/running-headscale-linux.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/running-headscale-linux.md b/docs/running-headscale-linux.md index 55b002f..e3e9699 100644 --- a/docs/running-headscale-linux.md +++ b/docs/running-headscale-linux.md @@ -52,7 +52,7 @@ from the [headscale repository](../) 6. Start the headscale server: ```shell - headscale serve +headscale serve ``` This command will start `headscale` in the current terminal session. From 6dd9e93346b2d8a55540c855ea8ce976a51fceef Mon Sep 17 00:00:00 2001 From: Moritz Poldrack Date: Thu, 21 Apr 2022 11:00:17 +0200 Subject: [PATCH 4/4] expanded arguments in useradd to be easier to understand for beginners --- docs/running-headscale-linux.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/running-headscale-linux.md b/docs/running-headscale-linux.md index e3e9699..89d02e8 100644 --- a/docs/running-headscale-linux.md +++ b/docs/running-headscale-linux.md @@ -31,7 +31,13 @@ mkdir -p /etc/headscale # Directory for Database, and other variable data (like certificates) mkdir -p /var/lib/headscale # or if you create a headscale user: -useradd -md /var/lib/headscale/ -rUs /usr/bin/nologin headscale +useradd \ + --create-home \ + --home-dir /var/lib/headscale/ \ + --system \ + --user-group \ + --shell /usr/bin/nologin \ + headscale ``` 4. Create an empty SQLite database: