diff --git a/configurator/CHANGELOG.md b/configurator/CHANGELOG.md index 5514aafd2da..1937026447c 100644 --- a/configurator/CHANGELOG.md +++ b/configurator/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +## 3.4 + +- Adds documentation to add-on repository +- Small code styling changes + ## 3.3 - Fix issue with aarch64 and ingress diff --git a/configurator/Dockerfile b/configurator/Dockerfile index e50b0016328..1d3e73880ca 100644 --- a/configurator/Dockerfile +++ b/configurator/Dockerfile @@ -6,11 +6,12 @@ ARG CONFIGURATOR_VERSION ARG HASSIO_AUTH_VERSION RUN apk add --no-cache \ git nginx nginx-mod-http-lua lua-resty-http \ - && git clone --depth 1 -b ${HASSIO_AUTH_VERSION} https://github.com/home-assistant/hassio-auth \ - && cp -f hassio-auth/nginx-frontend/ha-auth.lua /etc/nginx/ \ - && cp -f hassio-auth/nginx-frontend/example/nginx-ingress.conf /etc/nginx/ \ - && rm -fr /usr/src/hassio-auth \ - && pip install hass-configurator==${CONFIGURATOR_VERSION} + && git clone --depth 1 -b ${HASSIO_AUTH_VERSION} \ + "https://github.com/home-assistant/hassio-auth" \ + && cp -f hassio-auth/nginx-frontend/ha-auth.lua /etc/nginx/ \ + && cp -f hassio-auth/nginx-frontend/example/nginx-ingress.conf /etc/nginx/ \ + && rm -fr /usr/src/hassio-auth \ + && pip install hass-configurator==${CONFIGURATOR_VERSION} # Copy data COPY data/configurator.conf /etc/ diff --git a/configurator/README.md b/configurator/README.md new file mode 100644 index 00000000000..a388601ba73 --- /dev/null +++ b/configurator/README.md @@ -0,0 +1,107 @@ +# Hass.io Core Add-on: Configurator + +Browser-based configuration file editor for Home Assistant. + +![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] ![Supports i386 Architecture][i386-shield] + +![Configurator in the Home Assistant Frontend][screenshot] + +## About + +The Configurator is a small web-app (you access it via web browser) that provides a +filesystem-browser and text-editor to modify files on the machine the Configurator is +running on. It has been created to allow easy configuration of Home Assistant. + +It is powered by Ace editor, which supports syntax highlighting for various +code/markup languages. YAML files (the default language for Home Assistant +configuration files) will be automatically checked for syntax errors while editing. + +## Features + +- Web-based editor to modify your files with syntax highlighting and YAML linting. +- Upload and download files. +- Stage, stash and commit changes in Git repositories, create and switch between + branches, push to remotes, view diffs. +- Lists with available entities, triggers, events, conditions and services. +- Restart Home Assistant directly with the click of a button. Reloading groups, + automations, etc. can be done as well. An API password is required. +- Direct links to Home Assistant documentation and icons. +- Execute shell commands within the add-on container. +- Editor settings are saved in your browser. +- And much moreā€¦ + +## Installation + +The installation of this add-on is straightforward and easy to do. + +1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**. +2. Find the "Configurator" add-on and click it. +3. Click on the "INSTALL" button. + +## How to use + +In general, this add-on requires no configuration from your end. + +1. Toggle the "Show in sidebar" option, which adds the Configurator to the main menu. +2. Start the add-on. +3. Refresh your browser, the "Configurator" is now visible in the sidebar. +4. Click on the "Configurator" menu option and start configuring! + +## Configuration + +Add-on configuration: + +```json +{ + "dirsfirst": false, + "enforce_basepath": false, + "ignore_pattern": [ + "__pycache__" + ] +} +``` + +### Option: `dirsfirst` (required) + +This option allows you to list directories before files in the file browser tree. + +Set it to `true` to list files first, `false` otherwise. + +### Option: `enforce_basepath` (required) + +If set to `true`, access is limited to files within the `/config` directory. + +### Option: `ignore_pattern` (required) + +This option allows you to hide files and folders from the file browser tree. +By default, it hides the `__pycache__` folders. + +## Known issues and limitations + +- This add-on is, by default, configured for use with Hass.io Ingress. If you + wish to access the add-on via a its own port directly, you can simply + assign a port in the "Network" section of the add-on setting page. + +## Support + +Got questions? + +You have several options to get them answered: + +- The [Home Assistant Discord Chat Server][discord]. +- The Home Assistant [Community Forum][forum]. +- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit] + +In case you've found an bug, please [open an issue on our GitHub][issue]. + +[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg +[discord]: https://discord.gg/c5DvZ4e +[forum]: https://community.home-assistant.io +[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg +[issue]: https://github.com/home-assistant/hassio-addons/issues +[reddit]: https://reddit.com/r/homeassistant +[repository]: https://github.com/hassio-addons/repository +[screenshot]: https://github.com/home-assistant/hassio-addons/raw/master/configurator/images/screenshot.png diff --git a/configurator/config.json b/configurator/config.json index 49655322c7b..d9a4faa6f59 100644 --- a/configurator/config.json +++ b/configurator/config.json @@ -1,10 +1,16 @@ { "name": "Configurator", - "version": "3.3", + "version": "3.4", "slug": "configurator", - "description": "Browser-based configuration file editor for Home Assistant.", + "description": "Browser-based configuration file editor for Home Assistant", "url": "https://home-assistant.io/addons/configurator", - "arch": ["armhf", "armv7", "aarch64", "amd64", "i386"], + "arch": [ + "armhf", + "armv7", + "aarch64", + "amd64", + "i386" + ], "homeassistant": "0.91.1", "startup": "application", "webui": "http://[HOST]:[PORT:8080]", @@ -32,7 +38,9 @@ "schema": { "dirsfirst": "bool", "enforce_basepath": "bool", - "ignore_pattern": ["str"] + "ignore_pattern": [ + "str" + ] }, "image": "homeassistant/{arch}-addon-configurator" } diff --git a/configurator/images/screenshot.png b/configurator/images/screenshot.png new file mode 100644 index 00000000000..7fa3d7f3c8d Binary files /dev/null and b/configurator/images/screenshot.png differ