mirror of https://github.com/YunoHost-Apps/headscale_ynh.git synced 2024-09-03 19:25:53 +02:00

FOSS implementation of the Tailscale control server, packaged for YunoHost

Find a file

tituspijean 313ee98124 Fix arm64 source checksum		2023-07-06 20:48:52 +02:00
.github	Initial debugging	2023-06-11 11:46:30 +02:00
conf	Add description to the service	2023-06-11 18:15:04 +02:00
doc	Remove screenshot	2023-06-11 19:18:14 +02:00
scripts	Remove Dex upon deinstallation of the app	2023-06-11 18:12:27 +02:00
.gitignore	Initial commit	2023-06-10 22:28:07 +02:00
LICENSE	Initial commit	2023-06-10 22:28:07 +02:00
manifest.toml	Fix arm64 source checksum	2023-07-06 20:48:52 +02:00
README.md	Auto-update README	2023-06-11 10:28:35 +00:00
README_fr.md	Auto-update README	2023-06-11 10:28:35 +00:00
tests.toml	Do not test change_url	2023-06-11 19:05:34 +02:00

README.md

Headscale for YunoHost

Lire ce readme en français.

This package allows you to install Headscale quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

An open source, self-hosted implementation of the Tailscale control server.

What is Tailscale

Tailscale is a modern VPN built on top of Wireguard. It works like an overlay network between the computers of your networks - using NAT traversal.

Everything in Tailscale is Open Source, except the GUI clients for proprietary OS (Windows and macOS/iOS), and the control server.

The control server works as an exchange point of Wireguard public keys for the nodes in the Tailscale network. It assigns the IP addresses of the clients, creates the boundaries between each user, enables sharing machines between users, and exposes the advertised routes of your nodes.

A Tailscale network (tailnet) is private network which Tailscale assigns to a user in terms of private users or an organisation.

Design goal

Headscale aims to implement a self-hosted, open source alternative to the Tailscale control server. Headscale's goal is to provide self-hosters and hobbyists with an open-source server they can use for their projects and labs. It implements a narrow scope, a single Tailnet, suitable for a personal use, or a small open-source organisation.

Features

Full "base" support of Tailscale's features
Configurable DNS
- Split DNS
Node registration
- Single-Sign-On (via Open ID Connect)
- Pre authenticated key
Taildrop (File Sharing)
Access control lists
MagicDNS
Support for multiple IP ranges in the tailnet
Dual stack (IPv4 and IPv6)
Routing advertising (including exit nodes)
Ephemeral nodes
Embedded DERP server

from Headscale's README. See Links section below.

Shipped version: 0.22.3~ynh1

Screenshots

Documentation and resources

Official app website: https://headscale.net/
Official user documentation: https://tailscale.com/kb/
Official admin documentation: https://headscale.net/
Upstream app code repository: https://github.com/juanfont/headscale
YunoHost documentation for this app: https://yunohost.org/app_headscale
Report a bug: https://github.com/YunoHost-Apps/headscale_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/headscale_ynh/tree/testing --debug
or
sudo yunohost app upgrade headscale -u https://github.com/YunoHost-Apps/headscale_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps