diff --git a/README.md b/README.md index 77ed90cc..319dba45 100644 --- a/README.md +++ b/README.md @@ -1176,10 +1176,10 @@ SOFTWARE. [zwave2mqtt-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [zwave2mqtt-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [zwave2mqtt-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-zerotier]: https://github.com/hassio-addons/addon-zerotier/tree/v0.7.1 -[addon-doc-zerotier]: https://github.com/hassio-addons/addon-zerotier/blob/v0.7.1/README.md +[addon-zerotier]: https://github.com/hassio-addons/addon-zerotier/tree/v0.7.2 +[addon-doc-zerotier]: https://github.com/hassio-addons/addon-zerotier/blob/v0.7.2/README.md [zerotier-issue]: https://github.com/hassio-addons/addon-zerotier/issues -[zerotier-version-shield]: https://img.shields.io/badge/version-v0.7.1-blue.svg +[zerotier-version-shield]: https://img.shields.io/badge/version-v0.7.2-blue.svg [zerotier-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/zerotier-armhf.svg [zerotier-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [zerotier-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/zerotier/CHANGELOG.md b/zerotier/CHANGELOG.md index e37215b7..59e8cefb 100644 --- a/zerotier/CHANGELOG.md +++ b/zerotier/CHANGELOG.md @@ -4,11 +4,12 @@ This is a general maintenance release. ### Changed -- :arrow_up: Upgrades base image to v7.1.0 -- :arrow_up: Upgrades libgcc to 9.2.0-r4 -- :hammer: Disable Docker init +- ⬆ Upgrades add-on base image to v7.2.0 +- 🔨 Implement OCI image specification on labels +- ⬆ Upgrades git to 2.24.3-r0 +- ✏ Split add-on documentation -[changelog]: https://github.com/hassio-addons/addon-zerotier/compare/v0.7.0...v0.7.1 +[changelog]: https://github.com/hassio-addons/addon-zerotier/compare/v0.7.1...v0.7.2 Questions? Join our Discord server! https://discord.me/hassioaddons Enjoying my add-ons? Consider supporting my work: diff --git a/zerotier/DOCS.md b/zerotier/DOCS.md new file mode 100644 index 00000000..d795bd32 --- /dev/null +++ b/zerotier/DOCS.md @@ -0,0 +1,149 @@ +# Home Assistant Community Add-on: ZeroTier One + +ZeroTier delivers the capabilities of VPNs, SDN, and SD-WAN with a single +system. Manage all your connected resources across both local and wide area +networks as if the whole world is a single data center. + +People use ZeroTier to seamlessly connect laptops, desktops, phones, +embedded devices, cloud resources, and apps any way they want anywhere they go. +It transforms the entire world into a single data center, to which you +can now add your Home Assistant instance using this add-on. + +## Installation + +The installation of this add-on is pretty straightforward and not different in +comparison to installing any other Home Assistant add-on. + +1. Search for the "ZeroTier One" add-on in the Supervisor add-on store + and install it. +1. Create a free account at [zerotier.com][zerotier] and get a network ID. +1. Set the "network_id" add-on option with your network ID. +1. Start the "ZeroTier One" add-on +1. Check the logs of the "ZeroTier One" add-on to see if everything went well. +1. The instance will show up in your ZeroTier account. + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +networks: + - wgfyiwe73747457 + - fhu3888892jjfdk +api_auth_token: '' +``` + +**Note**: _This is just an example, don't copy and paste it! Create your own!_ + +### Option: `log_level` + +The `log_level` option controls the level of log output by the addon and can +be changed to be more or less verbose, which might be useful when you are +dealing with an unknown issue. Possible values are: + +- `trace`: Show every detail, like all called internal functions. +- `debug`: Shows detailed debug information. +- `info`: Normal (usually) interesting events. +- `warning`: Exceptional occurrences that are not errors. +- `error`: Runtime errors that do not require immediate action. +- `fatal`: Something went terribly wrong. Add-on becomes unusable. + +Please note that each level automatically includes log messages from a +more severe level, e.g., `debug` also shows `info` messages. By default, +the `log_level` is set to `info`, which is the recommended setting unless +you are troubleshooting. + +### Option: `networks` + +Configures one or more network identifiers of the networks (VLAN) to join. +You can find this number in your ZeroTier account. + +**Note**: _This option support secrets, e.g., `!secret zerotier_network_id`._ + +### Option: `api_auth_token` + +ZeroTier exposes a local HTTP JSON API, which uses the port set using the +`port` option above. It allows tools and programs to access this ZeroTier +instance for quering data (or control it). + +This token is like a password for accessing that API, you can leave this +option empty if you are not planning on using this feature. + +For more information on the ZeroTier JSON API, [check their documentation][api]. + +**Note**: _This option support secrets, e.g., `!secret zerotier_token`._ + +## Changelog & Releases + +This repository keeps a change log using [GitHub's releases][releases] +functionality. The format of the log is based on +[Keep a Changelog][keepchangelog]. + +Releases are based on [Semantic Versioning][semver], and use the format +of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented +based on the following: + +- ``MAJOR``: Incompatible or major changes. +- ``MINOR``: Backwards-compatible new features and enhancements. +- ``PATCH``: Backwards-compatible bugfixes and package updates. + +## Support + +Got questions? + +You have several options to get them answered: + +- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on + support and feature requests. +- The [Home Assistant Discord chat server][discord-ha] for general Home + Assistant discussions and questions. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +You could also [open an issue here][issue] GitHub. + +## Authors & contributors + +The original setup of this repository is by [Franck Nijhof][frenck]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2019-2020 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 +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +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. + +[api]: https://www.zerotier.com/manual.shtml#4_1 +[contributors]: https://github.com/hassio-addons/addon-zerotier/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-zerotier-one/109091?u=frenck +[frenck]: https://github.com/frenck +[issue]: https://github.com/hassio-addons/addon-zerotier/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-zerotier/releases +[semver]: http://semver.org/spec/v2.0.0.htm +[zerotier]: https://www.zerotier.com/ diff --git a/zerotier/README.md b/zerotier/README.md index 4cb52f6b..83d2c0d2 100644 --- a/zerotier/README.md +++ b/zerotier/README.md @@ -22,8 +22,6 @@ embedded devices, cloud resources, and apps any way they want anywhere they go. It transforms the entire world into a single data center, to which you can now add your Home Assistant instance using this add-on. -[Click here for the full documentation][docs] - ## WARNING! THIS IS A BETA VERSION! This Home Assistant Add-ons repository contains beta releases of add-ons. @@ -42,7 +40,6 @@ If you are more interested in stable releases of our add-ons: [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[docs]: https://github.com/hassio-addons/addon-zerotier/blob/v0.7.1/README.md [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-zerotier-one/109091?u=frenck [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png @@ -51,5 +48,5 @@ 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.7.1-blue.svg -[release]: https://github.com/hassio-addons/addon-zerotier/tree/v0.7.1 \ No newline at end of file +[release-shield]: https://img.shields.io/badge/version-v0.7.2-blue.svg +[release]: https://github.com/hassio-addons/addon-zerotier/tree/v0.7.2 \ No newline at end of file diff --git a/zerotier/config.json b/zerotier/config.json index 648cdd76..42dd73f3 100644 --- a/zerotier/config.json +++ b/zerotier/config.json @@ -1,6 +1,6 @@ { "name": "ZeroTier One", - "version": "0.7.1", + "version": "0.7.2", "slug": "zerotier", "description": "Radically simplify your network with a virtual networking layer that works the same everywhere", "url": "https://github.com/hassio-addons/addon-zerotier",