From a9f3118a7d9238341a579405ea66e0c92dcc9daa Mon Sep 17 00:00:00 2001 From: Jens Langhammer Date: Mon, 26 Oct 2020 22:03:37 +0100 Subject: [PATCH] docs: add home-assistant integration docs --- .../services/home-assistant/index.md | 48 +++++++++++++++++++ docs/integrations/services/sonarr/index.md | 4 +- swagger.yaml | 9 ++-- 3 files changed, 55 insertions(+), 6 deletions(-) create mode 100644 docs/integrations/services/home-assistant/index.md diff --git a/docs/integrations/services/home-assistant/index.md b/docs/integrations/services/home-assistant/index.md new file mode 100644 index 000000000..9de21989d --- /dev/null +++ b/docs/integrations/services/home-assistant/index.md @@ -0,0 +1,48 @@ +# Home-Assistant Integration + +## What is Home-Assistant + +From https://www.home-assistant.io/ + +!!! note "" + Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts. Perfect to run on a Raspberry Pi or a local server. + + +## Preparation + +The following placeholders will be used: + +- `hass.company` is the FQDN of the Home-Assistant install. +- `passbook.company` is the FQDN of the passbook install. + +!!! note + + This setup uses https://github.com/BeryJu/hass-auth-header and the passbook proxy for authentication. When this [PR](https://github.com/home-assistant/core/pull/32926) is merged, this will no longer be necessary. + +## Home-Assistant + +This guide requires https://github.com/BeryJu/hass-auth-header, which can be installed as described in the Readme. + +Afterwards, make sure the `trusted_proxies` setting contains the IP(s) of the Host(s) passbook is running on. + +## passbook + +Create a Proxy Provider with the following values + +- Internal host + + If Home-Assistant is running in docker, and you're deploying the passbook proxy on the same host, set the value to `http://homeassistant:8123`, where Home-Assistant is the name of your container. + + If Home-Assistant is running on a different server than where you are deploying the passbook proxy, set the value to `http://hass.company:8123`. + +- External host + + Set this to the external URL you will be accessing Home-Assistant from. + +Create an application in passbook and select the provider you've created above. + +## Deployment + +Create an outpost deployment for the provider you've created above, as described [here](../../../outposts/outposts.md). Deploy this Outpost either on the same host or a different host that can access Home-Assistant. + +The outpost will connect to passbook and configure itself. diff --git a/docs/integrations/services/sonarr/index.md b/docs/integrations/services/sonarr/index.md index b4d435f5e..f6b219942 100644 --- a/docs/integrations/services/sonarr/index.md +++ b/docs/integrations/services/sonarr/index.md @@ -18,7 +18,7 @@ The following placeholders will be used: - `sonarr.company` is the FQDN of the Sonarr install. - `passbook.company` is the FQDN of the passbook install. -Create an application in passbook. Create a Proxy Provider with the following values +Create a Proxy Provider with the following values - Internal host @@ -30,6 +30,8 @@ Create an application in passbook. Create a Proxy Provider with the following va Set this to the external URL you will be accessing Sonarr from. +Create an application in passbook and select the provider you've created above. + ## Deployment Create an outpost deployment for the provider you've created above, as described [here](../../../outposts/outposts.md). Deploy this Outpost either on the same host or a different host that can access Sonarr. diff --git a/swagger.yaml b/swagger.yaml index 794981199..3aed73a6f 100755 --- a/swagger.yaml +++ b/swagger.yaml @@ -7948,11 +7948,10 @@ definitions: minLength: 1 session_duration: title: Session duration - description: Determines how long a session lasts, in seconds. Default of 0 - means that the sessions lasts until the browser is closed. - type: integer - maximum: 2147483647 - minimum: 0 + description: 'Determines how long a session lasts. Default of -1 means that + the sessions lasts until the browser is closed. (Format: hours=-1;minutes=-2;seconds=-3)' + type: string + minLength: 1 UserLogoutStage: required: - name