trustchain-oc1-orchestral/authentik
Archived
10
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/website/docs/integrations/services/home-assistant/index.md
Jens L 7be680cbe5
Migrate to Docusaurus (#329) 
* docs: initial migration to docusaurus

* website: add custom font, update blurbs and icons

* website: update splash

* root: update links to docs

* flows: use .pbflow extension so docusaurus doesn't mangle the files

* e2e: workaround prospector

* Squashed commit of the following:

commit 1248585dca
Author: Jens Langhammer <jens.langhammer@beryju.org>
Date:   Sun Nov 15 20:46:53 2020 +0100

    e2e: attempt to fix prospector error again

commit 1319c480c4
Author: Jens Langhammer <jens.langhammer@beryju.org>
Date:   Sun Nov 15 20:41:35 2020 +0100

    ci: install previous python version for upgrade testing

* web: update accent colours and format

* website: format markdown files

* website: fix colours for text

* website: switch to temporary accent colour to improve readability

* flows: fix path for TestTransferDocs

* flows: fix formatting of tests
2020-11-15 22:42:02 +01:00

2.3 KiB
Raw Blame History

title
Home-Assistant

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

With the default Header of X-Forwarded-Preferred-Username matching is done on a username basis, so your Name in Home-Assistant and your username in passbook have to match.

If this is not the case, you can simply add an additional header for your user, which contains the Home-Assistant Name and authenticate based on that.

For example add this to your user's properties and set the Header to X-pb-hass-user.

additionalHeaders:
    X-pb-hass-user: some other name

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