mirror of
https://github.com/juanfont/headscale.git
synced 2024-12-28 23:13:18 -05:00
35bfe7ced0
* 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
98 lines
2.3 KiB
Markdown
98 lines
2.3 KiB
Markdown
# 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](./running-headscale-linux-manual.md).
|
|
|
|
You should _not_ delete the database (`/var/lib/headscale/db.sqlite`) and the
|
|
configuration (`/etc/headscale/config.yaml`).
|
|
|
|
## Installation
|
|
|
|
1. Download the [latest Headscale package](https://github.com/juanfont/headscale/releases/latest) for your platform (`.deb` for Ubuntu and Debian).
|
|
|
|
```shell
|
|
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"
|
|
```
|
|
|
|
1. Install Headscale:
|
|
|
|
```shell
|
|
sudo apt install ./headscale.deb
|
|
```
|
|
|
|
1. Enable Headscale service, this will start Headscale at boot:
|
|
|
|
```shell
|
|
sudo systemctl enable headscale
|
|
```
|
|
|
|
1. Configure Headscale by editing the configuration file:
|
|
|
|
```shell
|
|
nano /etc/headscale/config.yaml
|
|
```
|
|
|
|
1. Start Headscale:
|
|
|
|
```shell
|
|
sudo systemctl start headscale
|
|
```
|
|
|
|
1. Check that Headscale is running as intended:
|
|
|
|
```shell
|
|
systemctl status headscale
|
|
```
|
|
|
|
## Using Headscale
|
|
|
|
### Create a user
|
|
|
|
```shell
|
|
headscale users create myfirstuser
|
|
```
|
|
|
|
### Register a machine (normal login)
|
|
|
|
On a client machine, run the `tailscale` login command:
|
|
|
|
```shell
|
|
tailscale up --login-server <YOUR_HEADSCALE_URL>
|
|
```
|
|
|
|
Register the machine:
|
|
|
|
```shell
|
|
headscale nodes register --user myfirstuser --key <YOUR_MACHINE_KEY>
|
|
```
|
|
|
|
### Register machine using a pre authenticated key
|
|
|
|
Generate a key using the command line:
|
|
|
|
```shell
|
|
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:
|
|
|
|
```shell
|
|
tailscale up --login-server <YOUR_HEADSCALE_URL> --authkey <YOUR_AUTH_KEY>
|
|
```
|