YunoHost-Apps/headscale_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/headscale_ynh.git synced 2024-09-03 19:25:53 +02:00
Code Issues Activity Actions

Auto-update README

Browse source
This commit is contained in:
yunohost-bot 2024-03-29 07:06:23 +01:00
parent 146da8a8e9
commit 3d8343cf9d
5 changed files with 221 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ALL_README.md Normal file
View file

@ -0,0 +1,6 @@
# All available README files by language
- [Read the README in English](README.md)
- [Lire le README en français](README_fr.md)
- [Le o README en galego](README_gl.md)
- [Leggi il “README” in italiano](README_it.md)

24
README.md
View file

@ -1,5 +1,5 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator 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. It shall NOT be edited by hand.
--> -->
@ -9,10 +9,10 @@ It shall NOT be edited by hand.
[![Install Headscale with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=headscale) [![Install Headscale with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=headscale)
*[Lire ce readme en français.](./README_fr.md)* *[Read this README is other languages.](./ALL_README.md)*
> *This package allows you to install Headscale quickly and simply on a YunoHost server. > *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.* > *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
## Overview ## Overview
@ -71,18 +71,18 @@ open-source organisation.
**Shipped version:** 0.22.3~ynh1 **Shipped version:** 0.22.3~ynh1
## Documentation and resources ## Documentation and resources
* Official app website: <https://headscale.net/> - Official app website: <https://headscale.net/>
* Official user documentation: <https://tailscale.com/kb/> - Official user documentation: <https://tailscale.com/kb/>
* Official admin documentation: <https://headscale.net/> - Official admin documentation: <https://headscale.net/>
* Upstream app code repository: <https://github.com/juanfont/headscale> - Upstream app code repository: <https://github.com/juanfont/headscale>
* YunoHost Store: <https://apps.yunohost.org/app/headscale> - YunoHost Store: <https://apps.yunohost.org/app/headscale>
* Report a bug: <https://github.com/YunoHost-Apps/headscale_ynh/issues> - Report a bug: <https://github.com/YunoHost-Apps/headscale_ynh/issues>
## Developer info ## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/headscale_ynh/tree/testing). 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. To try the `testing` branch, please proceed like that:
```bash ```bash
sudo yunohost app install https://github.com/YunoHost-Apps/headscale_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/headscale_ynh/tree/testing --debug

30
README_fr.md
View file

@ -1,6 +1,6 @@
<!-- <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator Nota bene : ce README est automatiquement généré par <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
It shall NOT be edited by hand. Il NE doit PAS être modifié à la main.
--> -->
# Headscale pour YunoHost # Headscale pour YunoHost
@ -9,10 +9,10 @@ It shall NOT be edited by hand.
[![Installer Headscale avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=headscale) [![Installer Headscale avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=headscale)
*[Read this readme in english.](./README.md)* *[Lire le README dans d'autres langues.](./ALL_README.md)*
> *Ce package vous permet d’installer Headscale rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d’installer Headscale rapidement et simplement sur un serveur YunoHost.*
Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.* > *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.*
## Vue d’ensemble ## Vue d’ensemble
@ -68,21 +68,21 @@ open-source organisation.
*from Headscale's README. See Links section below.* *from Headscale's README. See Links section below.*
**Version incluse :** 0.22.3~ynh1 **Version incluse :** 0.22.3~ynh1
## Documentations et ressources ## Documentations et ressources
* Site officiel de l’app : <https://headscale.net/> - Site officiel de l’app : <https://headscale.net/>
* Documentation officielle utilisateur : <https://tailscale.com/kb/> - Documentation officielle utilisateur : <https://tailscale.com/kb/>
* Documentation officielle de l’admin : <https://headscale.net/> - Documentation officielle de l’admin : <https://headscale.net/>
* Dépôt de code officiel de l’app : <https://github.com/juanfont/headscale> - Dépôt de code officiel de l’app : <https://github.com/juanfont/headscale>
* YunoHost Store: <https://apps.yunohost.org/app/headscale> - YunoHost Store : <https://apps.yunohost.org/app/headscale>
* Signaler un bug : <https://github.com/YunoHost-Apps/headscale_ynh/issues> - Signaler un bug : <https://github.com/YunoHost-Apps/headscale_ynh/issues>
## Informations pour les développeurs ## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/headscale_ynh/tree/testing). Merci de faire vos pull request sur la [branche `testing`](https://github.com/YunoHost-Apps/headscale_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit. Pour essayer la branche `testing`, procédez comme suit :
```bash ```bash
sudo yunohost app install https://github.com/YunoHost-Apps/headscale_ynh/tree/testing --debug sudo yunohost app install https://github.com/YunoHost-Apps/headscale_ynh/tree/testing --debug
@ -90,4 +90,4 @@ ou
sudo yunohost app upgrade headscale -u https://github.com/YunoHost-Apps/headscale_ynh/tree/testing --debug sudo yunohost app upgrade headscale -u https://github.com/YunoHost-Apps/headscale_ynh/tree/testing --debug
``` ```
**Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps> **Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>

93
README_gl.md Normal file
View file

@ -0,0 +1,93 @@
<!--
NOTA: Este README foi creado automáticamente por <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
NON debe editarse manualmente.
-->
# Headscale para YunoHost
[![Nivel de integración](https://dash.yunohost.org/integration/headscale.svg)](https://dash.yunohost.org/appci/app/headscale) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/headscale.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/headscale.maintain.svg)
[![Instalar Headscale con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=headscale)
*[Le este README en outros idiomas.](./ALL_README.md)*
> *Este paquete permíteche instalar Headscale de xeito rápido e doado nun servidor YunoHost.*
> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.*
## Vista xeral
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.*
**Versión proporcionada:** 0.22.3~ynh1
## Documentación e recursos
- Web oficial da app: <https://headscale.net/>
- Documentación oficial para usuarias: <https://tailscale.com/kb/>
- Documentación oficial para admin: <https://headscale.net/>
- Repositorio de orixe do código: <https://github.com/juanfont/headscale>
- Tenda YunoHost: <https://apps.yunohost.org/app/headscale>
- Informar dun problema: <https://github.com/YunoHost-Apps/headscale_ynh/issues>
## Info de desenvolvemento
Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/headscale_ynh/tree/testing).
Para probar a rama `testing`, procede deste xeito:
```bash
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
```
**Máis info sobre o empaquetado da app:** <https://yunohost.org/packaging_apps>

93
README_it.md Normal file
View file

@ -0,0 +1,93 @@
<!--
N.B.: Questo README è stato automaticamente generato da <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
NON DEVE essere modificato manualmente.
-->
# Headscale per YunoHost
[![Livello di integrazione](https://dash.yunohost.org/integration/headscale.svg)](https://dash.yunohost.org/appci/app/headscale) ![Stato di funzionamento](https://ci-apps.yunohost.org/ci/badges/headscale.status.svg) ![Stato di manutenzione](https://ci-apps.yunohost.org/ci/badges/headscale.maintain.svg)
[![Installa Headscale con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=headscale)
*[Leggi questo README in altre lingue.](./ALL_README.md)*
> *Questo pacchetto ti permette di installare Headscale su un server YunoHost in modo semplice e veloce.*
> *Se non hai YunoHost, consulta [la guida](https://yunohost.org/install) per imparare a installarlo.*
## Panoramica
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.*
**Versione pubblicata:** 0.22.3~ynh1
## Documentazione e risorse
- Sito web ufficiale dell’app: <https://headscale.net/>
- Documentazione ufficiale per gli utenti: <https://tailscale.com/kb/>
- Documentazione ufficiale per gli amministratori: <https://headscale.net/>
- Repository upstream del codice dell’app: <https://github.com/juanfont/headscale>
- Store di YunoHost: <https://apps.yunohost.org/app/headscale>
- Segnala un problema: <https://github.com/YunoHost-Apps/headscale_ynh/issues>
## Informazioni per sviluppatori
Si prega di inviare la tua pull request alla [branch di `testing`](https://github.com/YunoHost-Apps/headscale_ynh/tree/testing).
Per provare la branch di `testing`, si prega di procedere in questo modo:
```bash
sudo yunohost app install https://github.com/YunoHost-Apps/headscale_ynh/tree/testing --debug
o
sudo yunohost app upgrade headscale -u https://github.com/YunoHost-Apps/headscale_ynh/tree/testing --debug
```
**Maggiori informazioni riguardo il pacchetto di quest’app:** <https://yunohost.org/packaging_apps>