Skip to content

Commit 3796a3b

Browse files
danielperna84fabaff
authored andcommitted
Update HASS Configurator documentation (home-assistant#3993)
* Updated options * New options and screenshot * Added note about clearing banned IPs
1 parent 82b0a39 commit 3796a3b

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

source/_addons/configurator.markdown

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,9 @@ Screenshot of the HASS Configurator.
4646
"ssl": false,
4747
"allowed_networks": ["192.168.0.0/16"],
4848
"banned_ips": ["8.8.8.8"],
49-
"ignore_pattern": ["__pycache__"]
49+
"banlimit": 0,
50+
"ignore_pattern": ["__pycache__"],
51+
"dirsfirst": false,
5052
}
5153
```
5254

@@ -55,7 +57,9 @@ Screenshot of the HASS Configurator.
5557
- **ssl** (*Optional*): Enable or Disable SSL for the editor.
5658
- **allowed_networks** (*Optional*): Limit access to the configurator by adding allowed IP addresses / networks to the list.
5759
- **banned_ips** (*Optional*): List of statically banned IP addresses.
60+
- **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.
5861
- **ignore_pattern** (*Optional*): Files and folders to ignore in the UI.
62+
- **dirsfirst** (*Optional*): List directories before files in the filebrowser.
5963

6064
### {% linkable_title Embedding into Home-Assistant %}
6165

source/_docs/ecosystem/hass-configurator.markdown

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ redirect_from: /ecosystem/hass-configurator/
1515
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.
1616
Essentially this is a browser-based alternative to modifying your configuration through SSH, Windows + SMB, Github etc..
1717

18+
<p class='img'>
19+
<img src='/images/hassio/screenshots/addon-hass-configurator.png'>
20+
Screenshot of the HASS Configurator.
21+
</p>
22+
1823
### {% linkable_title Feature list %}
1924

2025
- Web-Based editor to modify your files
@@ -64,6 +69,10 @@ Limit access to the configurator by adding allowed IP addresses / networks to th
6469
List of statically banned IP addresses, e.g. `BANNED_IPS = ["1.1.1.1", "2.2.2.2"]`
6570
#### BANLIMIT (integer)
6671
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.
72+
#### IGNORE_PATTERN (list)
73+
Files and folders to ignore in the UI, e.g. `IGNORE_PATTERN = [".*", "*.log", "__pycache__"]`.
74+
#### DIRSFIRST (bool)
75+
If set to `True`, directories will be displayed at the top of the filebrowser.
6776
#### GIT (bool)
6877
Set this variable to `True` to enable Git integration. This feature requires [GitPython](https://gitpython.readthedocs.io)
6978
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.

0 commit comments

Comments
 (0)