2023-06-11 11:46:41 +02:00
<!--
2024-03-29 07:06:23 +01:00
Nota bene : ce README est automatiquement généré par < https: / / github . com / YunoHost / apps / tree / master / tools / readme_generator >
Il NE doit PAS être modifié à la main.
2023-06-11 11:46:41 +02:00
-->
# Headscale pour YunoHost
[![Niveau d’ intégration ](https://dash.yunohost.org/integration/headscale.svg )](https://dash.yunohost.org/appci/app/headscale) ![Statut du fonctionnement ](https://ci-apps.yunohost.org/ci/badges/headscale.status.svg ) ![Statut de maintenance ](https://ci-apps.yunohost.org/ci/badges/headscale.maintain.svg )
[![Installer Headscale avec YunoHost ](https://install-app.yunohost.org/install-with-yunohost.svg )](https://install-app.yunohost.org/?app=headscale)
2024-03-29 07:06:23 +01:00
*[Lire le README dans d'autres langues.](./ALL_README.md)*
2023-06-11 11:46:41 +02:00
2024-03-29 07:06:23 +01:00
> *Ce package vous permet d’ installer Headscale rapidement et simplement sur un serveur YunoHost.*
> *Si vous n’ avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’ installer et en profiter.*
2023-06-11 11:46:41 +02:00
## Vue d’ ensemble
2023-06-11 12:28:35 +02:00
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.
2023-06-11 11:46:41 +02:00
### Features
2023-06-11 12:28:35 +02:00
- 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.*
2023-06-11 11:46:41 +02:00
2024-03-29 07:06:23 +01:00
**Version incluse :** 0.22.3~ynh1
2023-06-11 11:46:41 +02:00
## Documentations et ressources
2024-03-29 07:06:23 +01:00
- Site officiel de l’ app : < https: // headscale . net />
- Documentation officielle utilisateur : < https: // tailscale . com / kb />
- Documentation officielle de l’ admin : < https: // headscale . net />
- Dépôt de code officiel de l’ app : < https: // github . com / juanfont / headscale >
- YunoHost Store : < https: // apps . yunohost . org / app / headscale >
- Signaler un bug : < https: // github . com / YunoHost-Apps / headscale_ynh / issues >
2023-06-11 11:46:41 +02:00
## Informations pour les développeurs
2024-03-29 07:06:23 +01:00
Merci de faire vos pull request sur la [branche `testing` ](https://github.com/YunoHost-Apps/headscale_ynh/tree/testing ).
2023-06-11 11:46:41 +02:00
2024-03-29 07:06:23 +01:00
Pour essayer la branche `testing` , procédez comme suit :
2023-06-11 11:46:41 +02:00
2024-03-29 07:06:23 +01:00
```bash
2023-06-11 11:46:41 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/headscale_ynh/tree/testing --debug
ou
sudo yunohost app upgrade headscale -u https://github.com/YunoHost-Apps/headscale_ynh/tree/testing --debug
```
2024-03-29 07:06:23 +01:00
**Plus d’ infos sur le packaging d’ applications :** < https: / / yunohost . org / packaging_apps >