1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/wireguard_ynh.git synced 2024-09-03 20:35:58 +02:00
wireguard_ynh/README.md
2021-12-26 11:17:30 +00:00

2.8 KiB

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

WireGuard® is fast and modern VPN that utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner, and more useful than IPsec. It intends to be considerably more performant than OpenVPN. WireGuard is designed as a general purpose VPN.

Shipped version: 0.3.2~ynh1

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.

After installation, you need to Apply Config once in the UI before the VPN service can be started.

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

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