mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-07-18 14:56:28 +00:00
Replace Hass.io (#719)
This commit is contained in:
parent
d913214e4c
commit
3c93abab77
@ -117,9 +117,9 @@ The configuration for an add-on is stored in `config.json`.
|
||||
| machine | list | no | Default it support any machine type. You can select that this add-on run only on specific machines. You can use `!` before a machine type to negate it.
|
||||
| url | url | no | Homepage of the add-on. Here you can explain the add-ons and options.
|
||||
| startup | string | yes | `initialize` will start add-on on setup of Home Assistant. `system` is for things like databases and not dependent on other things. `services` will start before Home Assistant, while `application` is started afterwards. Finally `once` is for applications that don't run as a daemon.
|
||||
| webui | string | no | An URL for web interface of this add-on. Like `http://[HOST]:[PORT:2839]/dashboard`, the port needs the internal port, which will be replaced with the effective port. It is also possible to bind the protocol part to a configuration options with: `[PROTO:option_name]://[HOST]:[PORT:2839]/dashboard` and it's looked up if it is `true` and it's going to `https`.
|
||||
| webui | string | no | An URL for the web interface of this add-on. Like `http://[HOST]:[PORT:2839]/dashboard`, the port needs the internal port, which will be replaced with the effective port. It is also possible to bind the protocol part to a configuration options with: `[PROTO:option_name]://[HOST]:[PORT:2839]/dashboard` and it's looked up if it is `true` and it's going to `https`.
|
||||
| boot | string | yes | `auto` by system and manual or only `manual`.
|
||||
| ports | dict | no | Network ports to expose from the container. Format is `"container-port/type": host-port`. If host-port is `null` then the mapping is disabled.
|
||||
| ports | dict | no | Network ports to expose from the container. Format is `"container-port/type": host-port`. If the host port is `null` then the mapping is disabled.
|
||||
| ports_description | dict | no | Network ports description mapping. Format is `"container-port/type": "description of this port"`.
|
||||
| host_network | bool | no | If `true`, the add-on runs on host network.
|
||||
| host_ipc | bool | no | Default `false`. Allow to share the IPC namespace with others.
|
||||
@ -132,9 +132,9 @@ The configuration for an add-on is stored in `config.json`.
|
||||
| hassio_role | str | no | Default `default`. Role-based access to Supervisor API. Available: `default`, `homeassistant`, `backup`, `manager` or `admin`
|
||||
| hassio_api | bool | no | This add-on can access the Supervisor's REST API. Use `http://supervisor`.
|
||||
| homeassistant_api | bool | no | This add-on can access to the Home Assistant REST API proxy. Use `http://supervisor/core/api`.
|
||||
| docker_api | bool | no | Allow read-only access to docker API for add-on. Works only for not protected add-ons.
|
||||
| docker_api | bool | no | Allow read-only access to Docker API for add-on. Works only for not protected add-ons.
|
||||
| privileged | list | no | Privilege for access to hardware/system. Available access: `NET_ADMIN`, `SYS_ADMIN`, `SYS_RAWIO`, `SYS_TIME`, `SYS_NICE`, `SYS_RESOURCE`, `SYS_PTRACE`, `SYS_MODULE` or `DAC_READ_SEARCH`
|
||||
| full_access | bool | no | Give full access to hardware like the privileged mode in docker. Works only for not protected add-ons.
|
||||
| full_access | bool | no | Give full access to hardware like the privileged mode in Docker. Works only for not protected add-ons.
|
||||
| apparmor | bool/string | no | Enable or disable AppArmor support. If it is enable, you can also use custom profiles with the name of the profile.
|
||||
| map | list | no | List of maps for additional Home Assistant folders. Possible values: `config`, `ssl`, `addons`, `backup`, `share` or `media`. Defaults to `ro`, which you can change by adding `:rw` to the end of the name.
|
||||
| environment | dict | no | A dictionary of environment variable to run add-on.
|
||||
|
@ -35,9 +35,9 @@ Right now add-ons will work with images that are stored on Docker Hub (using `im
|
||||
|
||||
## Local build
|
||||
|
||||
If you don't want to use the devcontainer environment, you can still build add-ons locally with Docker. The recommended method is to use the [official build tool][hassio-builder] to create the docker images.
|
||||
If you don't want to use the devcontainer environment, you can still build add-ons locally with Docker. The recommended method is to use the [official build tool][hassio-builder] to create the Docker images.
|
||||
|
||||
Assuming that your addon is in the folder `/path/to/addon` and your docker socket is at `/var/run/docker.sock`, you can build the addon for all supported architectures by running the following:
|
||||
Assuming that your addon is in the folder `/path/to/addon` and your Docker socket is at `/var/run/docker.sock`, you can build the addon for all supported architectures by running the following:
|
||||
```
|
||||
docker run --rm -ti --name hassio-builder --privileged \
|
||||
-v /path/to/addon:/data \
|
||||
@ -73,4 +73,4 @@ docker run --rm -v /tmp/my_test_data:/data -p PORT_STUFF_IF_NEEDED \
|
||||
|
||||
## Logs
|
||||
|
||||
All stdout and stderr are redirected to the Docker logs. The logs can be fetched from the add-on page inside the Hass.io panel in Home Assistant.
|
||||
All stdout and stderr are redirected to the Docker logs. The logs can be fetched from the add-on page inside the Supervisor panel in Home Assistant.
|
||||
|
@ -48,4 +48,4 @@ There are three different types of refresh tokens:
|
||||
|
||||
- *Normal*: These are the tokens that are generated when a user authorizes an application. The application will hold on to these tokens on behalf of the user.
|
||||
- *Long-lived Access Token*: These are refresh tokens that back a long lived access token. They are created internally and never exposed to the user.
|
||||
- *System*: These tokens are limited to be generated and used by system users like Hass.io. They are never exposed to the user.
|
||||
- *System*: These tokens are limited to be generated and used by system users like Home Assistant OS and the Supervisor. They are never exposed to the user.
|
||||
|
@ -3,7 +3,7 @@ title: Integration Configuration
|
||||
sidebar_label: Configuration
|
||||
---
|
||||
|
||||
Integrations can be set up via the user interface by adding support for a config flow to create a config entry. Components that want to support config entries will need to define a Config Flow Handler. This handler will manage the creation of entries from user input, discovery or other sources (like Hass.io).
|
||||
Integrations can be set up via the user interface by adding support for a config flow to create a config entry. Components that want to support config entries will need to define a Config Flow Handler. This handler will manage the creation of entries from user input, discovery or other sources (like Home Assistant OS).
|
||||
|
||||
Config Flow Handlers control the data that is stored in a config entry. This means that there is no need to validate that the config is correct when Home Assistant starts up. It will also prevent breaking changes, because we will be able to migrate configuration entries to new formats if the version changes.
|
||||
|
||||
|
@ -34,7 +34,7 @@ const features = [
|
||||
<b>
|
||||
<a href="docs/misc">Misc</a>.
|
||||
</b>{" "}
|
||||
External APIs, Internationalization, asyncio, Hass.io add-ons,
|
||||
External APIs, Internationalization, asyncio, Home Assistant add-ons,
|
||||
updating documentation.
|
||||
</p>
|
||||
</>
|
||||
|
Loading…
x
Reference in New Issue
Block a user