From 6d56e7ef04eb8b533450c097bbf77f7ab3c95a4e Mon Sep 17 00:00:00 2001 From: Otto Winter Date: Wed, 27 Feb 2019 21:58:56 +0100 Subject: [PATCH] Add relative_url, status_use_ping and streamer_mode options --- esphome-dev/README.md | 20 +++++++++++++++++++ esphome-dev/config.json | 5 ++++- esphome-dev/rootfs/etc/services.d/esphome/run | 14 +++++++++++++ 3 files changed, 38 insertions(+), 1 deletion(-) diff --git a/esphome-dev/README.md b/esphome-dev/README.md index a0e7d32..cf589f7 100644 --- a/esphome-dev/README.md +++ b/esphome-dev/README.md @@ -101,6 +101,26 @@ or for version 1.10.0: `"esphome_version": "v1.10.0""`. Please note that this does not always work and is only meant for testing, usually the ESPHome add-on and dashboard version must match to guarantee a working system. +### Option: `relative_url` + +Host the ESPHome dashboard under a relative URL, so that it can be integrated +into existing web proxys like nginx under a relative URl. Defaults to `/`. + +### Option: `status_use_ping` + +By default the dashboard uses mDNS to check if nodes are online. This does +not work across subnets unless your router supports mDNS forwarding or avahi. + +Setting this to `true` will make ESPHome use ICMP ping requests to get the node status. Use this if all nodes always have offline status even when they're connected. + +### Option: `streamer_mode` + +If set to `true`, this will enable stremer mode, which makes ESPHome hide all +potentially private information. So for example WiFi (B)SSIDs (which could be +used to find your location), usernames etc. Please note that you need to use +the `!secret` tag in your YAML file to also prevent these from showing up +while editing and validating. + [discord-shield]: https://img.shields.io/discord/429907082951524364.svg [dht22]: https://esphome.io/components/sensor/dht.html [discord]: https://discord.me/KhAMKrd diff --git a/esphome-dev/config.json b/esphome-dev/config.json index 07e9df9..4b95fb5 100644 --- a/esphome-dev/config.json +++ b/esphome-dev/config.json @@ -35,6 +35,9 @@ "keyfile": "str", "port": "int", "leave_front_door_open": "bool?", - "esphome_version": "str?" + "esphome_version": "str?", + "streamer_mode": "bool?", + "relative_url": "str?", + "status_use_ping": "bool?" } } diff --git a/esphome-dev/rootfs/etc/services.d/esphome/run b/esphome-dev/rootfs/etc/services.d/esphome/run index 8dea41a..a70b703 100755 --- a/esphome-dev/rootfs/etc/services.d/esphome/run +++ b/esphome-dev/rootfs/etc/services.d/esphome/run @@ -6,9 +6,23 @@ # shellcheck disable=SC1091 source /usr/lib/hassio-addons/base.sh +export ESPHOME_IS_HASSIO=true + if hass.config.true 'leave_front_door_open'; then export DISABLE_HA_AUTHENTICATION=true fi +if hass.config.true 'streamer_mode'; then + export ESPHOME_STREAMER_MODE=true +fi + +if hass.config.true 'status_use_ping'; then + export ESPHOME_DASHBOARD_USE_PING=true +fi + +if hass.config.has_value 'relative_url'; then + export ESPHOME_DASHBOARD_RELATIVE_URL=$(hass.config.get 'relative_url') +fi + hass.log.info "Starting ESPHome dashboard..." exec esphome /config/esphome dashboard --socket /var/run/esphome.sock --hassio