🎉 Release of add-on Glances 0.8.0

README.md

@@ -880,10 +880,10 @@ SOFTWARE.
 [foldingathome-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg
 [foldingathome-armv7-shield]: https://img.shields.io/badge/armv7-no-red.svg
 [foldingathome-i386-shield]: https://img.shields.io/badge/i386-no-red.svg
-[addon-glances]: https://github.com/hassio-addons/addon-glances/tree/v0.7.1
+[addon-glances]: https://github.com/hassio-addons/addon-glances/tree/v0.8.0
-[addon-doc-glances]: https://github.com/hassio-addons/addon-glances/blob/v0.7.1/README.md
+[addon-doc-glances]: https://github.com/hassio-addons/addon-glances/blob/v0.8.0/README.md
 [glances-issue]: https://github.com/hassio-addons/addon-glances/issues
-[glances-version-shield]: https://img.shields.io/badge/version-v0.7.1-blue.svg
+[glances-version-shield]: https://img.shields.io/badge/version-v0.8.0-blue.svg
 [glances-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/glances-armhf.svg
 [glances-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
 [glances-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg

glances/CHANGELOG.md

@@ -4,16 +4,17 @@ This is a general maintenance release.
 
 ### 🔨 Changes
 
-- :arrow_up: Updates docker to v4.2.0 (#49)
+- ⬆ Updates glances to v3.1.4.1 (#59)
-- :arrow_up: Updates zeroconf to v0.24.5 (#55)
+- ⬆ Updates influxdb to v5.3.0 (#62)
-- :arrow_up: Updates glances to v3.1.4 (#56)
+- 📚Update integration details (#68)
-- :arrow_up: Upgrades add-on base image to v7.0.3
+- ⬆ Upgrades add-on base image to v7.2.0
-- :arrow_up: Upgrades gcc to 9.2.0-r4
+- 🔨 Implement OCI image specification on labels
-- :arrow_up: Upgrades musl-dev to 1.1.24-r1
+- ⬆ Upgrades musl-dev to 1.1.24-r2
-- :arrow_up: Upgrades python3 to 3.8.2-r0
+- ⬆ Updates zeroconf to v0.27.0 (#72)
-- :hammer: Don't use apk cache on cleanup
+- ✏ Split add-on documentation
+- 🚑 Set history_size to 0, to deal with memory leak
 
-[changelog]: https://github.com/hassio-addons/addon-glances/compare/v0.7.0...v0.7.1
+[changelog]: https://github.com/hassio-addons/addon-glances/compare/v0.7.1...v0.8.0
 
 Questions? Join our Discord server! https://discord.me/hassioaddons
 Enjoying my add-ons? Consider supporting my work: https://patreon.com/frenck

glances/DOCS.md

@@ -0,0 +1,238 @@
+# Home Assistant Community Add-on: Glances
+
+Glances is a cross-platform monitoring tool which aims to present a maximum of
+information in a minimum of space through a Web-based interface.
+
+Glances can export all system statistics to InfluxDB, allowing you to look
+at all your system information and its behavior over time.
+
+## 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 "Glances" add-on in the Supervisor add-on store
+   and install it.
+1. Disable "Protection mode" in the add-on panel.
+1. Start the "Glances" add-on.
+1. Check the logs of the "Glances" to see if everything went well.
+1. Click the "OPEN WEB UI" button take a glance at Glances.
+
+## Configuration
+
+**Note**: _Remember to restart the add-on when the configuration is changed._
+
+Example add-on configuration:
+
+```yaml
+log_level: info
+process_info: false
+refresh_time: 10
+ssl: false
+certfile: fullchain.pem
+keyfile: privkey.pem
+influxdb:
+  enabled: false
+  host: a0d7b954-influxdb
+  port: 8086
+  username: glances
+  password: "!secret glances_influxdb_password"
+  database: glances
+  prefix: localhost
+  interval: 60
+  ssl: false
+```
+
+**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: `process_info`
+
+If set to `true`, it will enable the process module of Glances and gives
+detailed insight into each individual process running on the system.
+
+**Note**: _Enabling this feature will increase CPU usage significantly._
+
+### Options: `refresh_time`
+
+Sets refresh time (in seconds).
+
+**Note**: _Refreshing more quickly will result in a higher CPU usage._
+
+### Option: `ssl`
+
+Enables/Disables SSL (HTTPS) on the Glances Web UI. 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_
+
+### Option group `influxdb`
+
+---
+
+The following options are for the option group: `influxdb`. These settings
+only apply to the Glances InfluxDB data export.
+
+#### Option `influxdb`: `enabled`
+
+Enables/Disables the Glances data export to InfluxDB.
+
+#### Option `influxdb`: `host`
+
+The hostname where InfluxDB is running.
+
+**Note**: _If you are using the Community InfluxDB add-on,
+use `a0d7b954-influxdb` as the hostname._
+
+#### Option `influxdb`: `port`
+
+The port on which InfluxDB is listening.
+
+#### Option `influxdb`: `username`
+
+The username that you have created for Glances to authenticate against
+InfluxDB.
+
+#### Option `influxdb`: `password`
+
+The password for the above username option.
+
+#### Option `influxdb`: `database`
+
+The name of the database to store all Glances information into.
+
+**Note**: _It is strongly recommended to create a separate database for glances
+and not store this in the same database name as Home Assistant._
+
+#### Option `prefix`: `localhost`
+
+The hostname to append for exported data.
+
+**Note**: _For the Grafana Glances dashboard set this to `localhost`._
+
+#### Option `influxdb`: `interval`
+
+Defines the interval (in seconds) on how often Glances exports data to InfluxDB.
+
+#### Option `influxdb`: `ssl`
+
+Adding this option will allow SSL to be used on the InfluxDB connection.  If not
+set will default to `false` which is the required setting for the Community
+InfluxDB add-on.
+
+## Adding Glances as a sensor into Home Assistant
+
+The Home Assistant Glances sensor platform is consuming the system information
+provided by the Glances API.
+
+This enables one to track and display their stats in Home Assistant,
+and even build automations based on that data.
+
+Set up the integration through **Configuration -> Integrations -> Glances**.
+
+**Note**: _Once the add-on is running, add the integration with all
+defaults, except for port, which should be 61209_
+
+More information about the Glances sensor platform can be found in the
+Home Assistant documentation:
+
+<https://www.home-assistant.io/components/sensor.glances/>
+
+## 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.
+
+[contributors]: https://github.com/hassio-addons/addon-glances/graphs/contributors
+[discord-ha]: https://discord.gg/c5DvZ4e
+[discord]: https://discord.me/hassioaddons
+[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
+[forum]: https://community.home-assistant.io/t/home-assistant-community-add-on-glances/97102?u=frenck
+[frenck]: https://github.com/frenck
+[issue]: https://github.com/hassio-addons/addon-glances/issues
+[keepchangelog]: http://keepachangelog.com/en/1.0.0/
+[reddit]: https://reddit.com/r/homeassistant
+[releases]: https://github.com/hassio-addons/addon-glances/releases
+[semver]: http://semver.org/spec/v2.0.0.htm

glances/README.md

@@ -18,13 +18,10 @@ information in a minimum of space through a Web-based interface.
 Glances can export all system statistics to InfluxDB, allowing you to look
 at all your system information and its behavior over time.
 
-[Click here for the full documentation][docs]
-
 ![Glances screenshot][screenshot]
 
 [discord-shield]: https://img.shields.io/discord/478094546522079232.svg
 [discord]: https://discord.me/hassioaddons
-[docs]: https://github.com/hassio-addons/addon-glances/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-glances/97102?u=frenck
 [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
@@ -33,6 +30,6 @@ at all your system information and its behavior over time.
 [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-shield]: https://img.shields.io/badge/version-v0.8.0-blue.svg
-[release]: https://github.com/hassio-addons/addon-glances/tree/v0.7.1
+[release]: https://github.com/hassio-addons/addon-glances/tree/v0.8.0
 [screenshot]: https://github.com/hassio-addons/addon-glances/raw/master/images/screenshot.png

glances/config.json

@@ -1,6 +1,6 @@
 {
   "name": "Glances",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "slug": "glances",
   "description": "A cross-platform system monitoring tool",
   "url": "https://github.com/hassio-addons/addon-glances",