mirror of
https://github.com/juanfont/headscale.git
synced 2025-10-10 11:14:24 +02:00
Move deb install guide to official releases
This commit is contained in:
parent
3f8b73e0a8
commit
cbe2483d45
@ -1,60 +0,0 @@
|
|||||||
# 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
|
|
||||||
```
|
|
@ -1,8 +1,8 @@
|
|||||||
# Community packages
|
# Community packages
|
||||||
|
|
||||||
Several Linux distributions and community members provide packages for headscale. Those packages may be used instead of
|
Several Linux distributions and community members provide packages for headscale. Those packages may be used instead of
|
||||||
the official releases provided by the headscale maintainers. Such packages offer improved integration for their targeted
|
the [official releases](./official.md) provided by the headscale maintainers. Such packages offer improved integration
|
||||||
operating system and usually:
|
for their targeted operating system and usually:
|
||||||
|
|
||||||
- setup a dedicated user account to run headscale
|
- setup a dedicated user account to run headscale
|
||||||
- provide a default configuration
|
- provide a default configuration
|
||||||
|
43
docs/setup/install/official.md
Normal file
43
docs/setup/install/official.md
Normal file
@ -0,0 +1,43 @@
|
|||||||
|
# Official releases
|
||||||
|
|
||||||
|
Official releases for headscale are available as binaries for various platforms and DEB packages for Debian and Ubuntu.
|
||||||
|
Both are available on the [GitHub releases page](https://github.com/juanfont/headscale/releases).
|
||||||
|
|
||||||
|
## Using packages for Debian/Ubuntu (recommended)
|
||||||
|
|
||||||
|
It is recommended to use our DEB packages to install headscale on a Debian based system as those packages configure a
|
||||||
|
user to run headscale, provide a default configuration and ship with a systemd service file. Supported distributions are
|
||||||
|
Ubuntu 20.04 or newer, Debian 11 or newer.
|
||||||
|
|
||||||
|
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. [Configure Headscale by editing the configuration file](../../ref/configuration.md):
|
||||||
|
|
||||||
|
```shell
|
||||||
|
sudo nano /etc/headscale/config.yaml
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Enable and start the Headscale service:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
sudo systemctl enable --now headscale
|
||||||
|
```
|
||||||
|
|
||||||
|
1. Check that Headscale is running as intended:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
sudo systemctl status headscale
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user