Skip to content

Commit 9f29a56

Browse files
pvizelipvizeli
authored
Update configurator documentation
1 parent 39702dc commit 9f29a56

File tree

1 file changed

+3
-93
lines changed

1 file changed

+3
-93
lines changed

‎source/_addons/configurator.markdown

Lines changed: 3 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ featured: true
1111
og_image: /images/hassio/screenshots/addon-hass-configurator.png
1212
---
1313

14-
You can use this add-on to add a browser-based file editor to your Hass.io installation. By default it will listen on port `3218` of the host Hass.io is running on.
14+
You can use this add-on to add a browser-based file editor to your Hass.io installation. By default it will be available over Ingress only.
1515

1616
More information and a standalone version for regular Home Assistant installations can be found in the [GitHub repository](https://github.com/danielperna84/hass-configurator).
1717

@@ -27,8 +27,6 @@ Screenshot of the HASS Configurator.
2727
- Stage, stash and commit changes in Git repositories, create and switch between branches, push to remotes, view diffs.
2828
- Lists with available entities, triggers, events, conditions and services.
2929
- Restart Home Assistant directly with the click of a button. Reloading groups, automations, etc. can be done as well. An API password is required.
30-
- SSL/TLS support.
31-
- Optional authentication and IP filtering for added security.
3230
- Direct links to Home Assistant documentation and icons.
3331
- Execute shell commands within the add-on container.
3432
- Editor settings are saved in your browser.
@@ -38,68 +36,12 @@ Screenshot of the HASS Configurator.
3836

3937
```json
4038
{
41-
"username": "admin",
42-
"password": "secret",
43-
"ssl": false,
44-
"certfile": "fullchain.pem",
45-
"keyfile": "privkey.pem",
46-
"verify_hostname": false,
47-
"allowed_networks": [
48-
"192.168.0.0/16",
49-
"172.30.0.0/16"
50-
],
51-
"banned_ips": [
52-
"8.8.8.8"
53-
],
54-
"banlimit": 0,
55-
"ignore_pattern": [
56-
"__pycache__"
57-
],
5839
"dirsfirst": false,
5940
"enforce_basepath": false,
60-
"notify_service": "persistent_notification.create"
6141
}
6242
```
6343

6444
{% configuration %}
65-
username:
66-
description: Set a username so that access your configuration is protected.
67-
required: true
68-
type: string
69-
password:
70-
description: Set a password for access.
71-
required: true
72-
type: string
73-
ssl:
74-
description: Enable or Disable SSL/TLS for the editor.
75-
required: true
76-
type: boolean
77-
default: false
78-
certfile:
79-
description: Set the path the your SSL certificate if the ssl-option is set to `true`.
80-
required: true
81-
type: string
82-
keyfile:
83-
description: Set the path the your SSL private key if the ssl-option is set to `true`.
84-
required: true
85-
type: string
86-
allowed_networks:
87-
description: Limit access to the configurator by adding allowed IP addresses/networks to the list.
88-
required: true
89-
type: string
90-
banned_ips:
91-
description: List of statically banned IP addresses.
92-
required: true
93-
type: string
94-
banlimit:
95-
description: Ban access from IPs after `banlimit` failed login attempts, setting the value to 0 disables this feature. Restart the add-on to clear the list of banned IP addresses.
96-
required: true
97-
type: integer
98-
default: 0
99-
ignore_pattern:
100-
description: Regex of files and folders to ignore in the UI.
101-
required: true
102-
type: string
10345
dirsfirst:
10446
description: List directories before files in the file browser.
10547
required: true
@@ -110,40 +52,8 @@ enforce_basepath:
11052
required: true
11153
type: boolean
11254
default: false
113-
notify_service:
114-
description: Specify a custom notify-service to be used to push notifications.
115-
required: true
116-
type: string
117-
loglevel:
118-
description: The log level the configurator should run with. Valid values are `debug`, `info`, `warning`, `error`, `critical`.
119-
required: false
120-
type: string
121-
default: info
122-
sesame:
123-
description: Secret token to dynamically allow access from the IP the request originates from. Open your bookmark https://hassio.yourdomain.com:3218/somesecretnobodycanguess while `allowed_networks` is set to `[]` and your IP will get whitelisted. You can use the Network status menu to revoke IP addresses for which access has been granted. Regular authentication is still required.
124-
required: false
125-
type: string
126-
sesame_totp_secret:
127-
description: Like the `sesame` option, but instead as Base32 encoded secret string must be provided. This string then can be added to a TOTP App like Google Authenticator. This way you get a 6-digit `sesame` that changes every 30 seconds.
128-
required: false
129-
type: string
13055
{% endconfiguration %}
13156

132-
<p class='note warning'>
133-
Be careful when setting up port forwarding to the configurator while embedding into Home Assistant. If you don't restrict access by requiring authentication and/or blocking based on client IP addresses, your configuration will be exposed to the internet!
134-
</p>
135-
136-
### {% linkable_title Embedding into Home Assistant %}
137-
138-
Using the Home Assistant component [panel_iframe](/components/panel_iframe/) it is possible to embed the configurator directly into Home Assistant, allowing you to modify your configuration from within the Home Assistant frontend.
139-
140-
An example configuration would look like this:
141-
142-
```yaml
143-
panel_iframe:
144-
configurator:
145-
title: Configurator
146-
icon: mdi:wrench
147-
url: http://hassio.local:3218
148-
```
57+
### {% linkable_title Old port based Access %}
14958

59+
You can set a network Port and the Add-on listens on that Port with Home Assistant user credential. That is as a backup if you are not able to connect to Home Assistant anymore. Today, you can restart Home Assistant with broken config, but maybe some times usefully.

0 commit comments

Comments
 (0)