Skip to content

Installation

Jump to bottom
Daniel Perna edited this page Nov 23, 2019 · 4 revisions

The configurator requires Python 3 to be installed on your system. There are no strictly required dependencies on Python modules that are not part of the standard library. All the JavaScript libraries and fonts are loaded from CDN until (and including) version 0.3.7 (which means the configurator does not work when you are offline). The optional GitPython and pyotp modules will be automatically installed when installing the configurator via the pip command.
After performing one of the standalone installation methods, you might want to proceed by reading the Daemonizing instructions.

Standalone installation (using pip, recommended)

As of version 0.3.5 the configurator is available as a package on PyPI. To install it, execute the command pip install hass-configurator. This will add the executable to your systems default bin-path (like /bin on Linux).
To start the configurator, execute hass-configurator in your shell. Append the -h flag to see which options are available.
A particularily useful command is hass-configurator -seb ${PWD}, which starts the configurator in standalone-mode (it hides some Home Assistant related panels and doesn't try to communicate with the Home Assistant API), and locks access to the files and folders within the folder the command has been executed from.

Standalone installation (legacy, version 0.3.7, no more updates planned)

  • Copy configurator.py to your Home Assistant configuration directory (e.g /home/homeassistant/.homeassistant)
    • wget https://raw.githubusercontent.com/danielperna84/hass-configurator/master/configurator.py or
    • curl -O https://raw.githubusercontent.com/danielperna84/hass-configurator/master/configurator.py
  • Make it executable (sudo chmod 755 configurator.py)
  • (Optional) Set the GIT variable in configurator.py to True if GitPython is installed on your system
  • (Optional) Install pyotp if you want to use the time based SESAME feature (see below).
  • Execute it (sudo ./configurator.py)
  • To terminate the process do the usual CTRL+C, maybe once or twice

Docker

You can find Docker images for the configurator on dockerhub. For usage visit the repository.

Clone this wiki locally