Add-ons are extensions for your Home Assistant installation.
+Add-ons for Hass.io allows the user to extend the functionality around Home Assistant. This can be running an application that Home Assistant can integrate with (like an MQTT broker) or to share the configuration via Samba for easy editing from other computers. Add-ons can be configured via the Hass.io panel in Home Assistant.
{% assign addons = site.addons | sort: 'title' %} diff --git a/source/hassio/addon_config.markdown b/source/hassio/addon_config.markdown new file mode 100644 index 00000000000..9c91d81dc2e --- /dev/null +++ b/source/hassio/addon_config.markdown @@ -0,0 +1,111 @@ +--- +layout: page +title: "Add-On Configuration" +description: "Steps on how-to create an add-on for Hass.io." +date: 2017-04-30 13:28 +sidebar: true +comments: false +sharing: true +footer: true +--- + +Each add-on is stored in a folder. The file structure looks like this: + +``` +addon_name/ + Dockerfile + config.json + run.sh +``` + +## {% linkable_title Add-on script %} + +As with every Docker container, you will need a script to run when the container is started. A user might run many add-ons, so it is encouraged to try to stick to Bash scripts if you're doing simple things. + +When developing your script: + + - `/data` is a volume for persistent storage. + - `/data/options.json` contains the user configuration. You can use `jq` inside your shell script to parse this data. + +```bash +echo '{ "target": "beer" }' | jq -r ".target" +``` + +## {% linkable_title Add-on Docker file %} + +All add-ons are based on Alpine Linux 3.5. Hass.io will automatically substitute the right base image based on the machine architecture. The Dockerfile is also required to have a VERSION environment variable which we will substitute with the version of the add-on. + +``` +FROM %%BASE_IMAGE%% + +ENV VERSION %%VERSION%% +ENV LANG C.UTF-8 + +# Install requirements for add-on +RUN apk add --no-cache jq + +# Copy data for add-on +COPY run.sh / +RUN chmod a+x /run.sh + +CMD [ "/run.sh" ] +``` + +## {% linkable_title Add-on config %} + +The config for an add-on is stored in `config.json`. + +```json +{ + "name": "xy", + "version": "1.2", + "slug": "folder", + "description": "long descripton", + "startup": "before|after|once", + "boot": "auto|manual", + "ports": { + "123/tcp": 123 + }, + "map": ["config", "ssl", "addons", "backup"], + "options": {}, + "schema": {}, + "image": "repo/{arch}-my-custom-addon" +} +``` + +### {% linkable_title Options / Schema %} + +The `options` dict contains all available options and their default value. Set the default value to `null` if the value is required to be given by the user before the add-on can start. Only non-nested arrays are supported. + +```json +{ + "message": "custom things", + "logins": [ + { "username": "beer", "password": "123456" }, + { "username": "cheep", "password": "654321" } + ], + "random": ["haha", "hihi", "huhu", "hghg"], + "link": "http://blebla.com/" +} +``` + +The `schema` looks like `options` but describes how we should validate the user input. For example: + +```json +{ + "message": "str", + "logins": [ + { "username": "str", "password": "str" } + ], + "random": ["str"], + "link": "url" +} +``` + +We support: +- str +- bool +- int +- float +- email +- url diff --git a/source/hassio/addon_development.markdown b/source/hassio/addon_development.markdown new file mode 100644 index 00000000000..92810a8f971 --- /dev/null +++ b/source/hassio/addon_development.markdown @@ -0,0 +1,14 @@ +--- +layout: page +title: "Developing an add-on" +description: "Steps on how-to create an add-on for Hass.io." +date: 2017-04-30 13:28 +sidebar: true +comments: false +sharing: true +footer: true +--- + +Add-ons for Hass.io allows the user to extend the functionality around Home Assistant. This can be running an application that Home Assistant can integrate with (like an MQTT broker) or to share the configuration via Samba for easy editing from other computers. Add-ons can be configured via the Hass.io panel in Home Assistant. + +Under the hood, add-ons are Docker images published in Docker hub. Developers can create GitHub repositories that contain multiple references to add-ons for easy sharing with the community. diff --git a/source/hassio/addon_publishing.markdown b/source/hassio/addon_publishing.markdown new file mode 100644 index 00000000000..a20a3e8d83a --- /dev/null +++ b/source/hassio/addon_publishing.markdown @@ -0,0 +1,12 @@ +--- +layout: page +title: "Publishing your add-on" +description: "Steps on how-to create an add-on for Hass.io." +date: 2017-04-30 13:28 +sidebar: true +comments: false +sharing: true +footer: true +--- + +[placeholder] \ No newline at end of file diff --git a/source/hassio/addon_repository.markdown b/source/hassio/addon_repository.markdown new file mode 100644 index 00000000000..1fa271ad327 --- /dev/null +++ b/source/hassio/addon_repository.markdown @@ -0,0 +1,36 @@ +--- +layout: page +title: "Create an add-on repository" +description: "Add-ons repositories." +date: 2017-04-30 13:28 +sidebar: true +comments: false +sharing: true +footer: true +--- + +Add-ons repository can contain one or more add-ons. Each add-on is stored in it's own unique folder. For it to be indentified as a repository, a repository contains a configuration file. + +[Example add-on repository](https://github.com/home-assistant/hassio-addons-example). + +## Installing a repository + +A user can add a repository by going to the Hass.io panel in Home Assistant, clicking on the store icon in the top right, copy/paste the url of your repostory into the repository textarea and click on "Save". + +## Repository configuration + +Each repository is required to contain `repository.json` at the root of the Git repository. + +```json +{ + "name": "Name of repository", + "url": "http://www.example/addons", + "maintainer": "HomeAssistant Team