diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..c380634 --- /dev/null +++ b/doc/DISCLAIMER.md @@ -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 +``` + diff --git a/doc/DISCLAIMER_fr.md b/doc/DISCLAIMER_fr.md new file mode 100644 index 0000000..77bd45e --- /dev/null +++ b/doc/DISCLAIMER_fr.md @@ -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 +``` + diff --git a/doc/screenshots/screenshot.png b/doc/screenshots/screenshot.png new file mode 100644 index 0000000..21c3545 Binary files /dev/null and b/doc/screenshots/screenshot.png differ diff --git a/doc/screenshots/screenshot.png:Zone.Identifier b/doc/screenshots/screenshot.png:Zone.Identifier new file mode 100644 index 0000000..5ff913c --- /dev/null +++ b/doc/screenshots/screenshot.png:Zone.Identifier @@ -0,0 +1,3 @@ +[ZoneTransfer] +ZoneId=3 +HostUrl=https://user-images.githubusercontent.com/6447444/80270680-76adf980-86e4-11ea-8ca1-9237f0dfa249.png diff --git a/manifest.json b/manifest.json index 94aef18..4d0c395 100644 --- a/manifest.json +++ b/manifest.json @@ -3,11 +3,16 @@ "id": "wireguard", "packaging_format": 1, "description": { - "en": "Virtual Private Networks (VPN) via WireGuard, with a web UI", - "fr": "Réseaux Privés Virtuels (VPN) via WireGuard, avec une 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 pour faciliter sa configuration" }, "version": "0.2.7~ynh4", "url": "https://github.com/ngoduykhanh/wireguard-ui", + "upstream": { + "license": "MIT", + "website": "https://www.wireguard.com/", + "code": "https://github.com/ngoduykhanh/wireguard-ui" + }, "license": "MIT", "maintainer": { "name": "tituspijean",