Skip to content

Latest commit

 

History

History
110 lines (76 loc) · 3.9 KB

README.md

File metadata and controls

110 lines (76 loc) · 3.9 KB

Hass.io Core Add-on: Configurator

Browser-based configuration file editor for Home Assistant.

Supports aarch64 Architecture Supports amd64 Architecture Supports armhf Architecture Supports armv7 Architecture Supports i386 Architecture

Configurator in the Home Assistant Frontend

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 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

Follow these steps to get the add-on installed on your system:

  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:

{
  "dirsfirst": false,
  "enforce_basepath": false,
  "ignore_pattern": [
    "__pycache__"
  ],
  "ssh_keys": []
}

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.

Option: ssh_keys (required)

A list of filenames containing SSH private keys. These can be used to allow for access to remote git repositories.

Known issues and limitations

  • This add-on can only be used via Ingress and has no direct access.

Support

Got questions?

You have several options to get them answered:

In case you've found a bug, please open an issue on our GitHub.