🎉 Release of add-on WireGuard 0.7.0

This commit is contained in:
Community Hass.io Add-ons Bot 2022-06-12 19:28:25 +00:00
parent 1aee25faf5
commit 844f184c29
5 changed files with 41 additions and 59 deletions

View file

@ -956,10 +956,10 @@ SOFTWARE.
[bitwarden-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg
[bitwarden-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
[bitwarden-i386-shield]: https://img.shields.io/badge/i386-no-red.svg
[addon-wireguard]: https://github.com/hassio-addons/addon-wireguard/tree/v0.6.0
[addon-doc-wireguard]: https://github.com/hassio-addons/addon-wireguard/blob/v0.6.0/README.md
[addon-wireguard]: https://github.com/hassio-addons/addon-wireguard/tree/v0.7.0
[addon-doc-wireguard]: https://github.com/hassio-addons/addon-wireguard/blob/v0.7.0/README.md
[wireguard-issue]: https://github.com/hassio-addons/addon-wireguard/issues
[wireguard-version-shield]: https://img.shields.io/badge/version-v0.6.0-blue.svg
[wireguard-version-shield]: https://img.shields.io/badge/version-v0.7.0-blue.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

View file

@ -1,52 +1,27 @@
## Whats changed
## 🐛 Bug fixes
- 🚑 Fix service run permissions @frenck (#199)
- 🚑 Fix service path in wireguard service file @frenck (#200)
## 🚀 Enhancements
- Migrate JSON config to YAML @frenck (#173)
- 🔒 Sign add-on with Codenotary Community Attestation Service (CAS) @frenck (#203)
## 🧰 Maintenance
- ⬆️ Upgrade lock-threads workflow to 3.0.0 @frenck (#162)
- Switch to centralized GitHub Action Workflows @frenck (#172)
- 🚀 Update CI to latest version @frenck (#181)
- 🎆 Updates maintenance/license year to 2022 @frenck (#201)
## 📚 Documentation
- Clarified ListenPort-documentation @hAmpzter (#98)
- 📚 Minor documentation tweak @sinclairpaul (#108)
- Fixed typo @TheDK (#171)
- Change Snapshot to Backup in documentation @danbayliss (#191)
- 📚 Change Hass.io reference @sinclairpaul (#194)
- 📚 Small documentation tweaks and updates @frenck (#202)
## ⬆️ Dependency updates
- ⬆️ Bump actions/cache from v2.1.4 to v2.1.5 @dependabot (#105)
- ⬆️ Bump docker/setup-buildx-action from v1.1.2 to v1.2.0 @dependabot (#112)
- ⬆️ Bump docker/setup-qemu-action from v1.0.2 to v1.1.0 @dependabot (#113)
- ⬆️ Bump docker/login-action from v1.8.0 to v1.9.0 @dependabot (#114)
- ⬆️ Bump docker/setup-buildx-action from v1.2.0 to v1.3.0 @dependabot (#115)
- ⬆️ Bump brpaz/hadolint-action from v1.3.1 to v1.4.0 @dependabot (#106)
- ⬆️ Upgrades add-on base image to v9.2.0 @frenck (#117)
- ⬆️ Bump brpaz/hadolint-action from v1.4.0 to v1.5.0 @dependabot (#118)
- ⬆️ Upgrades go to 1.15.12-r0 @frenck (#119)
- ⬆️ Bump actions/stale from 3.0.18 to 3.0.19 @dependabot (#121)
- ⬆️ Bump frenck/action-addon-information from 1.0.0 to 1.1 @dependabot (#122)
- ⬆️ Bump micnncim/action-label-syncer from 1.2.0 to 1.3.0 @dependabot (#123)
- ⬆️ Bump docker/setup-qemu-action from 1.1.0 to 1.2.0 @dependabot (#125)
- ⬆️ Bump docker/build-push-action from 2.4.0 to 2.5.0 @dependabot (#124)
- ⬆️ Bump actions/cache from 2.1.5 to 2.1.6 @dependabot (#127)
- ⬆️ Bump frenck/action-addon-information from 1.1 to 1.2.2 @dependabot (#131)
- ⬆️ Bump dessant/lock-threads from 2.0.3 to 2.1.1 @dependabot (#140)
- ⬆️ Bump frenck/action-addon-linter from 2.1 to 2.2 @dependabot (#143)
- ⬆️ Bump actions/stale from 3.0.19 to 4 @dependabot (#142)
- ⬆️ Bump docker/setup-buildx-action from 1.3.0 to 1.5.1 @dependabot (#141)
- ⬆️ Bump docker/build-push-action from 2.5.0 to 2.6.1 @dependabot (#135)
- ⬆️ Bump docker/login-action from 1.9.0 to 1.10.0 @dependabot (#133)
- ⬆️ Upgrades add-on base image to v10.0.1 @frenck (#146)
- ⬆️ Bump dessant/lock-threads from 2.1.1 to 2.1.2 @dependabot (#147)
- ⬆️ Bump docker/build-push-action from 2.6.1 to 2.7.0 @dependabot (#148)
- ⬆️ Bump frenck/action-addon-linter from 2.2 to 2.3 @dependabot (#149)
- ⬆️ Bump frenck/action-addon-linter from 2.3 to 2.4.1 @dependabot (#157)
- ⬆️ Bump docker/setup-buildx-action from 1.5.1 to 1.6.0 @dependabot (#150)
- ⬆️ Bump creyD/prettier_action from 3.3 to 4.0 @dependabot (#151)
- ⬆️ Bump actions/checkout from 2.3.4 to 2.3.5 @dependabot (#164)
- ⬆️ Upgrades go to 1.16.10-r0 @frenck (#174)
- ⬆️ Upgrades add-on base image to 10.2.2 @frenck (#175)
- ⬆️ Upgrades WireGuard Go to 0.0.20210424 @frenck (#176)
- ⬆️ Upgrades add-on base image to 11.0.0 @frenck (#182)
- ⬆️ Upgrades add-on base image to 12.0.0 @frenck (#197)
- ⬆️ Upgrades WireGuard Go to 0.0.20220316 @frenck (#198)

View file

@ -24,18 +24,22 @@ for you (if you want).
Follow the following steps for installation & a quick start:
1. Search for the "WireGuard" add-on in the Supervisor add-on store
and install it.
1. Set the `host` configuration option to your Hass.io (external) address,
e.g., `myautomatedhome.duckdns.org`.
1. Click the Home Assistant My button below to open the add-on on your Home
Assistant instance.
[![Open this add-on in your Home Assistant instance.][addon-badge]][addon]
1. Click the "Install" button to install the add-on.
1. Set the `host` configuration option to your Home Assistant (external)
address, e.g., `myautomatedhome.duckdns.org`.
1. Change the name of the peer to something useful, e.g., `myphone`.
1. Save the configuration.
1. Start the "WireGuard" add-on
1. Check the logs of the "WireGuard" add-on to see if everything went well.
1. Forward port `51820` (UDP!) in your router to your Hass.io IP.
1. Forward port `51820` (UDP!) in your router to your Home Assistant instance.
1. Download/Open the file `/ssl/wireguard/myphone/qrcode.png` stored on your
Hass.io machine, e.g., using Samba, Visual Studio Code or the Configurator
add-on.
Home Assistant instance, e.g., using Samba, Visual Studio Code or the
Configurator add-on.
1. Install the WireGuard app on your phone.
1. Add a new WireGuard connection to your phone, by scanning the QR code.
1. Connect!
@ -92,7 +96,7 @@ to your WireGuard add-on. The `host` is mainly used to generate client
configurations and SHOULD NOT contain a port. If you want to change the port,
use the "Network" section of the add-on configuration.
Example: `myautomatedhome.duckdns.org`, for local testing `hassio.local`
Example: `myautomatedhome.duckdns.org`, for local testing `homeassistant.local`
will actually work.
DO NOT attempt to use a URL such as a Nabu Casa endpoint, the entry needs to be
@ -412,15 +416,15 @@ echo "net.ipv4.ip_forward = 1" | sudo tee -a /etc/sysctl.conf
sudo sysctl -p /etc/sysctl.conf
```
## Snapshots
## Backups
The WireGuard add-on can be backed up using Hass.io snapshots. There is one
caveat to take into account: A partial snapshot of the add-on DOES NOT contain
The WireGuard add-on can be backed up using Home Assistant Backups. There is one
caveat to take into account: A partial backup of the add-on DOES NOT contain
the generated client configurations, including their public/private keys
(if those keys are generated by the add-on).
Client configurations are stored in the `/ssl/wireguard` folder. If you
use partial snapshots, please be sure to backup both the `ssl` folder and the
use partial backups, please be sure to backup both the `ssl` folder and the
add-on.
## WireGuard status API
@ -508,7 +512,7 @@ check [the contributor's page][contributors].
MIT License
Copyright (c) 2019-2021 Franck Nijhof
Copyright (c) 2019-2022 Franck Nijhof
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@ -528,6 +532,8 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
[addon-badge]: https://my.home-assistant.io/badges/supervisor_addon.svg
[addon]: https://my.home-assistant.io/redirect/supervisor_addon/?addon=a0d7b954_wireguard&repository_url=https%3A%2F%2Fgithub.com%2Fhassio-addons%2Frepository
[adguard]: https://github.com/hassio-addons/addon-adguard-home
[contributors]: https://github.com/hassio-addons/addon-wireguard/graphs/contributors
[discord-ha]: https://discord.gg/c5DvZ4e

View file

@ -50,10 +50,10 @@ If you are more interested in stable releases of our add-ons:
[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-wireguard/134662?u=frenck
[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
[github-sponsors]: https://github.com/sponsors/frenck
[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2022.svg
[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/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.6.0-blue.svg
[release]: https://github.com/hassio-addons/addon-wireguard/tree/v0.6.0
[release-shield]: https://img.shields.io/badge/version-v0.7.0-blue.svg
[release]: https://github.com/hassio-addons/addon-wireguard/tree/v0.7.0
[wireguard]: https://www.wireguard.com

View file

@ -4,6 +4,7 @@ arch:
- armhf
- armv7
- i386
codenotary: codenotary@frenck.dev
description: Fast, modern, secure VPN tunnel
devices:
- /dev/net/tun
@ -67,4 +68,4 @@ schema:
table: str?
slug: wireguard
url: https://github.com/hassio-addons/addon-wireguard
version: 0.6.0
version: 0.7.0