diff --git a/README.md b/README.md index ceb2b5af..c4c14bd1 100644 --- a/README.md +++ b/README.md @@ -536,6 +536,20 @@ Fully featured VSCode experience, to edit your HA config in the browser, includi [:books: Visual Studio Code add-on documentation][addon-doc-vscode] +### ✓ [WireGuard][addon-wireguard] + +![Latest Version][wireguard-version-shield] +![Supports armhf Architecture][wireguard-armhf-shield] +![Supports armv7 Architecture][wireguard-armv7-shield] +![Supports aarch64 Architecture][wireguard-aarch64-shield] +![Supports amd64 Architecture][wireguard-amd64-shield] +![Supports i386 Architecture][wireguard-i386-shield] +![Docker Pulls][wireguard-pulls-shield] + +Fast, modern, secure VPN tunnel + +[:books: WireGuard add-on documentation][addon-doc-wireguard] + ### ✓ [Z-Wave to MQTT][addon-zwave2mqtt] ![Latest Version][zwave2mqtt-version-shield] @@ -653,6 +667,7 @@ on the correct GitHub repository matching the add-on. - [Open an issue for the add-on: Traccar][traccar-issue] - [Open an issue for the add-on: UniFi Controller][unifi-issue] - [Open an issue for the add-on: Visual Studio Code][vscode-issue] +- [Open an issue for the add-on: WireGuard][wireguard-issue] - [Open an issue for the add-on: Z-Wave to MQTT][zwave2mqtt-issue] - [Open an issue for the add-on: ZeroTier One][zerotier-issue] - [Open an issue for the add-on: chrony][chrony-issue] @@ -1066,6 +1081,16 @@ SOFTWARE. [vscode-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg [vscode-armv7-shield]: https://img.shields.io/badge/armv7-no-red.svg [vscode-i386-shield]: https://img.shields.io/badge/i386-no-red.svg +[addon-wireguard]: https://github.com/hassio-addons/addon-wireguard/tree/v0.1.0 +[addon-doc-wireguard]: https://github.com/hassio-addons/addon-wireguard/blob/v0.1.0/README.md +[wireguard-issue]: https://github.com/hassio-addons/addon-wireguard/issues +[wireguard-version-shield]: https://img.shields.io/badge/version-v0.1.0-blue.svg +[wireguard-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/wireguard-armhf.svg +[wireguard-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[wireguard-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[wireguard-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[wireguard-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg +[wireguard-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [addon-zwave2mqtt]: https://github.com/hassio-addons/addon-zwave2mqtt/tree/v0.3.3 [addon-doc-zwave2mqtt]: https://github.com/hassio-addons/addon-zwave2mqtt/blob/v0.3.3/README.md [zwave2mqtt-issue]: https://github.com/hassio-addons/addon-zwave2mqtt/issues diff --git a/wireguard/CHANGELOG.md b/wireguard/CHANGELOG.md new file mode 100644 index 00000000..7d8a41b2 --- /dev/null +++ b/wireguard/CHANGELOG.md @@ -0,0 +1,4 @@ +🎉 Initial add-on release! + +Questions? Join our Discord server! https://discord.me/hassioaddons +Enjoying my add-ons? Consider supporting my work: https://patreon.com/frenck \ No newline at end of file diff --git a/wireguard/README.md b/wireguard/README.md new file mode 100644 index 00000000..a0245522 --- /dev/null +++ b/wireguard/README.md @@ -0,0 +1,46 @@ +# Community Hass.io Add-ons: WireGuard + +[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] + +[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum] + +[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee] + +[![Support my work on Patreon][patreon-shield]][patreon] + +WireGuard: fast, modern, secure VPN tunnel. + +## About + +[WireGuard®][wireguard] is an extremely simple yet fast and modern VPN that +utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner, +and more useful than IPsec, while avoiding the massive headache. + +It intends to be considerably more performant than OpenVPN. WireGuard is +designed as a general-purpose VPN for running on embedded interfaces and +supercomputers alike, fit for many different circumstances. + +Initially released for the Linux kernel, it is now cross-platform (Windows, +macOS, BSD, iOS, Android) and widely deployable, +including via an Hass.io add-on! + +WireGuard is currently under heavy development, but already it might be +regarded as the most secure, easiest to use, and the simplest VPN solution +in the industry. + +[Click here for the full documentation][docs] + +[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg +[buymeacoffee]: https://www.buymeacoffee.com/frenck +[discord-shield]: https://img.shields.io/discord/478094546522079232.svg +[discord]: https://discord.me/hassioaddons +[docs]: https://github.com/hassio-addons/addon-wireguard/blob/v0.1.0/README.md +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg +[forum]: https://community.home-assistant.io/t/community-hass-io-add-on-wireguard/134662?u=frenck +[maintenance-shield]: https://img.shields.io/maintenance/yes/2019.svg +[patreon-shield]: https://www.frenck.nl/images/patreon.png +[patreon]: https://www.patreon.com/frenck +[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg +[release-shield]: https://img.shields.io/badge/version-v0.1.0-blue.svg +[release]: https://github.com/hassio-addons/addon-wireguard/tree/v0.1.0 +[wireguard]: https://www.wireguard.com \ No newline at end of file diff --git a/wireguard/config.json b/wireguard/config.json new file mode 100644 index 00000000..c8865b89 --- /dev/null +++ b/wireguard/config.json @@ -0,0 +1,98 @@ +{ + "name": "WireGuard", + "version": "0.1.0", + "slug": "wireguard", + "description": "Fast, modern, secure VPN tunnel", + "url": "https://github.com/hassio-addons/addon-wireguard", + "startup": "application", + "arch": [ + "aarch64", + "amd64", + "armhf", + "armv7", + "i386" + ], + "ports": { + "80/tcp": null, + "51820/udp": 51820 + }, + "ports_description": { + "80/tcp": "WireGuard peers status API", + "51820/udp": "WireGuard: forward this port in your router" + }, + "boot": "auto", + "hassio_api": true, + "hassio_role": "default", + "privileged": [ + "NET_ADMIN" + ], + "devices": [ + "/dev/net/tun:/dev/net/tun:rwm" + ], + "map": [ + "config", + "ssl:rw" + ], + "options": { + "server": { + "host": "myautomatedhome.duckdns.org", + "addresses": [ + "172.244.66.1" + ], + "dns": [] + }, + "peers": [ + { + "name": "hassio", + "addresses": [ + "172.244.66.2" + ], + "allowed_ips": [], + "client_allowed_ips": [] + } + ] + }, + "schema": { + "log_level": "match(^(trace|debug|info|notice|warning|error|fatal)$)?", + "server": { + "host": "str", + "interface": "match(^wg([0-9])+$)?", + "addresses": [ + "str" + ], + "dns": [ + "str" + ], + "private_key": "str?", + "public_key": "str?", + "fwmark": "str?", + "table": "str?", + "pre_up": "str?", + "pre_down": "str?", + "post_up": "str?", + "post_down": "str?", + "mtu": "int?" + }, + "peers": [ + { + "name": "match(^[a-zA-Z0-9\\d](?:[a-zA-Z0-9\\d]|-(?=[a-zA-Z0-9\\d])){0,32}$)", + "private_key": "str?", + "public_key": "str?", + "addresses": [ + "str" + ], + "allowed_ips": [ + "str" + ], + "client_allowed_ips": [ + "str" + ], + "persistent_keep_alive": "int?", + "endpoint": "str?", + "pre_shared_key": "str?", + "fwmark": "str?" + } + ] + }, + "image": "hassioaddons/wireguard-{arch}" +} \ No newline at end of file diff --git a/wireguard/icon.png b/wireguard/icon.png new file mode 100644 index 00000000..feec0ef3 Binary files /dev/null and b/wireguard/icon.png differ diff --git a/wireguard/logo.png b/wireguard/logo.png new file mode 100644 index 00000000..296bad4a Binary files /dev/null and b/wireguard/logo.png differ