From 663eea260bb814945c123be0aa4c4b937af3593d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Joakim=20S=C3=B8rensen?= Date: Thu, 22 Oct 2020 14:27:37 +0200 Subject: [PATCH] Update supervisor links (#697) --- docs/add-ons/communication.md | 8 ++++---- docs/add-ons/security.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/add-ons/communication.md b/docs/add-ons/communication.md index e305702c..bb94d837 100644 --- a/docs/add-ons/communication.md +++ b/docs/add-ons/communication.md @@ -9,7 +9,7 @@ There are different ways for communication between add-ons inside Home Assistant We use an internal network that's allowed to communicate with every add-on, including to/from Home Assistant, by using its name or alias. Only add-ons that run on the host network are limited in that they can talk with all internal add-ons by their name, but all other add-ons can't address these add-ons by name. However, using an alias works for both! Names/aliases are used for communication inside Home Assistant. -The name is generated using the following format: `{REPO}_{SLUG}`, e.g., `local_xy` or `3283fh_myaddon`. In this example, `{SLUG}` is defined in an add-on's `config.json` file. You can use this name as the DNS name also, but you need replace any `_` with `-` to have a valid hostname. If an add-on is installed locally, `{REPO}` will be `local`. If the add-on is installed from a Github repository, `{REPO}` is a hashed identifier generated from the GitHub repository's URL (ex: `https://github.com/xy/my_hassio_addons`). See [here](https://github.com/home-assistant/hassio/blob/587047f9d648b8491dc8eef17dc6777f81938bfd/hassio/addons/utils.py#L17) to understand how this identifier is generated. Note that this identifier is required in certain service calls that use the [Supervisor add-on API][supervisor-addon-api]. You can view the repository identifiers for all currently installed add-ons via a GET request to the Supervisor API `addons` endpoint. +The name is generated using the following format: `{REPO}_{SLUG}`, e.g., `local_xy` or `3283fh_myaddon`. In this example, `{SLUG}` is defined in an add-on's `config.json` file. You can use this name as the DNS name also, but you need replace any `_` with `-` to have a valid hostname. If an add-on is installed locally, `{REPO}` will be `local`. If the add-on is installed from a Github repository, `{REPO}` is a hashed identifier generated from the GitHub repository's URL (ex: `https://github.com/xy/my_hassio_addons`). See [here](https://github.com/home-assistant/supervisor/blob/587047f9d648b8491dc8eef17dc6777f81938bfd/hassio/addons/utils.py#L17) to understand how this identifier is generated. Note that this identifier is required in certain service calls that use the [Supervisor add-on API][supervisor-addon-api]. You can view the repository identifiers for all currently installed add-ons via a GET request to the Supervisor API `addons` endpoint. Use `supervisor` for communication with the internal API. @@ -62,6 +62,6 @@ MQTT_PASSWORD=$(bashio::services mqtt "password") [core-api]: /api/rest.md [core-websocket]: /api/websocket.md -[supervisor-api]: https://github.com/home-assistant/supervisor/blob/master/API.md -[supervisor-addon-api]: https://github.com/home-assistant/supervisor/blob/dev/API.md#restful-for-api-addons -[supervisor-services-api]:https://github.com/home-assistant/supervisor/blob/dev/API.md#services-1 +[supervisor-api]: /api/supervisor/endpoints.md +[supervisor-addon-api]: /api/supervisor/endpoints.md#addons +[supervisor-services-api]: /api/supervisor/endpoints.md#service diff --git a/docs/add-ons/security.md b/docs/add-ons/security.md index 95fb9a5e..a5505bf7 100644 --- a/docs/add-ons/security.md +++ b/docs/add-ons/security.md @@ -35,4 +35,4 @@ As a developer, follow the following best practices to make your add-on secure: Instead of allowing users to set new login credential in plain text config, use the Home Assistant [Auth backend][hassio-api-auth]. You can enable the access to API with `auth_api: true`. Now you are able to send the login credential to auth backend and validate it again Home Assistant. -[supervisor-api-auth]: https://github.com/home-assistant/supervisor/blob/dev/API.md#auth--sso-api +[supervisor-api-auth]: /api/supervisor/endpoints.md#auth