From 8fc1553eb76abd19dbb9d3d68dacc1f015914f17 Mon Sep 17 00:00:00 2001 From: Paulus Schoutsen Date: Thu, 4 May 2017 23:13:47 -0700 Subject: [PATCH] Revamp hass.io add-on docs --- .../_includes/asides/hassio_navigation.html | 10 +- source/addons/index.html | 2 +- source/hassio/addon_config.markdown | 111 ++++++++++++++++++ source/hassio/addon_development.markdown | 14 +++ source/hassio/addon_publishing.markdown | 12 ++ source/hassio/addon_repository.markdown | 36 ++++++ source/hassio/addon_testing.markdown | 14 +++ source/hassio/create_hassio_addon.markdown | 94 --------------- .../create_hassio_addon_repository.markdown | 24 ---- source/hassio/development.markdown | 18 --- 10 files changed, 194 insertions(+), 141 deletions(-) create mode 100644 source/hassio/addon_config.markdown create mode 100644 source/hassio/addon_development.markdown create mode 100644 source/hassio/addon_publishing.markdown create mode 100644 source/hassio/addon_repository.markdown create mode 100644 source/hassio/addon_testing.markdown delete mode 100644 source/hassio/create_hassio_addon.markdown delete mode 100644 source/hassio/create_hassio_addon_repository.markdown delete mode 100644 source/hassio/development.markdown diff --git a/source/_includes/asides/hassio_navigation.html b/source/_includes/asides/hassio_navigation.html index bdb885f868e..f5a716b278e 100644 --- a/source/_includes/asides/hassio_navigation.html +++ b/source/_includes/asides/hassio_navigation.html @@ -7,16 +7,18 @@ diff --git a/source/addons/index.html b/source/addons/index.html index 9e137982ac6..1950e807b23 100644 --- a/source/addons/index.html +++ b/source/addons/index.html @@ -10,7 +10,7 @@ footer: true regenerate: true --- -

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 " +} +``` + +| Key | Description | +| --- | ----------- | +| name | Name of the repository +| url | Homepage of the repository. Here you can explain the various add-ons. +| maintainer | Contact info of the maintainer. diff --git a/source/hassio/addon_testing.markdown b/source/hassio/addon_testing.markdown new file mode 100644 index 00000000000..19b023d1933 --- /dev/null +++ b/source/hassio/addon_testing.markdown @@ -0,0 +1,14 @@ +--- +layout: page +title: "Local add-on testing" +description: "Instructions how to test your add-on locally." +date: 2017-04-30 13:28 +sidebar: true +comments: false +sharing: true +footer: true +--- + +## {% linkable_title Logs %} + +All stdout and stderr is redirected to the Docker logs. The logs can be fetched from the add-on page inside the Hass.io panel in Home Assistant. diff --git a/source/hassio/create_hassio_addon.markdown b/source/hassio/create_hassio_addon.markdown deleted file mode 100644 index 212e096ec59..00000000000 --- a/source/hassio/create_hassio_addon.markdown +++ /dev/null @@ -1,94 +0,0 @@ ---- -layout: page -title: "Create an add-on for Hass.io" -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 are docker container they run a script and do some things. User are able to set a add-on specific options. - -### {% linkable_title Add-on folder %} - -``` -addon_name: - Dockerfile - config.json - run.sh -``` - -All add-ons are based on Alpine Linux 3.5. You can use `FROM %%BASE_IMAGE%%` inside your docker file to build the right arch or for automatic build with our scripts. - -Your Docker need also a env variable `VERSION` with the version of the add-on. With our build system include this line: -``` -ENV VERSION %%VERSION%% -``` - -As a user might run many add-ons, it is encouraged to try to stick to Bash scripts if you're doing simple things. - -### {% linkable_title Add-on config %} - -```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 have all available options with default value. If you want to set a value to requered and need to be set from user before it start the addon, set it to null. We support arrays for single deeps. - -```json -{ - "message": "custom things", - "logins": [ - { "username": "beer", "password": "123456" }, - { "username": "cheep", "password": "654321" } - ], - "random": ["haha", "hihi", "huhu", "hghg"], - "link": "http://blebla.com/" -} -``` - -The `schmema` look like the `options` but describe how we should validate the user input. For example above: - -```json -{ - "message": "str", - "logins": [ - { "username": "str", "password": "str" } - ], - "random": ["str"], - "link": "url" -} -``` - -We support: -- str -- bool -- int -- float -- email -- url - -### {% linkable_title SSL %} - -Default you can use `fullchain.pem` and `privkey.pem` from `/ssl` for you stuff. Your SSL addon should also create default this files. - -### {% linkable_title Need to know %} -`/data` is a volume with a persistant store. `/data/options.json` have the user config inside. You can use `jq` inside shell script to parse this data. diff --git a/source/hassio/create_hassio_addon_repository.markdown b/source/hassio/create_hassio_addon_repository.markdown deleted file mode 100644 index fa71064d5ec..00000000000 --- a/source/hassio/create_hassio_addon_repository.markdown +++ /dev/null @@ -1,24 +0,0 @@ ---- -layout: page -title: "Create an add-on repository for Hass.io" -description: "Add-ons repositories." -date: 2017-04-30 13:28 -sidebar: true -comments: false -sharing: true -footer: true ---- - -Look to our example [repository](https://github.com/home-assistant/hassio-addons-example). - -Add-ons repository can have multible add-ons with diferents folders or it can be a single add-on. It is importent that you add the json file to root. - -Add a `repository.json` to the root of your git repository with: - -```json -{ - "name": "Needed, Name of repository", - "url": "http://www.example/addons", - "maintainer": "HomeAssistant Team " -} -``` diff --git a/source/hassio/development.markdown b/source/hassio/development.markdown deleted file mode 100644 index bcb7f084459..00000000000 --- a/source/hassio/development.markdown +++ /dev/null @@ -1,18 +0,0 @@ ---- -layout: page -title: "Hass.io development" -description: "How to get started with Hass.io development." -date: 2017-04-30 13:28 -sidebar: true -comments: false -sharing: true -footer: true ---- - -Seen all the Hass.io stuff and want to built on top of it? That's awesome. - -Before you get started with development, get familiar with [the architecture][arch]. - -[Placeholder] - -[arch]: /hassio/architecture/ \ No newline at end of file