jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-26 10:46:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update addon_config.markdown

Browse Source
This commit is contained in:
Pascal Vizeli 2017-05-09 15:47:49 +02:00 committed by GitHub
parent 4c4f26f993
commit e821605d0c
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
source/hassio/addon_config.markdown
View File

@ -61,6 +61,7 @@ The config for an add-on is stored in `config.json`.
"version": "1.2", "version": "1.2",
"slug": "folder", "slug": "folder",
"description": "long descripton", "description": "long descripton",
"arch": ["amd64"],
"url": "website with more information about add-on (ie a forum thread for support)", "url": "website with more information about add-on (ie a forum thread for support)",
"startup": "before|after|once", "startup": "before|after|once",
"boot": "auto|manual", "boot": "auto|manual",
@ -74,6 +75,16 @@ The config for an add-on is stored in `config.json`.
} }
``` ```
| Key | Required | Description |
| --- | -------- | ----------- |
| name | yes | Name of the addon
| version | yes | Version of the addon
| slug | yes | Slug of the addon
| description | yes | Description of the addon
| arch | no | List of supported arch: `armhf`, `aarch64`, `amd64`, `i386`. Default all.
| url | no | Homepage of the addon. Here you can explain the add-ons and options.
| startup | yes | `before` homeassistant will start. `after` homeassistant will start or `once` for application they don't run as deamon.
### {% linkable_title Options / Schema %} ### {% 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. 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.