🎉 Release of add-on WireGuard 0.6.0

README.md

@@ -979,10 +979,10 @@ 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.5.1
+[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.5.1/README.md
+[addon-doc-wireguard]: https://github.com/hassio-addons/addon-wireguard/blob/v0.6.0/README.md
 [wireguard-issue]: https://github.com/hassio-addons/addon-wireguard/issues
-[wireguard-version-shield]: https://img.shields.io/badge/version-v0.5.1-blue.svg
+[wireguard-version-shield]: https://img.shields.io/badge/version-v0.6.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

wireguard/CHANGELOG.md

@@ -1,20 +1,52 @@
 ## What’s changed
 
+## 🚀 Enhancements
+
+- Migrate JSON config to YAML @frenck (#173)
+
+## 🧰 Maintenance
+
+- ⬆️ Upgrade lock-threads workflow to 3.0.0 @frenck (#162)
+- Switch to centralized GitHub Action Workflows @frenck (#172)
+
+## 📚 Documentation
+
+- Clarified ListenPort-documentation @hAmpzter (#98)
+- 📚 Minor documentation tweak @sinclairpaul (#108)
+- Fixed typo @TheDK (#171)
+
 ## ⬆️ Dependency updates
 
-- ⬆ Upgrades git to 2.30.1-r0 @frenck (#74)
+- ⬆️ Bump actions/cache from v2.1.4 to v2.1.5 @dependabot (#105)
-- ⬆️ Bump release-drafter/release-drafter from v5.13.0 to v5.14.0 @dependabot (#75)
+- ⬆️ Bump docker/setup-buildx-action from v1.1.2 to v1.2.0 @dependabot (#112)
-- ⬆️ Bump docker/build-push-action from v2.2.2 to v2.3.0 @dependabot (#76)
+- ⬆️ Bump docker/setup-qemu-action from v1.0.2 to v1.1.0 @dependabot (#113)
-- ⬆️ Bump actions/stale from v3.0.16 to v3.0.17 @dependabot (#79)
+- ⬆️ Bump docker/login-action from v1.8.0 to v1.9.0 @dependabot (#114)
-- ⬆️ Bump actions/stale from v3.0.17 to v3.0.18 @dependabot (#85)
+- ⬆️ Bump docker/setup-buildx-action from v1.2.0 to v1.3.0 @dependabot (#115)
-- ⬆️ Upgrades git to 2.30.2-r0 @frenck (#88)
+- ⬆️ Bump brpaz/hadolint-action from v1.3.1 to v1.4.0 @dependabot (#106)
-- ⬆️ Bump release-drafter/release-drafter from v5.14.0 to v5.15.0 @dependabot (#87)
+- ⬆️ Upgrades add-on base image to v9.2.0 @frenck (#117)
-- ⬆️ Upgrades go to 1.15.10-r0 @frenck (#89)
+- ⬆️ Bump brpaz/hadolint-action from v1.4.0 to v1.5.0 @dependabot (#118)
-- ⬆️ Upgrades add-on base image to v9.1.5 @frenck (#90)
+- ⬆️ Upgrades go to 1.15.12-r0 @frenck (#119)
-- ⬆️ Bump frenck/action-addon-linter from v2.0.0 to v2.1 @dependabot (#92)
+- ⬆️ Bump actions/stale from 3.0.18 to 3.0.19 @dependabot (#121)
-- ⬆️ Bump ludeeus/action-shellcheck from 1.0.0 to 1.1.0 @dependabot (#96)
+- ⬆️ Bump frenck/action-addon-information from 1.0.0 to 1.1 @dependabot (#122)
-- ⬆️ Bump docker/build-push-action from v2.3.0 to v2.4.0 @dependabot (#97)
+- ⬆️ Bump micnncim/action-label-syncer from 1.2.0 to 1.3.0 @dependabot (#123)
-- ⬆️ Bump docker/setup-buildx-action from v1.1.1 to v1.1.2 @dependabot (#99)
+- ⬆️ Bump docker/setup-qemu-action from 1.1.0 to 1.2.0 @dependabot (#125)
-- ⬆️ Bump docker/setup-qemu-action from v1.0.1 to v1.0.2 @dependabot (#100)
+- ⬆️ Bump docker/build-push-action from 2.4.0 to 2.5.0 @dependabot (#124)
-- ⬆️ Upgrades add-on base image to v9.1.7 @frenck (#101)
+- ⬆️ Bump actions/cache from 2.1.5 to 2.1.6 @dependabot (#127)
-- ⬆️ Upgrades WireGuard Go to 0.0.20210212 @frenck (#102)
+- ⬆️ 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)

wireguard/DOCS.md

@@ -46,7 +46,7 @@ Now, for starters, don't get scared by the number of options and difficult
 terms this add-on provides. WireGuard can be a complex piece of software,
 but the add-on only has a few, simple, required settings. All the rest is
 handled by the add-on. However, If you would like to set up a more complex
-configuration, the add-on would allow that to.
+configuration, the add-on would allow that, too.
 
 If you are familiar with WireGuard, please note the following:
 The configuration of WireGuard looks very similar to all terms used in the
@@ -204,7 +204,7 @@ This is an identifier for you. It helps you to know what this peer is, e.g.,
 This name is also used for creating the directory in `/ssl/wireguard` where
 the generated client configuration and QR codes are stored. Therefore, a name
 has a maximum of 32 characters, can only contain A-Z (or a-z) and 0-9.
-Names contain a hyphen (-) but must not start or end with one.
+Names may contain a hyphen (-) but must not start or end with one.
 
 ### Option: `peers.addresses`
 
@@ -466,8 +466,8 @@ If you have, sharing would be appreciated!
   solving this by editing the "Endpoint" setting on the client on the device
   in the connection profile.
 - We had reports of people with connection issues on the client side, being
-  resolved by configuring/setting the "Listen port" to `51820` on the client
+  resolved by configuring/setting the `ListenPort = 51820` on the client
-  device in the connection profile.
+  device in the connection profile (in `[Interface]` section).
 
 ## Changelog & Releases
 

wireguard/README.md

@@ -54,6 +54,6 @@ If you are more interested in stable releases of our add-ons:
 [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.5.1-blue.svg
+[release-shield]: https://img.shields.io/badge/version-v0.6.0-blue.svg
-[release]: https://github.com/hassio-addons/addon-wireguard/tree/v0.5.1
+[release]: https://github.com/hassio-addons/addon-wireguard/tree/v0.6.0
 [wireguard]: https://www.wireguard.com

wireguard/config.json

@@ -1,95 +0,0 @@
-{
-  "name": "WireGuard",
-  "version": "0.5.1",
-  "slug": "wireguard",
-  "description": "Fast, modern, secure VPN tunnel",
-  "url": "https://github.com/hassio-addons/addon-wireguard",
-  "arch": [
-    "aarch64",
-    "amd64",
-    "armhf",
-    "armv7",
-    "i386"
-  ],
-  "init": false,
-  "ports": {
-    "80/tcp": null,
-    "51820/udp": 51820
-  },
-  "ports_description": {
-    "80/tcp": "WireGuard peers status API",
-    "51820/udp": "WireGuard: forward this port in your router"
-  },
-  "hassio_api": true,
-  "privileged": [
-    "NET_ADMIN"
-  ],
-  "devices": [
-    "/dev/net/tun"
-  ],
-  "map": [
-    "ssl:rw"
-  ],
-  "options": {
-    "server": {
-      "host": "myautomatedhome.duckdns.org",
-      "addresses": [
-        "172.27.66.1"
-      ],
-      "dns": []
-    },
-    "peers": [
-      {
-        "name": "hassio",
-        "addresses": [
-          "172.27.66.2"
-        ],
-        "allowed_ips": [],
-        "client_allowed_ips": []
-      }
-    ]
-  },
-  "schema": {
-    "log_level": "list(trace|debug|info|notice|warning|error|fatal)?",
-    "server": {
-      "host": "str",
-      "interface": "match(^wg([0-9])+$)?",
-      "addresses": [
-        "str"
-      ],
-      "dns": [
-        "str"
-      ],
-      "private_key": "password?",
-      "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": "ghcr.io/hassio-addons/wireguard/{arch}"
-}

wireguard/config.yaml

@@ -0,0 +1,70 @@
+arch:
+- aarch64
+- amd64
+- armhf
+- armv7
+- i386
+description: Fast, modern, secure VPN tunnel
+devices:
+- /dev/net/tun
+hassio_api: true
+image: ghcr.io/hassio-addons/wireguard/{arch}
+init: false
+map:
+- ssl:rw
+name: WireGuard
+options:
+  peers:
+  - addresses:
+    - 172.27.66.2
+    allowed_ips: []
+    client_allowed_ips: []
+    name: hassio
+  server:
+    addresses:
+    - 172.27.66.1
+    dns: []
+    host: myautomatedhome.duckdns.org
+ports:
+  51820/udp: 51820
+  80/tcp: null
+ports_description:
+  51820/udp: 'WireGuard: forward this port in your router'
+  80/tcp: WireGuard peers status API
+privileged:
+- NET_ADMIN
+schema:
+  log_level: list(trace|debug|info|notice|warning|error|fatal)?
+  peers:
+  - addresses:
+    - str
+    allowed_ips:
+    - str
+    client_allowed_ips:
+    - str
+    endpoint: str?
+    fwmark: str?
+    name: match(^[a-zA-Z0-9\d](?:[a-zA-Z0-9\d]|-(?=[a-zA-Z0-9\d])){0,32}$)
+    persistent_keep_alive: int?
+    pre_shared_key: str?
+    private_key: str?
+    public_key: str?
+  server:
+    addresses:
+    - str
+    dns:
+    - str
+    fwmark: str?
+    host: str
+    interface: match(^wg([0-9])+$)?
+    mtu: int?
+    post_down: str?
+    post_up: str?
+    pre_down: str?
+    pre_up: str?
+    private_key: password?
+    public_key: str?
+    table: str?
+slug: wireguard
+url: https://github.com/hassio-addons/addon-wireguard
+version: 0.6.0