Mirrors/juanfont.headscale

mirror of https://github.com/juanfont/headscale.git synced 2025-10-10 11:14:24 +02:00

Florian Preinstorfer 40e226c9ee Add a getting started page and explain the first steps with headscale

* Use the existing "Using headscale" sections and combine them into a
  single getting started guide with a little bit more explanation.
* Explain how to get help from the command line client.
* Remove duplicated sections from existing installation guides

2024-10-09 15:41:54 +02:00

1.5 KiB

Raw 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
```