mirror of
https://github.com/juanfont/headscale.git
synced 2025-10-28 10:51:44 +01:00
8c7d8ee34f
* Setup mkdocs-redirects * Restructure existing documentation * Move client OS support into the documentation * Move existing Client OS support table into its own documentation page * Link from README.md to the rendered documentation * Document minimum Tailscale client version * Reuse CONTRIBUTING.md" in the documentation * Include "CONTRIBUTING.md" from the repository root * Update FAQ and index page and link to the contributing docs * Add configuration reference * 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 * Document requirements and assumptions * Document packages provided by the community * Move deb install guide to official releases * Move manual install guide to official releases * Move container documentation to setup section * Move sealos documentation to cloud install page * Move OpenBSD docs to build from source * Simplify DNS documentation * Add sponsor page * Add releases page * Add features page * Add help page * Add upgrading page * Adjust mkdocs nav * Update wording Use the term headscale for the project, Headscale on the beginning of a sentence and `headscale` when refering to the CLI. * Welcome to headscale * Link to existing documentation in the FAQ * Remove the goal header and use the text as opener * Indent code block in OIDC * Make a few pages linter compatible Also update ignored files for prettier * Recommend HTTPS on port 443 Fixes: #2164 * Use hosts in acl documentation thx @efficacy38 for noticing this Ref: #1863 * Use mkdocs-macros to set headscale version once
56 lines
1.8 KiB
Markdown
56 lines
1.8 KiB
Markdown
# Community packages
|
|
|
|
Several Linux distributions and community members provide packages for headscale. Those packages may be used instead of
|
|
the [official releases](./official.md) 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
|
|
```
|