hassio-addons / addon-grafana

Grafana - Home Assistant Community Add-ons
https://addons.community
MIT License
221 stars 61 forks source link

Documentation issue #99

Closed Toukite closed 3 years ago

Toukite commented 3 years ago

Problem/Motivation

Hi, I just wanted to highlight that current configuration in documentation does not seem to work, even if setting user to admin instead of frenck and even if removing plugins (not sure how to install those on a HassOS setup):

log_level: info
grafana_ingress_user: frenck
plugins:
- ayoungprogrammer-finance-datasource
- grafana-clock-panel
env_vars:
- name: GF_DEFAULT_INSTANCE_NAME
value: Hassio

However it works with the default configuration (present when installing the addon):

plugins: []
env_vars: []
ssl: true
certfile: cert.pem
keyfile: privkey.pem

Expected behavior

Config successfully saved and addon starting properly when based upon documentation

Actual behavior

Following error appears when saving the config: Failed to save addon configuration, not a valid value for dictionary value @ data['options']. Got {'log_level': 'info', 'grafana_ingress_user': 'admin', 'plugins': ['ayoungprogrammer-finance-datasource', 'grafana-clock-panel'], 'env_vars': [{'name': 'GF_DEFAULT_INSTANCE_NAME', 'value': 'Hassio'}]}

Steps to reproduce

Install Grafana and try to save the documented configuration

Proposed changes

Make the proposed documentation a workable basis. Currently, some options present in the default config after addon installation are not documented + the opposite: some options documented do not seem to work if put in the actual configuration

github-actions[bot] commented 3 years ago

There hasn't been any activity on this issue recently, so we clean up some of the older and inactive issues. Please make sure to update to the latest version and check if that solves the issue. Let us know if that works for you by leaving a comment 👍 This issue has now been marked as stale and will be closed if no further activity occurs. Thanks!

Toukite commented 3 years ago

Still hoping .. commenting to unstale !

github-actions[bot] commented 3 years ago

There hasn't been any activity on this issue recently, so we clean up some of the older and inactive issues. Please make sure to update to the latest version and check if that solves the issue. Let us know if that works for you by leaving a comment 👍 This issue has now been marked as stale and will be closed if no further activity occurs. Thanks!

Toukite commented 3 years ago

Still hoping .. commenting to unstale !

sinclairpaul commented 3 years ago

There is an explicit note in the docs saying don't copy and paste it, the reason it fails to save is that the SSL options are missing from what you linked.

Apart from adding those to the example (which means more people would copy/paste it), what else should be done here?

Currently, some options present in the default config after addon installation are not documented + the opposite: some options documented do not seem to work if put in the actual configuration

Can you clarify which options are not documented?

github-actions[bot] commented 3 years ago

There hasn't been any activity on this issue recently, so we clean up some of the older and inactive issues. Please make sure to update to the latest version and check if that solves the issue. Let us know if that works for you by leaving a comment 👍 This issue has now been marked as stale and will be closed if no further activity occurs. Thanks!