diff --git a/README.md b/README.md index d5d39169..ecef0460 100644 --- a/README.md +++ b/README.md @@ -946,10 +946,10 @@ SOFTWARE. [ide-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [ide-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg [ide-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-influxdb]: https://github.com/hassio-addons/addon-influxdb/tree/v3.6.2 -[addon-doc-influxdb]: https://github.com/hassio-addons/addon-influxdb/blob/v3.6.2/README.md +[addon-influxdb]: https://github.com/hassio-addons/addon-influxdb/tree/v3.7.0 +[addon-doc-influxdb]: https://github.com/hassio-addons/addon-influxdb/blob/v3.7.0/README.md [influxdb-issue]: https://github.com/hassio-addons/addon-influxdb/issues -[influxdb-version-shield]: https://img.shields.io/badge/version-v3.6.2-blue.svg +[influxdb-version-shield]: https://img.shields.io/badge/version-v3.7.0-blue.svg [influxdb-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/influxdb-amd64.svg [influxdb-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [influxdb-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/influxdb/CHANGELOG.md b/influxdb/CHANGELOG.md index 1a17c866..285cbeb0 100644 --- a/influxdb/CHANGELOG.md +++ b/influxdb/CHANGELOG.md @@ -4,12 +4,16 @@ This is a general maintenance release. ### 🔨 Changes -- :pencil2: Typo fix (#73) -- :hammer: Disable Docker init -- :arrow_up: Upgrades base image to v5.1.0 -- :arrow_up: Upgrades Chronograf to 1.8.2 +- ⬆ Upgrades Chronograf to 1.8.3 +- ⬆ Upgrades Kapacitor to 1.5.5-1 +- ⬆ Upgrades Chronograf to 1.8.4 +- ⬆ Upgrades add-on base image to v5.2.0 +- 🔨 Implement OCI image specification on labels +- ⬆ Upgrades InfluxDB to 1.8.0 +- 🔨 Switch add-on from Ubuntu to Debian +- ✏ Split add-on documentation -[changelog]: https://github.com/hassio-addons/addon-influxdb/compare/v3.6.1...v3.6.2 +[changelog]: https://github.com/hassio-addons/addon-influxdb/compare/v3.6.2...v3.7.0 Questions? Join our Discord server! https://discord.me/hassioaddons Enjoying my add-ons? Consider supporting my work: diff --git a/influxdb/DOCS.md b/influxdb/DOCS.md new file mode 100644 index 00000000..865a794e --- /dev/null +++ b/influxdb/DOCS.md @@ -0,0 +1,234 @@ +# Home Assistant Community Add-on: InfluxDB + +InfluxDB is an open source time series database optimized for high-write-volume. +It's useful for recording metrics, sensor data, events, +and performing analytics. It exposes an HTTP API for client interaction and is +often used in combination with Grafana to visualize the data. + +This add-on comes with Chronograf & Kapacitor pre-installed as well. Which +gives you a nice InfluxDB admin interface for managing your users, databases, +data retention settings, and lets you peek inside the database using the +Data Explorer. + +## 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 "InfluxDB" add-on in the Supervisor add-on store and install it. +1. Start the "InfluxDB" add-on. +1. Check the logs of the "InfluxDB" to see if everything went well. +1. Click the "OPEN WEB UI" button! + +## Configuration + +**Note**: _Remember to restart the add-on when the configuration is changed._ + +Example add-on configuration: + +```yaml +log_level: info +auth: true +reporting: true +ssl: true +certfile: fullchain.pem +keyfile: privkey.pem +envvars: + - name: INFLUXDB_HTTP_LOG_ENABLED + value: 'true' +``` + +**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: `auth` + +Enable or disable InfluxDB user authentication. + +**Note**: _Turning this off is NOT recommended!_ + +### Option: `reporting` + +This option allows you to disable the reporting of usage data to InfluxData. + +**Note**: _No data from user databases is ever transmitted!_ + +### Option: `ssl` + +Enables/Disables SSL (HTTPS) on the web interface. +Set it `true` to enable it, `false` otherwise. + +**Note**: _This does NOT activate SSL for InfluxDB, just the web interface_ + +### 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: `envvars` + +This allows the setting of Environment Variables to control InfluxDB +configuration as documented at: + + + +**Note**: _Changing these options can possibly cause issues with you instance. +USE AT YOUR OWN RISK!_ + +These are case sensitive. + +#### Sub-option: `name` + +The name of the environment variable to set which must start with `INFLUXDB_` + +#### Sub-option: `value` + +The value of the environment variable to set, set the Influx documentation for +full details. + +### Option: `leave_front_door_open` + +Adding this option to the add-on configuration allows you to disable +authentication on the Web Terminal by setting it to `true` and leaving the +username and password empty. + +**Note**: _We STRONGLY suggest, not to use this, even if this add-on is +only exposed to your internal network. USE AT YOUR OWN RISK!_ + +## Integrating into Home Assistant + +The `influxdb` integration of Home Assistant makes it possible to transfer all +state changes to an InfluxDB database. + +You need to do the following steps in order to get this working: + +- Click on "OPEN WEB UI" to open the admin web-interface provided by this add-on. +- On the left menu click on the "InfluxDB Admin". +- Create a database for storing Home Assistant's data in, e.g., `homeassistant`. +- Goto the users tab and create a user for Home Assistant, + e.g., `homeassistant`. + +Now we've got this in place, add the following snippet to your Home Assistant +`configuration.yaml` file. + +```yaml +influxdb: + host: a0d7b954-influxdb + port: 8086 + database: homeassistant + username: homeassistant + password: + max_retries: 3 + default_measurement: state +``` + +Restart Home Assistant. + +You should now see the data flowing into InfluxDB by visiting the web-interface +and using the Data Explorer. + +Full details of the Home Assistant integration can be found here: + + + +## Known issues and limitations + +- While the Chronograph interface supports SSL, currently, the add-on does + not support having SSL on InfluxDB. This limitation is caused by + Chronograf and we are still looking into a proper solution for this. + +## 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) 2018-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-influxdb/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-influxdb/54491?u=frenck +[frenck]: https://github.com/frenck +[issue]: https://github.com/hassio-addons/addon-influxdb/issues +[keepchangelog]: http://keepachangelog.com/en/1.0.0/ +[reddit]: https://reddit.com/r/homeassistant +[releases]: https://github.com/hassio-addons/addon-influxdb/releases +[semver]: http://semver.org/spec/v2.0.0.htm diff --git a/influxdb/README.md b/influxdb/README.md index 740eb9b2..c6e8cb92 100644 --- a/influxdb/README.md +++ b/influxdb/README.md @@ -22,8 +22,6 @@ gives you a nice InfluxDB admin interface for managing your users, databases, data retention settings, and lets you peek inside the database using the Data Explorer. -[Click here for the full documentation][docs] - ![Chronograf in the Home Assistant Frontend][screenshot] ## WARNING! THIS IS A BETA VERSION! @@ -44,7 +42,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-influxdb/blob/v3.6.2/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-influxdb/54491?u=frenck [github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png @@ -53,6 +50,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-production%20ready-brightgreen.svg -[release-shield]: https://img.shields.io/badge/version-v3.6.2-blue.svg -[release]: https://github.com/hassio-addons/addon-influxdb/tree/v3.6.2 +[release-shield]: https://img.shields.io/badge/version-v3.7.0-blue.svg +[release]: https://github.com/hassio-addons/addon-influxdb/tree/v3.7.0 [screenshot]: https://github.com/hassio-addons/addon-influxdb/raw/master/images/screenshot.png \ No newline at end of file diff --git a/influxdb/config.json b/influxdb/config.json index 1ce9405d..401febfa 100644 --- a/influxdb/config.json +++ b/influxdb/config.json @@ -1,6 +1,6 @@ { "name": "InfluxDB", - "version": "3.6.2", + "version": "3.7.0", "slug": "influxdb", "description": "Scalable datastore for metrics, events, and real-time analytics", "url": "https://github.com/hassio-addons/addon-influxdb",