Add-on: Configurator

pvizeli · web-flow · commit 5536d73a4595 · 2017-09-26T12:17:13.000+02:00
diff --git a/source/_addons/configurator.markdown b/source/_addons/configurator.markdown
@@ -0,0 +1,68 @@
+---
+layout: page
+title: "Configurator"
+description: "Browser-based configuration file editor for Home Assistant."
+date: 2017-09-25 14:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+---
+
+As long as a fully featured configuration GUI for Home Assistant is still under development, 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.  
+More information and a standalone version for regular Home Assistant installations can be found in the original repository at https://github.com/danielperna84/hass-configurator.
+
+![Screenshot](https://github.com/danielperna84/hass-configurator/blob/master/hass-poc-configurator.png)
+
+### {% linkable_title Feature list %}
+
+- Web-Based editor to modify your files with syntax highlighting.
+- Upload and download files.
+- Stage and commit changes in Git repositories, create and switch between branches, push to remotes.
+- Lists of available triggers, events, entities, conditions and services. Selected element gets inserted into the editor at the last cursor position.
+- Restart Home Assitant directly with the click of a button. Reloading groups, automations etc. can be done as well. An API-password is required.
+- SSL support.
+- Optional authentication and IP filtering for added security.
+- Direct links to Home Assistant documentation and icons.
+- Execute shell commands within the add-on container.
+- Modified editor settings can be saved using [localStorage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage).
+
+### {% linkable_title Add-on Configuration %}
+
+```json
+{
+  "homeassistant_api": "http://homeassistant:8123/api",
+  "homeassistant_password": "",
+  "credentials": "admin:secret",
+  "certfile": "fullchain.pem",
+  "keyfile": "privkey.pem",
+  "ssl": false,
+  "allowed_networks": ["192.168.0.0/16"],
+  "banned_ips": ["8.8.8.8"],
+  "ignore_pattern": ["__pycache__"]
+}
+```
+
+- **homeassistant_api** (*Optional*): The configurator fetches some data from your running Home Assistant instance. If the API is not available through the default URL, modify this variable to fix this.
+- **homeassistant_password** (*Optional*): If you plan on using API functions, you have to set your API password. Calling services of Home Assistant is prohibited without authentication.
+- **credentials** (*Optional*): Set credentials in the form of `"username:password"` so access to your configuration is protected.
+- **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.
+- **ignore_pattern** (*Optional*): Files and folders to ignore in the UI.
+
+### {% Embedding into Home-Assistant %}
+Home Assistant has the [panel_iframe](https://home-assistant.io/components/panel_iframe/) component. With this it is possible to embed the configurator directly into Home Assistant, allowing you to modify your configuration within the Home Assistant frontend.  
+An example configuration would look like this:
+
+```yaml
+panel_iframe:
+  configurator:
+    title: Configurator
+    icon: mdi:wrench
+    url: http://hassio.local:3218
+```
+
+<p class='note'>
+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!
+</p>
