jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-09 18:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

provide a bit more context on addon slug (#514)

Browse Source
This commit is contained in:
Issac 2020-05-11 16:00:18 +03:00 committed by GitHub
parent 3f07bf6da4
commit b31d871c6a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/add-ons/configuration.md
View File

@ -108,7 +108,7 @@ The config for an add-on is stored in `config.json`.
| --- | ---- | -------- | ----------- |
| name | string | yes | Name of the add-on
| version | string | yes | Version of the add-on
| slug | string | yes | Slug of the add-on
| slug | string | yes | Slug of the add-on. This needs to be unique in scope to the [repository](repository.md) that the add-on is published in, and URI friendly.
| description | string | yes | Description of the add-on
| arch | list | yes | List of supported arch: `armhf`, `armv7`, `aarch64`, `amd64`, `i386`.
| machine | list | no | Default it support any machine type. You can select that this add-on run only on specific machines.
@ -161,7 +161,6 @@ The config for an add-on is stored in `config.json`.
| stage | string | no | Default `stable`. Flag add-on with follow attribute: `stable`, `experimental`, `deprecated`
| init | bool | no | Default `True`. Make it possible to disable the docker default system init because the image have his own init system.
### Options / Schema
The `options` dictionary 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, and it show it inside default values. Only nested arrays and dictionaries are supported with a deep of two size. If you want make an option optional, put `?` to the end of data type, otherwise it will be a required value.