From 6ac2afd2050f7ca3daee9179b64bfab8eb9f7aad Mon Sep 17 00:00:00 2001 From: Matt White <16320656+matt-FFFFFF@users.noreply.github.com> Date: Tue, 28 Nov 2023 08:55:57 +0000 Subject: [PATCH] docs: update readme (#120) --- README.md | 24 +++++++++++++++++++++--- config.json | 11 +++++++++-- scripts/ha-bootstrap.sh | 1 + 3 files changed, 31 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 06e4933..1e472cf 100644 --- a/README.md +++ b/README.md @@ -59,13 +59,31 @@ See the [official docs](https://github.com/home-assistant/addons/blob/master/mos I recommend you use the existing Grafana addon from the community addons, if you do, please enable the following plugins in your yaml configurations, e.g. +> Make sure you edit the configuration in YAML mode, not the GUI mode. + ```yaml plugins: - - natel-discrete-panel - - pr0ps-trackmap-panel - - grafana-piechart-panel + - name: natel-discrete-panel + - name: natel-plotly-panel + - name: pr0ps-trackmap-panel + - name: grafana-piechart-panel + - name: panodata-map-panel + url: https://github.com/panodata/panodata-map-panel/releases/download/0.16.0/panodata-map-panel-0.16.0.zip +custom_plugins: [] +env_vars: + - name: GF_SECURITY_ADMIN_USER + value: + - name: GF_SECURITY_ADMIN_PASSWORD + value: + - name: GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS + value: panodata-map-panel +ssl: true # optional if you are using TLS +certfile: fullchain.pem # optional if you are using TLS +keyfile: privkey.pem # optional if you are using TLS ``` +> Note that the security admin password and usernames can only be set on the first start of the Grafana addon, so if you already have it configured you'll need to remove it and re-add it. + #### Data Source Configure a PostgreSQL data source as follows: diff --git a/config.json b/config.json index d076165..2f29a9a 100644 --- a/config.json +++ b/config.json @@ -3,7 +3,12 @@ "version": "dev", "slug": "teslamate", "description": "A self-hosted data logger for your Tesla.", - "arch": ["armhf", "armv7", "aarch64", "amd64"], + "arch": [ + "armhf", + "armv7", + "aarch64", + "amd64" + ], "startup": "application", "boot": "auto", "ingress": true, @@ -16,6 +21,7 @@ "database_host": "29b65938-postgres", "database_ssl": false, "database_port": 5432, + "default_geofence": "", "disable_mqtt": false, "encryption_key": "myencryptionkey", "grafana_import_dashboards": false, @@ -40,6 +46,7 @@ "database_host": "str", "database_ssl": "bool", "database_port": "int", + "default_geofence": "str", "disable_mqtt": "bool", "encryption_key": "password", "grafana_import_dashboards": "bool", @@ -62,4 +69,4 @@ ], "url": "https://github.com/matt-FFFFFF/hassio-addon-repository/blob/master/teslamate/README.md", "image": "mattffffff/teslamate-{arch}" - } +} diff --git a/scripts/ha-bootstrap.sh b/scripts/ha-bootstrap.sh index faea4c7..7f89c5b 100755 --- a/scripts/ha-bootstrap.sh +++ b/scripts/ha-bootstrap.sh @@ -22,6 +22,7 @@ export IMPORT_DIR=$(bashio::config 'import_dir') export PORT=4000 export TZ=$(bashio::config 'timezone') export ENCRYPTION_KEY=$(bashio::config 'encryption_key') +export DEFAULT_GEOFENCE=$(bashio::config 'default_geofence') # Import dashboards if [ $(bashio::config 'grafana_import_dashboards') == 'true' ]; then