init

influxdb/CHANGELOG.md

@@ -0,0 +1,8 @@
+## What’s changed
+
+## ⬆️ Dependency updates
+
+- ⬆️ Bump actions/stale from 3.0.18 to 3.0.19 @dependabot (#167)
+- ⬆️ Bump frenck/action-addon-information from 1.0.0 to 1.1 @dependabot (#168)
+- ⬆️ Bump micnncim/action-label-syncer from 1.2.0 to 1.3.0 @dependabot (#169)
+- ⬆️ Upgrades InfluxDB to 1.8.6 @frenck (#170)

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:
+
+<https://docs.influxdata.com/influxdb/v1.7/administration/config/#configuration-settings>
+
+**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. Values should always be entered as a string (even true/false values).
+
+### 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`.
+- Go to the users tab and create a user for Home Assistant,
+  e.g., `homeassistant`.
+- Add "ALL" to "Permissions" of the created user, to allow writing to your
+  database.
+
+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: <yourpassword>
+  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:
+
+<https://www.home-assistant.io/components/influxdb/>
+
+## 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.
+
+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-2021 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
+[reddit]: https://reddit.com/r/homeassistant
+[releases]: https://github.com/hassio-addons/addon-influxdb/releases
+[semver]: http://semver.org/spec/v2.0.0.htm

influxdb/README.md

@@ -0,0 +1,39 @@
+# Home Assistant Community Add-on: InfluxDB
+
+[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]
+
+[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum]
+
+[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]
+
+[![Support Frenck on Patreon][patreon-shield]][patreon]
+
+Scalable datastore for metrics, events, and real-time analytics.
+
+## About
+
+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 if
+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.
+
+![Chronograf in the Home Assistant Frontend][screenshot]
+
+[discord-shield]: https://img.shields.io/discord/478094546522079232.svg
+[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
+[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png
+[github-sponsors]: https://github.com/sponsors/frenck
+[maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
+[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-v4.1.1-blue.svg
+[release]: https://github.com/hassio-addons/addon-influxdb/tree/v4.1.1
+[screenshot]: https://github.com/hassio-addons/addon-influxdb/raw/main/images/screenshot.png

influxdb/config.json

@@ -0,0 +1,57 @@
+{
+  "name": "InfluxDB",
+  "version": "4.1.1",
+  "slug": "influxdb",
+  "description": "Scalable datastore for metrics, events, and real-time analytics",
+  "url": "https://github.com/hassio-addons/addon-influxdb",
+  "ingress": true,
+  "ingress_port": 1337,
+  "panel_icon": "mdi:chart-areaspline",
+  "startup": "services",
+  "homeassistant": "0.92.0b2",
+  "hassio_api": true,
+  "arch": [
+    "aarch64",
+    "amd64",
+    "armv7",
+    "i386"
+  ],
+  "init": false,
+  "map": [
+    "share:rw",
+    "ssl"
+  ],
+  "ports": {
+    "80/tcp": null,
+    "8086/tcp": 8086
+  },
+  "ports_description": {
+    "80/tcp": "Web interface (Not required for Ingress)",
+    "8086/tcp": "InfluxDB server"
+  },
+  "auth_api": true,
+  "options": {
+    "auth": true,
+    "reporting": true,
+    "ssl": true,
+    "certfile": "fullchain.pem",
+    "keyfile": "privkey.pem",
+    "envvars": []
+  },
+  "schema": {
+    "log_level": "list(trace|debug|info|notice|warning|error|fatal)?",
+    "auth": "bool",
+    "reporting": "bool",
+    "ssl": "bool",
+    "certfile": "str",
+    "keyfile": "str",
+    "envvars": [
+      {
+        "name": "match(^INFLUXDB_([A-Z0-9_])+$)",
+        "value": "str"
+      }
+    ],
+    "leave_front_door_open": "bool?"
+  },
+  "image": "ghcr.io/hassio-addons/influxdb/{arch}"
+}