Skip to main content

Create an app repository

An app repository can contain one or more apps (formerly known as add-ons). Each app is stored in its own unique folder. To be identified as a repository, the repository must contain a configuration file.

Check the Example app repository for further details.

Installing a repository

A user can add a repository by going to the Supervisor panel in Home Assistant, clicking on the store icon in the top right, copy/paste the URL of your repository into the repository textarea and click on Save.

tip

You can generate a my.home-assistant.io for your users to do this with the click of a button in your readme file.

Repository configuration

Each repository is required to contain repository.yaml at the root in the git repository.

name: Name of repository
url: http://www.example/addons
maintainer: HomeAssistant Team <info@home-assistant.io>
KeyRequiredDescription
nameyesName of the repository
urlnoHomepage of the repository. Here you can explain the various apps.
maintainernoContact info of the maintainer.