mirror of
https://github.com/YunoHost-Apps/wireguard_ynh.git
synced 2024-09-03 20:35:58 +02:00
Use README generator
This commit is contained in:
parent
7bf562723d
commit
790c083edf
5 changed files with 74 additions and 2 deletions
32
doc/DISCLAIMER.md
Normal file
32
doc/DISCLAIMER.md
Normal file
|
@ -0,0 +1,32 @@
|
||||||
|
* 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
|
||||||
|
|
||||||
|
#### Enable port forwarding
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo nano /etc/sysctl.conf
|
||||||
|
# Uncomment the following lines:
|
||||||
|
net.ipv4.ip_forward = 1
|
||||||
|
net.ipv6.conf.all.forwarding = 1
|
||||||
|
# Save and quit (CTRL+O, CTRL+X)
|
||||||
|
sudo sysctl -p
|
||||||
|
```
|
||||||
|
|
||||||
|
Add the following commands in `WireGuard Server` menu. Replace `eth0` with the interface connected to the Internet:
|
||||||
|
|
||||||
|
#### Post Up Script
|
||||||
|
```
|
||||||
|
iptables -A FORWARD -i %i -j ACCEPT; iptables -A FORWARD -o %i -j ACCEPT; iptables -t nat -A POSTROUTING -o eth0 -j MASQUERADE
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Post Down Script
|
||||||
|
```
|
||||||
|
iptables -D FORWARD -i %i -j ACCEPT; iptables -D FORWARD -o %i -j ACCEPT; iptables -t nat -D POSTROUTING -o eth0 -j MASQUERADE
|
||||||
|
```
|
||||||
|
|
32
doc/DISCLAIMER_fr.md
Normal file
32
doc/DISCLAIMER_fr.md
Normal file
|
@ -0,0 +1,32 @@
|
||||||
|
* 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
|
||||||
|
# Décommentez les lignes suivantes :
|
||||||
|
net.ipv4.ip_forward = 1
|
||||||
|
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` avec l'interface connectée à Internet :
|
||||||
|
|
||||||
|
#### Post Up Script
|
||||||
|
```
|
||||||
|
iptables -A FORWARD -i %i -j ACCEPT; iptables -A FORWARD -o %i -j ACCEPT; iptables -t nat -A POSTROUTING -o eth0 -j MASQUERADE
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Post Down Script
|
||||||
|
```
|
||||||
|
iptables -D FORWARD -i %i -j ACCEPT; iptables -D FORWARD -o %i -j ACCEPT; iptables -t nat -D POSTROUTING -o eth0 -j MASQUERADE
|
||||||
|
```
|
||||||
|
|
BIN
doc/screenshots/screenshot.png
Normal file
BIN
doc/screenshots/screenshot.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 193 KiB |
3
doc/screenshots/screenshot.png:Zone.Identifier
Normal file
3
doc/screenshots/screenshot.png:Zone.Identifier
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
[ZoneTransfer]
|
||||||
|
ZoneId=3
|
||||||
|
HostUrl=https://user-images.githubusercontent.com/6447444/80270680-76adf980-86e4-11ea-8ca1-9237f0dfa249.png
|
|
@ -3,11 +3,16 @@
|
||||||
"id": "wireguard",
|
"id": "wireguard",
|
||||||
"packaging_format": 1,
|
"packaging_format": 1,
|
||||||
"description": {
|
"description": {
|
||||||
"en": "Virtual Private Networks (VPN) via WireGuard, with a web UI",
|
"en": "Virtual Private Networks (VPN) via WireGuard, with a web UI to ease configuration",
|
||||||
"fr": "Réseaux Privés Virtuels (VPN) via WireGuard, avec une web UI"
|
"fr": "Réseaux Privés Virtuels (VPN) via WireGuard, avec une web UI pour faciliter sa configuration"
|
||||||
},
|
},
|
||||||
"version": "0.2.7~ynh4",
|
"version": "0.2.7~ynh4",
|
||||||
"url": "https://github.com/ngoduykhanh/wireguard-ui",
|
"url": "https://github.com/ngoduykhanh/wireguard-ui",
|
||||||
|
"upstream": {
|
||||||
|
"license": "MIT",
|
||||||
|
"website": "https://www.wireguard.com/",
|
||||||
|
"code": "https://github.com/ngoduykhanh/wireguard-ui"
|
||||||
|
},
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"maintainer": {
|
"maintainer": {
|
||||||
"name": "tituspijean",
|
"name": "tituspijean",
|
||||||
|
|
Loading…
Reference in a new issue