From fce8265a534115b2e44622d893f3a9c40c27b1dc Mon Sep 17 00:00:00 2001 From: "Community Hass.io Add-ons Bot" Date: Thu, 28 May 2020 22:41:43 +0000 Subject: [PATCH] :arrow_up: Updating add-on chrony to 5615135 --- README.md | 6 +- chrony/CHANGELOG.md | 1 + chrony/DOCS.md | 146 ++++++++++++++++++++++++++++++++++++++++++++ chrony/README.md | 7 +-- chrony/config.json | 2 +- 5 files changed, 153 insertions(+), 9 deletions(-) create mode 100644 chrony/DOCS.md diff --git a/README.md b/README.md index fc6dfd895..7a104bd46 100644 --- a/README.md +++ b/README.md @@ -1246,10 +1246,10 @@ SOFTWARE. [zerotier-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [zerotier-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [zerotier-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-chrony]: https://github.com/hassio-addons/addon-chrony/tree/5f6218d -[addon-doc-chrony]: https://github.com/hassio-addons/addon-chrony/blob/5f6218d/README.md +[addon-chrony]: https://github.com/hassio-addons/addon-chrony/tree/5615135 +[addon-doc-chrony]: https://github.com/hassio-addons/addon-chrony/blob/5615135/README.md [chrony-issue]: https://github.com/hassio-addons/addon-chrony/issues -[chrony-version-shield]: https://img.shields.io/badge/version-5f6218d-blue.svg +[chrony-version-shield]: https://img.shields.io/badge/version-5615135-blue.svg [chrony-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/chrony-armhf.svg [chrony-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [chrony-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/chrony/CHANGELOG.md b/chrony/CHANGELOG.md index d847396b4..bbd72f09d 100644 --- a/chrony/CHANGELOG.md +++ b/chrony/CHANGELOG.md @@ -1,4 +1,5 @@ # Changelog since v1.0.10 +- ✏ Split add-on documentation - 🔨 Implement OCI image specification on labels - ⬆ Upgrades add-on base image to v7.2.0 - ⬆Update base image to 7.1.1 diff --git a/chrony/DOCS.md b/chrony/DOCS.md new file mode 100644 index 000000000..3f5533d55 --- /dev/null +++ b/chrony/DOCS.md @@ -0,0 +1,146 @@ +# Home Assistant Community Add-on: chrony + +An NTP server accessible by all hosts on the local network, useful for setting +time on devices with controlled internet access (such as cameras). +The addon can also be used to set the system clock. + +## 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 "chrony" add-on in the add-on store and install it. +1. Start the "chrony" add-on +1. Check the logs of the "chrony" add-on to see if everything went well. + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +set_system_clock: true +mode: pool +ntp_pool: pool.ntp.org +ntp_server: + - 54.39.13.155 + - briareus.schulte.org +``` + +**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: `set_system_clock` + +The `set_system_clock` option configures chrony to set the local system clock. +For some systems it may be preferable to use a different mechanism for +setting the system time. + +### Option: `mode` + +The `mode` option configures chrony to use either `pool` or `server` mode. +These options are: + +- `pool`: References a pool of servers such as pool.ntp.org (Recommended). +- `server`: References a list of specific names or addresses. + +Based on the mode the `ntp_pool` or `ntp_server` option will be used. + +### Option: `ntp_pool` + +Used by pool mode and configures the pool name to be used, should be a DNS +record with multiple entries. The application will select which to reference. + +### Option: `ntp_server` + +Used by server mode, an array of server names or IP Addresses used as the +time source. The application will select which to reference. + +## 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 [Paul Sinclair][sinclairpaul]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2019-2020 Paul Sinclair + +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. + +[contributors]: https://github.com/hassio-addons/addon-chrony/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[forum]: https://community.home-assistant.io/t/community-hass-io-xxxxx/xxxxx +[sinclairpaul]: https://github.com/sinclairpaul +[issue]: https://github.com/hassio-addons/addon-chrony/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-chrony/releases +[semver]: http://semver.org/spec/v2.0.0.htm diff --git a/chrony/README.md b/chrony/README.md index 00aa23de2..a5588b696 100644 --- a/chrony/README.md +++ b/chrony/README.md @@ -13,8 +13,6 @@ chrony NTP Server. An NTP server accesible by all hosts on the local network, useful for setting time on devices with controlled internet access (such as cameras). -[Click here for the full documentation][docs] - ## WARNING! THIS IS AN EDGE VERSION! This Home Assistant Add-ons repository contains edge builds of add-ons. @@ -38,10 +36,9 @@ If you are more interested in stable releases of our add-ons: [buymeacoffee]: https://www.buymeacoffee.com/sinclairpaul [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[docs]: https://github.com/hassio-addons/addon-chrony/blob/5f6218d/README.md [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/?u=frenck [maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg [project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg -[release-shield]: https://img.shields.io/badge/version-5f6218d-blue.svg -[release]: https://github.com/hassio-addons/addon-chrony/tree/5f6218d \ No newline at end of file +[release-shield]: https://img.shields.io/badge/version-5615135-blue.svg +[release]: https://github.com/hassio-addons/addon-chrony/tree/5615135 \ No newline at end of file diff --git a/chrony/config.json b/chrony/config.json index 91aae54c5..2b2903acf 100644 --- a/chrony/config.json +++ b/chrony/config.json @@ -1,6 +1,6 @@ { "name": "chrony", - "version": "5f6218d", + "version": "5615135", "slug": "chrony", "description": "A local NTP (Network Time Protocol) server for cameras etc.", "url": "https://github.com/hassio-addons/addon-chrony",