# WireGuard for YunoHost [![Integration level](https://dash.yunohost.org/integration/wireguard.svg)](https://dash.yunohost.org/appci/app/wireguard) ![Working status](https://ci-apps.yunohost.org/ci/badges/wireguard.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/wireguard.maintain.svg) [![Install WireGuard with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=wireguard) *[Lire ce readme en français.](./README_fr.md)* > *This package allows you to install WireGuard quickly and simply on a YunoHost server. If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) 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](./doc/screenshots/screenshot.png) ![Screenshot of WireGuard](./doc/screenshots/screenshot.png:Zone.Identifier) ## 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 * Official app website: * Upstream app code repository: * YunoHost documentation for this app: * Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/wireguard_ynh/tree/testing). To try the testing branch, please proceed like that. ``` bash 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:**