Add relative_url, status_use_ping and streamer_mode options

This commit is contained in:
Otto Winter 2019-02-27 21:58:56 +01:00
parent d3f683fb2b
commit 6d56e7ef04
No known key found for this signature in database
GPG Key ID: DB66C0BE6013F97E
3 changed files with 38 additions and 1 deletions

View File

@ -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 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. 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 [discord-shield]: https://img.shields.io/discord/429907082951524364.svg
[dht22]: https://esphome.io/components/sensor/dht.html [dht22]: https://esphome.io/components/sensor/dht.html
[discord]: https://discord.me/KhAMKrd [discord]: https://discord.me/KhAMKrd

View File

@ -35,6 +35,9 @@
"keyfile": "str", "keyfile": "str",
"port": "int", "port": "int",
"leave_front_door_open": "bool?", "leave_front_door_open": "bool?",
"esphome_version": "str?" "esphome_version": "str?",
"streamer_mode": "bool?",
"relative_url": "str?",
"status_use_ping": "bool?"
} }
} }

View File

@ -6,9 +6,23 @@
# shellcheck disable=SC1091 # shellcheck disable=SC1091
source /usr/lib/hassio-addons/base.sh source /usr/lib/hassio-addons/base.sh
export ESPHOME_IS_HASSIO=true
if hass.config.true 'leave_front_door_open'; then if hass.config.true 'leave_front_door_open'; then
export DISABLE_HA_AUTHENTICATION=true export DISABLE_HA_AUTHENTICATION=true
fi 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..." hass.log.info "Starting ESPHome dashboard..."
exec esphome /config/esphome dashboard --socket /var/run/esphome.sock --hassio exec esphome /config/esphome dashboard --socket /var/run/esphome.sock --hassio