mirror of
https://github.com/YunoHost-Apps/wireguard_ynh.git
synced 2024-09-03 20:35:58 +02:00
Auto-update README
This commit is contained in:
Yunohost-Bot
Yunohost-Bot
parent
790c083edf
commit
7675c5ea91
2 changed files with 61 additions and 92 deletions
70
README.md
70
README.md
|
|
@ -1,3 +1,8 @@
|
|||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
# WireGuard for YunoHost
|
||||
|
||||
[](https://dash.yunohost.org/appci/app/wireguard)  
|
||||
|
|
@ -5,25 +10,30 @@
|
|||
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
:warning: This app is still experimental. Check its compatibility before running it on a production system. :warning:
|
||||
|
||||
:exclamation: WireGuard for YunoHost will add a DMKS module to your Linux kernel.
|
||||
|
||||
> *This package allows you to install WireGuard quickly and simply on a YunoHost server.
|
||||
> *This package allows you to install WireGuard 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
|
||||
This app installs WireGuard, a software to create and manage virtual private networks (VPN), along with WireGuard UI to avoid having to use the command line to manage them.
|
||||
|
||||
**Shipped version of the web UI:** 0.2.7
|
||||
Virtual Private Networks (VPN) via WireGuard, with a web UI to ease configuration
|
||||
|
||||
**Shipped version:** 0.2.7~ynh4
|
||||
|
||||
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Configuration
|
||||
## Disclaimers / important information
|
||||
|
||||
WireGuard can be configured via a non-official web UI. Avoid altering the configuration files via the command line interface, though.
|
||||
* WireGuard for YunoHost will add a DMKS module to your Linux kernel.
|
||||
* You may need to reboot your server for WireGuard to be able to start.
|
||||
* The package includes WireGuard and non-official web UI to configure it.
|
||||
* Avoid altering the configuration files via the command line interface, though.
|
||||
* Use YunoHost permissions panel to allow users to access the web UI.
|
||||
* Only one network interface, *wg0*, can be managed with this app at the moment.
|
||||
|
||||
### Make your server share its Internet connection
|
||||
|
||||
|
|
@ -50,42 +60,16 @@ iptables -A FORWARD -i %i -j ACCEPT; iptables -A FORWARD -o %i -j ACCEPT; iptabl
|
|||
iptables -D FORWARD -i %i -j ACCEPT; iptables -D FORWARD -o %i -j ACCEPT; iptables -t nat -D POSTROUTING -o eth0 -j MASQUERADE
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
* Official documentation: https://www.wireguard.com/quickstart/
|
||||
<!-- * YunoHost documentation: -->
|
||||
## Documentation and resources
|
||||
|
||||
## YunoHost specific features
|
||||
* Official app website: https://www.wireguard.com/
|
||||
* Upstream app code repository: https://github.com/ngoduykhanh/wireguard-ui
|
||||
* YunoHost documentation for this app: https://yunohost.org/app_wireguard
|
||||
* Report a bug: https://github.com/YunoHost-Apps/wireguard_ynh/issues
|
||||
|
||||
#### Multi-user support
|
||||
## Developer info
|
||||
|
||||
* Are LDAP and HTTP auth supported? No, use YunoHost permissions panel to allow users to access the web UI.
|
||||
* Can the app be used by multiple users? Yes, but any user allowed to access the web UI will be able to alter the VPN settings and access the clients credentials.
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/wireguard/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/wireguard/)
|
||||
|
||||
## Limitations
|
||||
|
||||
* :construction: The web UI can only be installed at the root of a domain.
|
||||
* :construction: Only one network interface, *wg0* can be managed with this app.
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/wireguard_ynh/issues
|
||||
* App website: https://www.wireguard.com
|
||||
* Upstream app repository: https://www.wireguard.com/repositories
|
||||
* Upstream web UI repository: https://github.com/ngoduykhanh/wireguard-ui
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
|
||||
Developer info
|
||||
----------------
|
||||
|
||||
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
||||
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/wireguard_ynh/tree/testing).
|
||||
|
||||
To try the testing branch, please proceed like that.
|
||||
|
|
@ -94,3 +78,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/wireguard_ynh/tree/te
|
|||
or
|
||||
sudo yunohost app upgrade wireguard -u https://github.com/YunoHost-Apps/wireguard_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
||||
83
README_fr.md
83
README_fr.md
|
|
@ -3,41 +3,48 @@
|
|||
[](https://dash.yunohost.org/appci/app/wireguard)  
|
||||
[](https://install-app.yunohost.org/?app=wireguard)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
:warning: Cette app est encore expérimentale. Vérifiez sa compatibilté avant de lancer l'installation sur un serveur de production. :warning:
|
||||
|
||||
:exclamation: WireGuard pour YunoHost ajoutera un module DKMS à votre noyau Linux.
|
||||
|
||||
> *Ce package vous permet d'installer WireGuard rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.*
|
||||
> *Ce package vous permet d'installer WireGuard 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.*
|
||||
|
||||
## Vue d'ensemble
|
||||
Cette application installe WireGuard, logiciel permettant de créer des réseaux privés virtuels (VPN), accompagné de WireGuard UI pour éviter de les configurer par la ligne de commande.
|
||||
|
||||
**Version de la web UI incluse :** 0.2.7
|
||||
Réseaux Privés Virtuels (VPN) via WireGuard, avec une web UI pour faciliter sa configuration
|
||||
|
||||
## Capture d'écran
|
||||
**Version incluse :** 0.2.7~ynh4
|
||||
|
||||
|
||||
|
||||
## Configuration
|
||||
|
||||
WireGuard est configurable via une web UI non-officielle. Évitez de toucher aux fichiers de configuration via la ligne de commande.
|
||||
## Captures d'écran
|
||||
|
||||
### Partager la connexion Internet de votre serveur
|
||||
|
||||
|
||||
|
||||
#### Activer le *port forwarding*
|
||||
## Avertissements / informations importantes
|
||||
|
||||
* Cette application ajoutera un module DMKS à votre noyau Linux.
|
||||
* Vous devriez redémarrer votre serveur pour que WireGuard puisse se lancer.
|
||||
* Cette application inclut WireGuard et une interface web non-officielle pour le configurer.
|
||||
* Évitez de modifier les fichiers de configuration via la ligne de commande.
|
||||
* Utiliser le panneau de permissions de YunoHost pour autoriser des utilisateurs à accéder à WireGuard UI.
|
||||
* Une seule interface réseau, *wg0*, peut actuellement être gérée par cette app.
|
||||
|
||||
### Partagez votre connexion Internet via WireGuard
|
||||
|
||||
#### Activez le *port forwarding*
|
||||
|
||||
```bash
|
||||
sudo nano /etc/sysctl.conf
|
||||
# It should have an uncommented line:
|
||||
# Décommentez les lignes suivantes :
|
||||
net.ipv4.ip_forward = 1
|
||||
# Save and quit (CTRL+O, CTRL+X)
|
||||
net.ipv6.conf.all.forwarding = 1
|
||||
# Sauvegardez et quittez (CTRL+O, CTRL+X)
|
||||
sudo sysctl -p
|
||||
```
|
||||
|
||||
Ajoutez les commandes suivantes dans le menu `WireGuard Server`. Remplacez `eth0` par l'interface connectée à l'Internet.
|
||||
Ajoutez les commandes suivantes dans le menu `WireGuard Server`. Remplacez `eth0` avec l'interface connectée à Internet :
|
||||
|
||||
#### Post Up Script
|
||||
```
|
||||
|
|
@ -49,42 +56,16 @@ iptables -A FORWARD -i %i -j ACCEPT; iptables -A FORWARD -o %i -j ACCEPT; iptabl
|
|||
iptables -D FORWARD -i %i -j ACCEPT; iptables -D FORWARD -o %i -j ACCEPT; iptables -t nat -D POSTROUTING -o eth0 -j MASQUERADE
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
* Documentation officielle : https://www.wireguard.com/quickstart/
|
||||
<!-- * Documentation YunoHost : -->
|
||||
## Documentations et ressources
|
||||
|
||||
## Caractéristiques spécifiques YunoHost
|
||||
* Site officiel de l'app : https://www.wireguard.com/
|
||||
* Dépôt de code officiel de l'app : https://github.com/ngoduykhanh/wireguard-ui
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_wireguard
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/wireguard_ynh/issues
|
||||
|
||||
#### Support multi-utilisateur
|
||||
## Informations pour les développeurs
|
||||
|
||||
* L'authentification LDAP et HTTP est-elle prise en charge ? Non, utilisez le système de permissions de YunoHost pour permettre à vos utilisateurs d'utiliser la web UI.
|
||||
* L'application peut-elle être utilisée par plusieurs utilisateurs ? Oui, mais tout utilisateur aura la main sur la configuration du VPN et les identifiants de ses clients.
|
||||
|
||||
#### Architectures supportées
|
||||
|
||||
* x86-64 - [](https://ci-apps.yunohost.org/ci/apps/wireguard/)
|
||||
* ARMv8-A - [](https://ci-apps-arm.yunohost.org/ci/apps/wireguard/)
|
||||
|
||||
## Limitations
|
||||
|
||||
* :construction: La web UI ne peut être installée qu'à la racine d'un domaine.
|
||||
* :construction: Seulement une seule interface réseau, *wg0*, peut être gérée par l'application.
|
||||
|
||||
## Liens
|
||||
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/wireguard_ynh/issues
|
||||
* Site de l'application : https://www.wireguard.com
|
||||
* Dépôt de l'application principale : https://www.wireguard.com/repositories
|
||||
* Dépôt de la web UI : https://github.com/ngoduykhanh/wireguard-ui
|
||||
* Site web YunoHost : https://yunohost.org/
|
||||
|
||||
---
|
||||
|
||||
Informations pour les développeurs
|
||||
----------------
|
||||
|
||||
**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.**
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/wireguard_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
|
|
@ -93,3 +74,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/wireguard_ynh/tree/te
|
|||
ou
|
||||
sudo yunohost app upgrade wireguard -u https://github.com/YunoHost-Apps/wireguard_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps
|
||||
Loading…
Add table
Reference in a new issue