From 416e857bce474f1cf6e053ae668dffb7b2cd6a7e Mon Sep 17 00:00:00 2001 From: "Community Hass.io Add-ons Bot" Date: Sat, 30 May 2020 19:06:46 +0000 Subject: [PATCH] :tada: Release of add-on Home Panel 1.7.3 --- README.md | 6 +- home-panel/CHANGELOG.md | 10 ++- home-panel/DOCS.md | 143 ++++++++++++++++++++++++++++++++++++++++ home-panel/README.md | 7 +- home-panel/config.json | 2 +- 5 files changed, 153 insertions(+), 15 deletions(-) create mode 100644 home-panel/DOCS.md diff --git a/README.md b/README.md index 0675be1d..ec41618f 100644 --- a/README.md +++ b/README.md @@ -926,10 +926,10 @@ SOFTWARE. [happy-bubbles-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [happy-bubbles-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [happy-bubbles-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-home-panel]: https://github.com/hassio-addons/addon-home-panel/tree/v1.7.2 -[addon-doc-home-panel]: https://github.com/hassio-addons/addon-home-panel/blob/v1.7.2/README.md +[addon-home-panel]: https://github.com/hassio-addons/addon-home-panel/tree/v1.7.3 +[addon-doc-home-panel]: https://github.com/hassio-addons/addon-home-panel/blob/v1.7.3/README.md [home-panel-issue]: https://github.com/hassio-addons/addon-home-panel/issues -[home-panel-version-shield]: https://img.shields.io/badge/version-v1.7.2-blue.svg +[home-panel-version-shield]: https://img.shields.io/badge/version-v1.7.3-blue.svg [home-panel-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/home-panel-armhf.svg [home-panel-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [home-panel-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/home-panel/CHANGELOG.md b/home-panel/CHANGELOG.md index 88c4a60f..c84071b3 100644 --- a/home-panel/CHANGELOG.md +++ b/home-panel/CHANGELOG.md @@ -1,11 +1,9 @@ ## Changes -9a0106a Update openssl to 1.1.1g-r0 -78bb6d7 Update git to 2.24.3-r0 -9589168 Update base image to v7.1.1 -75e0e8b Update Home Panel to [v2.8.1][home-panel-changelog] +- ⬆ Upgrades add-on base image to v7.2.0 +- 🔨 Implement OCI image specification on labels +- ✏ Split add-on documentation [Full Changelog][changelog] -[changelog]: https://github.com/hassio-addons/addon-home-panel/compare/v1.7.1...v1.7.2 -[home-panel-changelog]: https://github.com/timmo001/home-panel/releases/tag/v2.8.1 +[changelog]: https://github.com/hassio-addons/addon-home-panel/compare/v1.7.2...v1.7.3 diff --git a/home-panel/DOCS.md b/home-panel/DOCS.md new file mode 100644 index 00000000..2a0410d5 --- /dev/null +++ b/home-panel/DOCS.md @@ -0,0 +1,143 @@ +# Home Assistant Community Add-on: Home Panel + +A web frontend for controlling the home. Integrates with + [Home Assistant][hass] as an alternative / additional frontend. Uses a + customisable and themeable card based UI which can be used on a touch screen. + +## 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 "Home Assistant” add-on in the add-on store and install it. +1. Configure the "Home Panel" add-on. (See below) +1. Start the "Home Panel" add-on. +1. Check the logs of the "Home Panel" add-on to see it in action. +1. Click "Open Web UI". +1. Create a new account. +1. Once logged in, log into Home Assistant via the sidebar. +1. Please see [here][config] for how to configure Home Panel + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +log_level: info +ssl: true +certfile: fullchain.pem +keyfile: privkey.pem +``` + +### 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: `ssl` + +Enables/Disables SSL (HTTPS) on the app. Set it `true` to enable it, +`false` otherwise. + +### Option: `certfile` + +The certificate file to use for SSL. + +**Note**: _The file MUST be stored in `/ssl/`, which is the default_ + +### Option: `keyfile` + +The private key file to use for SSL. + +**Note**: _The file MUST be stored in `/ssl/`, which is the default_ + +## 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] on GitHub. + +## Authors & contributors + +The original setup of this repository is by [Timmo][timmo]. + +For a full list of all authors and contributors, +check [the contributor's page][contributors]. + +## License + +MIT License + +Copyright (c) 2018-2020 Timmo + +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. + +[config]: https://timmo.dev/home-panel/configui/ +[contributors]: https://github.com/hassio-addons/addon-home-panel/graphs/contributors +[discord-ha]: https://discord.gg/c5DvZ4e +[discord]: https://discord.me/hassioaddons +[docs]: https://timmo.dev/home-panel/ +[forum]: https://community.home-assistant.io/t/home-panel-a-touch-compatible-webapp-for-controlling-the-home/62597?u=timmo001 +[hass]: https://www.home-assistant.io/ +[home-panel]: https://timmo.dev/home-panel +[issue]: https://github.com/hassio-addons/addon-home-panel/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-home-panel/releases +[repository]: https://github.com/hassio-addons/repository +[semver]: http://semver.org/spec/v2.0.0.htm +[timmo]: https://github.com/timmo001 diff --git a/home-panel/README.md b/home-panel/README.md index 1a908ab7..71087ad9 100644 --- a/home-panel/README.md +++ b/home-panel/README.md @@ -20,8 +20,6 @@ A web frontend for controlling the home. Integrates with ![Showcase Purple Space][showcase-purple-space] -[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. @@ -44,15 +42,14 @@ If you are more interested in stable releases of our add-ons: [buymeacoffee]: https://www.buymeacoffee.com/timmo [discord-shield]: https://img.shields.io/discord/478094546522079232.svg [discord]: https://discord.me/hassioaddons -[docs]: https://github.com/hassio-addons/addon-home-panel/blob/v1.7.2/README.md [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/t/home-panel-a-touch-compatible-webapp-for-controlling-the-home/62597?u=timmo001 [hass]: https://www.home-assistant.io/ [home-panel]: https://github.com/timmo001/home-panel [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-v1.7.2-blue.svg -[release]: https://github.com/hassio-addons/addon-home-panel/tree/v1.7.2 +[release-shield]: https://img.shields.io/badge/version-v1.7.3-blue.svg +[release]: https://github.com/hassio-addons/addon-home-panel/tree/v1.7.3 [screen-configuration-main]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/screen-configuration-main.png [screen-main]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/resources/screen-main.png [showcase-purple-space]: https://raw.githubusercontent.com/timmo001/home-panel/master/docs/docs/showcase/timmo/purple-space.png \ No newline at end of file diff --git a/home-panel/config.json b/home-panel/config.json index 34de52b2..b431163d 100644 --- a/home-panel/config.json +++ b/home-panel/config.json @@ -1,6 +1,6 @@ { "name": "Home Panel", - "version": "1.7.2", + "version": "1.7.3", "slug": "home-panel", "description": "A web frontend for controlling the home", "url": "https://github.com/hassio-addons/addon-home-panel",