From 3796a3b946b7d3ee3c13b7470bddf901915c83c8 Mon Sep 17 00:00:00 2001 From: Daniel Perna Date: Thu, 16 Nov 2017 08:01:38 +0100 Subject: [PATCH] Update HASS Configurator documentation (#3993) * Updated options * New options and screenshot * Added note about clearing banned IPs --- source/_addons/configurator.markdown | 6 +++++- source/_docs/ecosystem/hass-configurator.markdown | 9 +++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/source/_addons/configurator.markdown b/source/_addons/configurator.markdown index f2b2d3df19f..97640ebe203 100644 --- a/source/_addons/configurator.markdown +++ b/source/_addons/configurator.markdown @@ -46,7 +46,9 @@ Screenshot of the HASS Configurator. "ssl": false, "allowed_networks": ["192.168.0.0/16"], "banned_ips": ["8.8.8.8"], - "ignore_pattern": ["__pycache__"] + "banlimit": 0, + "ignore_pattern": ["__pycache__"], + "dirsfirst": false, } ``` @@ -55,7 +57,9 @@ Screenshot of the HASS Configurator. - **ssl** (*Optional*): Enable or Disable SSL for the editor. - **allowed_networks** (*Optional*): Limit access to the configurator by adding allowed IP addresses / networks to the list. - **banned_ips** (*Optional*): List of statically banned IP addresses. +- **banlimit** (*Optional*): Ban access from IPs after `banlimit` failed login attempts. The default value `0` disables this feature. Restart the add-on to clear the list of banned IP addresses. - **ignore_pattern** (*Optional*): Files and folders to ignore in the UI. +- **dirsfirst** (*Optional*): List directories before files in the filebrowser. ### {% linkable_title Embedding into Home-Assistant %} diff --git a/source/_docs/ecosystem/hass-configurator.markdown b/source/_docs/ecosystem/hass-configurator.markdown index bca0a948ee6..6e8c30f7d30 100644 --- a/source/_docs/ecosystem/hass-configurator.markdown +++ b/source/_docs/ecosystem/hass-configurator.markdown @@ -15,6 +15,11 @@ redirect_from: /ecosystem/hass-configurator/ Since there currently is no nice way to edit the yaml-files Home Assistant is using through the frontend, here is a small webapp that hopefully makes the configuration easier. It is a customized and embedded [Ace editor](https://ace.c9.io/), which has syntax highlighting for yaml, the format used for Home Assistants configuration files. There is an integrated file browser to select whatever file you want to edit. When you're done with editing the file, click the save-button and it will replace the original. Essentially this is a browser-based alternative to modifying your configuration through SSH, Windows + SMB, Github etc.. +

+ +Screenshot of the HASS Configurator. +

+ ### {% linkable_title Feature list %} - Web-Based editor to modify your files @@ -64,6 +69,10 @@ Limit access to the configurator by adding allowed IP addresses / networks to th List of statically banned IP addresses, e.g. `BANNED_IPS = ["1.1.1.1", "2.2.2.2"]` #### BANLIMIT (integer) Ban IPs after `n` failed login attempts. Restart the service to reset banning. The default of `0` disables this feature. `CREDENTIALS` has to be set for this to work. +#### IGNORE_PATTERN (list) +Files and folders to ignore in the UI, e.g. `IGNORE_PATTERN = [".*", "*.log", "__pycache__"]`. +#### DIRSFIRST (bool) +If set to `True`, directories will be displayed at the top of the filebrowser. #### GIT (bool) Set this variable to `True` to enable Git integration. This feature requires [GitPython](https://gitpython.readthedocs.io) to be installed on the system that is running the configurator. For technical reasons this feature can not be enabled with the static settings file.