From 14af9b3ab168c69cb187d416a96b34abcedfb7cd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A1nos=20Benjamin=20Antal?= Date: Mon, 17 Nov 2025 22:40:59 +0100 Subject: [PATCH] Add docs to manage headscale from another local user --- docs/usage/getting-started.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/docs/usage/getting-started.md b/docs/usage/getting-started.md index debdb5b2..74399c48 100644 --- a/docs/usage/getting-started.md +++ b/docs/usage/getting-started.md @@ -41,6 +41,23 @@ options, run: headscale --help ``` +!!! note "Manage headscale from another local user" + + By default only the user `headscale` or `root` will have the necessary permissions to access the unix socket + (`/var/run/headscale/headscale.sock`) that is used to communicate with the service. In order to be able to + communicate with the headscale service you have to make sure the unix socket is accessible by the user that runs + the commands. In general you can achieve this by any of the following methods: + + * using `sudo` + * run the commands as user `headscale` + * add your user to the `headscale` group + + To verify you can run the following command using your preferred method: + + ```shell + headscale users list + ``` + ## Manage headscale users In headscale, a node (also known as machine or device) is always assigned to a