hassio-addons/addon-influxdb

Envvars values should always be strings - Suggested clarification in documentation

michaelpiron opened this issue · 2 comments

Problem/Motivation

It took me a bit of time to figure out that when setting environment variables in the add-on configuration, their value should always be a string, even if the variable is type boolean false/true.
This is different than other parameters in the configuration file, like auth, reporting, ssl. They should get boolean values.

This is illustrated here:
image

I figured this out by looking at the config.json file in the repository:
https://github.com/hassio-addons/addon-influxdb/blob/main/influxdb/config.json
image

Expected behavior

Actual behavior

Actual documentation:
image

Steps to reproduce

In Supervisor, go to the InfluxDB add-on, and enter the configuration tab. There, if you enter environment variables' value as a boolean (true/false) you get error message.

Proposed changes

My suggestion is to add in the add-on documentation that environment variables values should always be in string format.

I would suggest raising a PR for it, you should even be able to do it online with Github.

Hi Paul,
OK, I made a pull request: #140
My first pull request ever :-).