docs: add home-assistant integration docs

This commit is contained in:
Jens Langhammer 2020-10-26 22:03:37 +01:00
parent 054b819262
commit a9f3118a7d
3 changed files with 55 additions and 6 deletions

View File

@ -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.

View File

@ -18,7 +18,7 @@ The following placeholders will be used:
- `sonarr.company` is the FQDN of the Sonarr install. - `sonarr.company` is the FQDN of the Sonarr install.
- `passbook.company` is the FQDN of the passbook 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 - 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. 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 ## 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. 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.

View File

@ -7948,11 +7948,10 @@ definitions:
minLength: 1 minLength: 1
session_duration: session_duration:
title: Session duration title: Session duration
description: Determines how long a session lasts, in seconds. Default of 0 description: 'Determines how long a session lasts. Default of -1 means that
means that the sessions lasts until the browser is closed. the sessions lasts until the browser is closed. (Format: hours=-1;minutes=-2;seconds=-3)'
type: integer type: string
maximum: 2147483647 minLength: 1
minimum: 0
UserLogoutStage: UserLogoutStage:
required: required:
- name - name