make website for freshrss and home assistant

This commit is contained in:
ZuluWhiskey 2023-12-19 11:45:09 +00:00
parent 36d1678813
commit f58e7ad35c
2 changed files with 20 additions and 17 deletions

View file

@ -21,15 +21,16 @@ The following placeholders will be used:
## authentik configuration ## authentik configuration
1. Create an **OAuth2/OpenID Provider** under **Applications** > **Providers** using the following settings: 1. Create an **OAuth2/OpenID Provider** under **Applications** > **Providers** using the following settings:
- **Name**: FreshRSS - **Name**: FreshRSS
- **Authorization flow**: default-provider-authorization-explicit-consent - **Authorization flow**: default-provider-authorization-explicit-consent
- **Protocol Settings**: - **Protocol Settings**:
- **Client Type**: Confidential - **Client Type**: Confidential
- **Client ID**: Either create your own Client ID or use the auto-populated ID - **Client ID**: Either create your own Client ID or use the auto-populated ID
- **Client Secret**: Either create your own Client Secret or use the auto-populated secret - **Client Secret**: Either create your own Client Secret or use the auto-populated secret
:::note :::note
Take note of the `Client ID` and `Client Secret`, you'll need them later. Take note of the `Client ID` and `Client Secret`, you'll need them later.
::: :::
- **Redirect URIs/Origins**: - **Redirect URIs/Origins**:
- `https://freshrss.company/i/oidc/` - `https://freshrss.company/i/oidc/`
- `https://freshrss.company:port/i/oidc` - `https://freshrss.company:port/i/oidc`

View file

@ -14,7 +14,7 @@ title: Home Assistant
You might run into CSRF errors, this is caused by a technology Home-assistant uses and not authentik, see [this GitHub issue](https://github.com/goauthentik/authentik/issues/884#issuecomment-851542477). You might run into CSRF errors, this is caused by a technology Home-assistant uses and not authentik, see [this GitHub issue](https://github.com/goauthentik/authentik/issues/884#issuecomment-851542477).
::: :::
:::note :::note
For Home Assistant to work with authentik, a custom integration needs to be installed for Home Assistant. For Home Assistant to work with authentik, a custom integration needs to be installed for Home Assistant.
::: :::
## Preparation ## Preparation
@ -34,17 +34,17 @@ The following placeholders will be used:
auth_header: auth_header:
username_header: X-authentik-username username_header: X-authentik-username
``` ```
2. Alternatively, you can associate an existing Home Assistant username to an authentik username. 2. Alternatively, you can associate an existing Home Assistant username to an authentik username.
1. Within authentik, naviagte to **Directory** > **Users**. 1. Within authentik, naviagte to **Directory** > **Users**.
2. Select **Edit** for the user then add the following configuration to the **Attributes** section. Be sure to replace `hassusername` with the Home Assistant username. 2. Select **Edit** for the user then add the following configuration to the **Attributes** section. Be sure to replace `hassusername` with the Home Assistant username.
:::note :::note
This configuration will add an additional header for the authentik user which will contain the Home Assistant username and allow Home Assistant to authenticate based on that. This configuration will add an additional header for the authentik user which will contain the Home Assistant username and allow Home Assistant to authenticate based on that.
::: :::
```yaml ```yaml
additionalHeaders: additionalHeaders:
X-ak-hass-user: hassusername X-ak-hass-user: hassusername
``` ```
3. Then configure the Home Assistant custom component to use this header: 3. Then configure the Home Assistant custom component to use this header:
```yaml ```yaml
auth_header: auth_header:
username_header: X-ak-hass-user username_header: X-ak-hass-user
@ -53,13 +53,15 @@ The following placeholders will be used:
## authentik configuration ## authentik configuration
1. Create a **Proxy Provider** under **Applications** > **Providers** using the following settings: 1. Create a **Proxy Provider** under **Applications** > **Providers** using the following settings:
- **Name**: Home Assistant
- **Authentication flow**: default-authentication-flow - **Name**: Home Assistant
- **Authorization flow**: default-provider-authorization-explicit-consent - **Authentication flow**: default-authentication-flow
- **External Host**: Set this to the external URL you will be accessing Home Assistant from - **Authorization flow**: default-provider-authorization-explicit-consent
- **Internal Host**: `http://hass.company:8123` - **External Host**: Set this to the external URL you will be accessing Home Assistant from
- **Internal Host**: `http://hass.company:8123`
2. Create an **Application** under **Applications** > **Applications** using the following settings: 2. Create an **Application** under **Applications** > **Applications** using the following settings:
- **Name**: Home Assistant - **Name**: Home Assistant
- **Slug**: homeassistant - **Slug**: homeassistant
- **Provider**: Home Assistant (the provider you created in step 1) - **Provider**: Home Assistant (the provider you created in step 1)