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.
200 commits 3 branches 0 tags 575 KiB
Shell 100%
Find a file
Éric Gaspar b32431cc82
v2
2023-06-17 22:11:01 +02:00
.github [autopatch] Upgrade auto-updater 2023-06-17 22:11:00 +02:00
conf v2 2023-06-17 22:11:01 +02:00
doc Add disclaimer about non working Status page 2021-12-30 17:09:12 +01:00
scripts v2 2023-06-17 22:11:01 +02:00
.gitignore Initial commit 2020-10-11 14:45:13 +02:00
check_process Yolo attempt to fix the commit to test upgrade from ... 2023-03-07 20:43:14 +01:00
LICENSE Initial commit 2020-10-11 14:45:13 +02:00
manifest.json Upgrade to v0.5.0 2023-06-17 22:11:01 +02:00
manifest.toml v2 2023-06-17 22:11:01 +02:00
README.md Auto-update README 2023-06-17 22:11:01 +02:00
README_fr.md Auto-update README 2023-06-17 22:11:01 +02:00

README.md

WireGuard for YunoHost

Integration level Working status Maintenance status

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.5.0~ynh1

Screenshots

Screenshot of WireGuard Screenshot of WireGuard

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.
    • Do not manually alter the configuration files.
  • 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.
  • Status page is not working for the time being.

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

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