YunoHost-Apps/wireguard_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/wireguard_ynh.git synced 2024-09-03 20:35:58 +02:00
Code Issues Activity Actions
WireGuard VPN software with a web UI configuration companion, packaged for YunoHost.
99 commits 3 branches 0 tags 575 KiB
Shell 100%
Find a file
Yunohost-Bot a5d62c18e6 Auto-update README
2021-07-04 21:47:10 +00:00
.github [autopatch] Update issue and PR templates 2021-05-13 22:58:36 +02:00
conf Sudo is needed for restarting the interface 2021-07-04 23:44:05 +02:00
doc Update DISCLAIMERs 2021-07-04 23:46:46 +02:00
scripts Fix backup and restore of /etc/wireguard 2021-07-04 21:48:27 +02:00
.gitignore Initial commit 2020-10-11 14:45:13 +02:00
check_process Remove is_public argument 2021-01-21 19:55:16 +01:00
LICENSE Initial commit 2020-10-11 14:45:13 +02:00
manifest.json Bump package version 2021-07-04 23:44:40 +02:00
README.md Auto-update README 2021-07-04 21:47:10 +00:00
README_fr.md Auto-update README 2021-07-04 21:47:10 +00:00

README.md

WireGuard for YunoHost

Integration level
Install WireGuard with YunoHost

Lire ce readme en français.

This package allows you to install WireGuard quickly and simply on a YunoHost server. If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

Virtual Private Networks (VPN) via WireGuard, with a web UI to ease configuration

Shipped version: 0.2.7~ynh8

Screenshots

Disclaimers / important information

  • 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

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, like in this picture. 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

Documentation and resources

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that.

sudo yunohost app install https://github.com/YunoHost-Apps/wireguard_ynh/tree/testing --debug
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