wireguard_ynh/README.md

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->

# 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.2~ynh1

## Screenshots

![Screenshot of WireGuard](./doc/screenshots/screenshot.png)

## Documentation and resources

* Official app website: <https://www.wireguard.com/>
* Upstream app code repository: <https://github.com/ngoduykhanh/wireguard-ui>
* YunoHost documentation for this app: <https://yunohost.org/app_wireguard>
* Report a bug: <https://github.com/YunoHost-Apps/wireguard_ynh/issues>

## 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:** <https://yunohost.org/packaging_apps>
Auto-update README 2021-06-03 22:02:40 +02:00			`<!--`
			`N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator`
			`It shall NOT be edited by hand.`
			`-->`

Initial commit 2020-10-11 14:45:13 +02:00			`# WireGuard for YunoHost`

Auto-update README 2023-01-29 08:17:44 +01:00			`[![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)`
Auto-update README 2023-03-07 20:43:17 +01:00
Set SVG badge 2020-12-27 12:02:17 +01:00			`[![Install WireGuard with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=wireguard)`
Initial commit 2020-10-11 14:45:13 +02:00
			`[Lire ce readme en français.](./README_fr.md)`

Auto-update README 2021-06-03 22:02:40 +02:00			`> *This package allows you to install WireGuard quickly and simply on a YunoHost server.`
Initial commit 2020-10-11 14:45:13 +02:00			`If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*`

			`## Overview`

Auto-update README 2021-12-09 12:31:08 +01:00			`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.`
Auto-update README 2021-06-03 22:02:40 +02:00
Auto-update README 2023-08-17 08:51:48 +02:00			`Shipped version: 0.5.2~ynh1`
Auto-update README 2021-06-03 22:02:40 +02:00
Initial commit 2020-10-11 14:45:13 +02:00			`## Screenshots`

Bullseye: drop linux headers requirements (#41) Co-authored-by: yunohost-bot <yunohost@yunohost.org> 2022-08-15 17:12:27 +02:00			`![Screenshot of WireGuard](./doc/screenshots/screenshot.png)`
Initial commit 2020-10-11 14:45:13 +02:00
Auto-update README 2021-06-03 22:02:40 +02:00			`## Documentation and resources`
Initial commit 2020-10-11 14:45:13 +02:00
Bullseye: drop linux headers requirements (#41) Co-authored-by: yunohost-bot <yunohost@yunohost.org> 2022-08-15 17:12:27 +02:00			`* Official app website: <https://www.wireguard.com/>`
			`* Upstream app code repository: <https://github.com/ngoduykhanh/wireguard-ui>`
			`* YunoHost documentation for this app: <https://yunohost.org/app_wireguard>`
			`* Report a bug: <https://github.com/YunoHost-Apps/wireguard_ynh/issues>`
Initial commit 2020-10-11 14:45:13 +02:00
Auto-update README 2021-06-03 22:02:40 +02:00			`## Developer info`
Initial commit 2020-10-11 14:45:13 +02:00
			`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.`
Bullseye: drop linux headers requirements (#41) Co-authored-by: yunohost-bot <yunohost@yunohost.org> 2022-08-15 17:12:27 +02:00
			``` bash
Initial commit 2020-10-11 14:45:13 +02:00			`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`
			```
Auto-update README 2021-06-03 22:02:40 +02:00
Bullseye: drop linux headers requirements (#41) Co-authored-by: yunohost-bot <yunohost@yunohost.org> 2022-08-15 17:12:27 +02:00			`More info regarding app packaging: <https://yunohost.org/packaging_apps>`