Add HASS Configurator to ecosystem #2225
Conversation
|
|
||
| ### {% linkable_title Configuration UI for Home Assistant %} | ||
|
|
||
| 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 HASS' 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. |
There was a problem hiding this comment.
Suggest replacing HASS with Home Assistant.
| - Upload and download files | ||
| - Git integration | ||
| - Lists of available triggers, events, entities, conditions and services. Selected element gets inserted into the editor at the last cursor position. | ||
| - Check valid configuration and restart HASS directly with the click of a button |
There was a problem hiding this comment.
Suggest replacing HASS with Home Assistant.
| - Check valid configuration and restart HASS directly with the click of a button | ||
| - SSL support | ||
| - Optional authentication and IP filtering for additional security | ||
| - Direct links to HASS documentation |
There was a problem hiding this comment.
Suggest replacing HASS with Home Assistant.
|
|
||
| ### {% linkable_title Installation (Linux, OS X) %} | ||
| There are no dependencies on Python modules that are not part of the standard library. And all the fancy JavaScript libraries are loaded from CDN (which means this doesn't work when you're offline). | ||
| - Copy [configurator.py](https://github.com/danielperna84/hass-poc-configurator/blob/master/configurator.py) to your HASS configuration directory (e.g /home/hass/.homeassistant) |
There was a problem hiding this comment.
Suggest replacing HASS with Home Assistant.
| - Make it executable: `sudo chmod 755 configurator.py` | ||
| - (Optional) Set the `GIT` variable in configurator.py to `True` if [GitPython](https://gitpython.readthedocs.io/) is installed on your system. This is required if you want to make use of the Git integration. | ||
| - Execute it: `sudo ./configurator.py` | ||
| - To terminate the process do the usual `CTRL+C`, maybe once or twice |
| #### LISTENPORT (integer) | ||
| The port the service is listening on. By default it is using `3218`, but you can change this if you need to. | ||
| #### BASEPATH (string) | ||
| It is possible to place configurator.py somewhere else. Set the `BASEPATH` to something like `"/home/hass/.homeassistant"`, and no matter where you are running the configurator from, it will start serving files from there. This is needed if you plan on running the configurator with systemd or some other way of daemonizing the configurator. |
There was a problem hiding this comment.
Suggest changing this to /home/homeassistant/.homeassistant to match the HASSbian users.
| #### SSL_CERTIFICATE / SSL_KEY (string) | ||
| If you are using SSL, set the paths to your SSL files here. This is similar to the SSL setup you can do in HASS. | ||
| #### HASS_API (string) | ||
| The configurator fetches some data from your running HASS instance. If the API is not available through the default URL, modify this variable to fix this. |
There was a problem hiding this comment.
Suggest changing this to Home Assistant and in a few more places down below.
| @@ -102,7 +102,7 @@ Since the configurator script on its own is no service, you will have to take so | |||
| 2. If your system is using systemd (that's usually what you'll find on a Raspberry PI), there's a [template file](https://github.com/danielperna84/hass-poc-configurator/blob/master/hass-poc-configurator.systemd) you can use and then apply the same process to integrate it as mentioned in the [HASS documentation](https://home-assistant.io/docs/autostart/systemd/). If you use this method you have to set the `BASEPATH` variable according to your environment. | |||
| 3. If you have [supervisor](http://supervisord.org/) running on your system, [hass-poc-configurator.supervisor](https://github.com/danielperna84/hass-poc-configurator/blob/master/hass-poc-configurator.supervisor) would be an example configuration you could use to control the configurator. | |||
| 4. A tool called [tmux](https://tmux.github.io/), which should be pre-installed with recent AIO installers. | |||
There was a problem hiding this comment.
Tmx is also pre-installed with the HASSbian image.:)
|
Looks good and can be merged. Up to you if you would like to mention the HASSbian image along side AiO installer under tmux. :) |
|
Uhm, I actually though it was the AiO that had tmux. Could it be I'm mixing those two up and tmux actually is not part of the AiO and part of HASSbian instead? |
|
Checked the install script for AiO and I can't find any mention of tmux. I think it's only in later versions of HASSbian :) |
|
Ok, took that out. Thanks for investigating. :) |
|
If it is considered stable, you might want to consider renaming your repo to no longer have 'proof of concept' in the name. GitHub will auto redirect all old urls to the new name. |
|
I didn't know that. Thanks for the hint. 🙂 |
|
Uhm, could it be that I should have used the current-branch as the target for this PR? My documentations for components/platforms always ended up online when the PR was against current and the new HASS release came out. This time though it seems to be missing. |
|
Yes, you should have pointed it at |
|
Ah, ok. Then I'll just leave it this way since it's not urgent. Didn't notice the cut was made a few days before. |
Description:
Since my HASS Configurator has reached a stable state, I feel it's time to add it to the ecosystem section of the HASS site.
I don't think the amount of content justifies splitting the documentation up into several files. Hence the single-file-approach.
This has one drawback though, caused by the possible bug in Issue #2224 . It won't be listed in the topics right now. I assume as soon as the bug is fixed, this will be resolved automatically.
Any comments, suggested changes, rephrasing etc.? 🙂