mirror of https://github.com/juanfont/headscale.git synced 2024-09-20 07:16:35 +08:00

Add support for service reload and sync service file (#2102 )

* Add support for service reload and sync service file

* Copy the systemd.service file to the manual linux docs and adjust the
  path to the headscale binary to match with the previous documentation
  blocks. Unfortunately, there seems to be no easy way to include a
  file in mkdocs.
* Remove a redundant "deprecation" block. The beginning of the
  documentation already states that.
* Add `ExecReload` to the systemd.service file.

Fixes: #2016

* Its called systemd

* Fix link to systemd homepage

2024-09-05 10:08:50 +00:00

2.3 KiB

Raw Permalink Blame History

Running headscale on Linux

Requirements

Ubuntu 20.04 or newer, Debian 11 or newer.

Goal

Get Headscale up and running.

This includes running Headscale with systemd.

Migrating from manual install

If you are migrating from the old manual install, the best thing would be to remove the files installed by following the guide in reverse.

You should not delete the database (/var/lib/headscale/db.sqlite) and the configuration (/etc/headscale/config.yaml).

Installation

Download the latest Headscale package for your platform (.deb for Ubuntu and Debian).

HEADSCALE_VERSION="" # See above URL for latest version, e.g. "X.Y.Z" (NOTE: do not add the "v" prefix!)
HEADSCALE_ARCH="" # Your system architecture, e.g. "amd64"
wget --output-document=headscale.deb \
  "https://github.com/juanfont/headscale/releases/download/v${HEADSCALE_VERSION}/headscale_${HEADSCALE_VERSION}_linux_${HEADSCALE_ARCH}.deb"

Install Headscale:
```
sudo apt install ./headscale.deb
```
Enable Headscale service, this will start Headscale at boot:
```
sudo systemctl enable headscale
```
Configure Headscale by editing the configuration file:
```
nano /etc/headscale/config.yaml
```
Start Headscale:
```
sudo systemctl start headscale
```
Check that Headscale is running as intended:
```
systemctl status headscale
```

Using Headscale

Create a user

headscale users create myfirstuser

On a client machine, run the tailscale login command:

tailscale up --login-server <YOUR_HEADSCALE_URL>

headscale nodes register --user myfirstuser --key <YOUR_MACHINE_KEY>

Register machine using a pre authenticated key

Generate a key using the command line:

headscale preauthkeys create --user myfirstuser --reusable --expiration 24h

This will return a pre-authenticated key that is used to connect a node to headscale during the tailscale command:

tailscale up --login-server <YOUR_HEADSCALE_URL> --authkey <YOUR_AUTH_KEY>

2.3 KiB Raw Permalink Blame History