mirror of
https://github.com/juanfont/headscale.git
synced 2025-10-10 11:14:24 +02:00
Document packages provided by the community
This commit is contained in:
parent
ba5b944426
commit
3f8b73e0a8
@ -15,10 +15,6 @@ describing how to make `headscale` run properly in a server environment.
|
|||||||
|
|
||||||
## Install `headscale`
|
## Install `headscale`
|
||||||
|
|
||||||
1. Install from ports
|
|
||||||
|
|
||||||
You can install headscale from ports by running `pkg_add headscale`.
|
|
||||||
|
|
||||||
1. Install from source
|
1. Install from source
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
@ -102,8 +98,6 @@ describing how to make `headscale` run properly in a server environment.
|
|||||||
To continue the tutorial, open a new terminal and let it run in the background.
|
To continue the tutorial, open a new terminal and let it run in the background.
|
||||||
Alternatively use terminal emulators like [tmux](https://github.com/tmux/tmux).
|
Alternatively use terminal emulators like [tmux](https://github.com/tmux/tmux).
|
||||||
|
|
||||||
To run `headscale` in the background, please follow the steps in the [rc.d section](#running-headscale-in-the-background-with-rcd) before continuing.
|
|
||||||
|
|
||||||
1. Verify `headscale` is running:
|
1. Verify `headscale` is running:
|
||||||
|
|
||||||
Verify `headscale` is available:
|
Verify `headscale` is available:
|
||||||
@ -111,58 +105,3 @@ describing how to make `headscale` run properly in a server environment.
|
|||||||
```shell
|
```shell
|
||||||
curl http://127.0.0.1:9090/metrics
|
curl http://127.0.0.1:9090/metrics
|
||||||
```
|
```
|
||||||
|
|
||||||
## Running `headscale` in the background with rc.d
|
|
||||||
|
|
||||||
This section demonstrates how to run `headscale` as a service in the background with [rc.d](https://man.openbsd.org/rc.d).
|
|
||||||
|
|
||||||
1. Create a rc.d service at `/etc/rc.d/headscale` containing:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
#!/bin/ksh
|
|
||||||
|
|
||||||
daemon="/usr/local/sbin/headscale"
|
|
||||||
daemon_logger="daemon.info"
|
|
||||||
daemon_user="root"
|
|
||||||
daemon_flags="serve"
|
|
||||||
daemon_timeout=60
|
|
||||||
|
|
||||||
. /etc/rc.d/rc.subr
|
|
||||||
|
|
||||||
rc_bg=YES
|
|
||||||
rc_reload=NO
|
|
||||||
|
|
||||||
rc_cmd $1
|
|
||||||
```
|
|
||||||
|
|
||||||
1. `/etc/rc.d/headscale` needs execute permission:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
chmod a+x /etc/rc.d/headscale
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Start `headscale` service:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
rcctl start headscale
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Make `headscale` service start at boot:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
rcctl enable headscale
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Verify the headscale service:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
rcctl check headscale
|
|
||||||
```
|
|
||||||
|
|
||||||
Verify `headscale` is available:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
curl http://127.0.0.1:9090/metrics
|
|
||||||
```
|
|
||||||
|
|
||||||
`headscale` will now run in the background and start at boot.
|
|
||||||
|
55
docs/setup/install/community.md
Normal file
55
docs/setup/install/community.md
Normal file
@ -0,0 +1,55 @@
|
|||||||
|
# Community packages
|
||||||
|
|
||||||
|
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
|
||||||
|
operating system and usually:
|
||||||
|
|
||||||
|
- setup a dedicated user account to run headscale
|
||||||
|
- provide a default configuration
|
||||||
|
- install headscale as system service
|
||||||
|
|
||||||
|
!!! warning "Community packages might be outdated"
|
||||||
|
|
||||||
|
The packages mentioned on this page might be outdated or unmaintained. Use the [official releases](./official.md) to
|
||||||
|
get the current stable version or to test pre-releases.
|
||||||
|
|
||||||
|
[](https://repology.org/project/headscale/versions)
|
||||||
|
|
||||||
|
## Arch Linux
|
||||||
|
|
||||||
|
Arch Linux offers a package for headscale, install via:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
pacman -S headscale
|
||||||
|
```
|
||||||
|
|
||||||
|
The [AUR package `headscale-git`](https://aur.archlinux.org/packages/headscale-git) can be used to build the current
|
||||||
|
development version.
|
||||||
|
|
||||||
|
## Fedora, RHEL, CentOS
|
||||||
|
|
||||||
|
A 3rd-party repository for various RPM based distributions is available at:
|
||||||
|
<https://copr.fedorainfracloud.org/coprs/jonathanspw/headscale/>. The site provides detailed setup and installation
|
||||||
|
instructions.
|
||||||
|
|
||||||
|
## Nix, NixOS
|
||||||
|
|
||||||
|
A Nix package is available as: `headscale`. See the [NixOS package site for installation
|
||||||
|
details](https://search.nixos.org/packages?show=headscale).
|
||||||
|
|
||||||
|
## Gentoo
|
||||||
|
|
||||||
|
```shell
|
||||||
|
emerge --ask net-vpn/headscale
|
||||||
|
```
|
||||||
|
|
||||||
|
Gentoo specific documentation is available [here](https://wiki.gentoo.org/wiki/User:Maffblaster/Drafts/Headscale).
|
||||||
|
|
||||||
|
## OpenBSD
|
||||||
|
|
||||||
|
Headscale is available in ports. The port installs headscale as system service with `rc.d` and provides usage
|
||||||
|
instructions upon installation.
|
||||||
|
|
||||||
|
```shell
|
||||||
|
pkg_add headscale
|
||||||
|
```
|
Loading…
Reference in New Issue
Block a user