Fixing MD formatting

This commit is contained in:
ZuluWhiskey 2023-12-19 11:40:06 +00:00
parent 5a3d368a4d
commit 36d1678813
2 changed files with 22 additions and 29 deletions

View file

@ -27,14 +27,15 @@ The following placeholders will be used:
- **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`
- **Signing Key**: Any of your signing keys - **Signing Key**: Any of your signing keys
- Leave everything else as default - Leave everything else as default
2. Create an **Application** under **Applications** > **Applications** using the following settings: 2. Create an **Application** under **Applications** > **Applications** using the following settings:
- **Name**: FreshRSS - **Name**: FreshRSS
- **Slug**: freshrss - **Slug**: freshrss

View file

@ -1,4 +1,3 @@
--- ---
title: Home Assistant title: Home Assistant
--- ---
@ -28,39 +27,32 @@ The following placeholders will be used:
## Home Assistant configuration ## Home Assistant configuration
1. Configure [trusted_proxies](https://www.home-assistant.io/integrations/http/#trusted_proxies) for the HTTP integration with the IP(s) of the Host(s) authentik is running on. 1. Configure [trusted_proxies](https://www.home-assistant.io/integrations/http/#trusted_proxies) for the HTTP integration with the IP(s) of the Host(s) authentik is running on.
2. If you don't already have it set up, install https://github.com/BeryJu/hass-auth-header, using the installation guide. 2. If you don't already have it set up, https://github.com/BeryJu/hass-auth-header, using the installation guide.
3. There are two ways to configure the custom component. 3. There are two ways to configure the custom component.
1. To match on the user's authentik username, use the following configuration: 1. To match on the user's authentik username, use the following configuration:
```yaml
```yaml 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
additionalHeaders:
```yaml X-ak-hass-user: hassusername
additionalHeaders: ```
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
``` ```
## 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 - **Name**: Home Assistant
- **Authentication flow**: default-authentication-flow - **Authentication flow**: default-authentication-flow
- **Authorization flow**: default-provider-authorization-explicit-consent - **Authorization flow**: default-provider-authorization-explicit-consent