mirror of
https://github.com/YunoHost-Apps/headscale_ynh.git
synced 2024-09-03 19:25:53 +02:00
93 lines
3.8 KiB
Markdown
93 lines
3.8 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# Headscale for YunoHost
|
|
|
|
[](https://ci-apps.yunohost.org/ci/apps/headscale/)  
|
|
|
|
[](https://install-app.yunohost.org/?app=headscale)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *This package allows you to install Headscale quickly and simply on a YunoHost server.*
|
|
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) 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](https://tailscale.com/) built on top of
|
|
[Wireguard](https://www.wireguard.com/).
|
|
It [works like an overlay network](https://tailscale.com/blog/how-tailscale-works/)
|
|
between the computers of your networks - using
|
|
[NAT traversal](https://tailscale.com/blog/how-nat-traversal-works/).
|
|
|
|
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)](https://tailscale.com/kb/1136/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](https://tailscale.com/kb/1054/dns/#using-dns-settings-in-the-admin-console)
|
|
- Node registration
|
|
- Single-Sign-On (via Open ID Connect)
|
|
- Pre authenticated key
|
|
- Taildrop (File Sharing)
|
|
- [Access control lists](https://tailscale.com/kb/1018/acls/)
|
|
- [MagicDNS](https://tailscale.com/kb/1081/magicdns)
|
|
- Support for multiple IP ranges in the tailnet
|
|
- Dual stack (IPv4 and IPv6)
|
|
- Routing advertising (including exit nodes)
|
|
- Ephemeral nodes
|
|
- Embedded [DERP server](https://tailscale.com/blog/how-tailscale-works/#encrypted-tcp-relays-derp)
|
|
|
|
*from Headscale's README. See Links section below.*
|
|
|
|
|
|
**Shipped version:** 0.22.3~ynh2
|
|
## 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 Store: <https://apps.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](https://github.com/YunoHost-Apps/headscale_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
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>
|