Update Provider docs for 1.0.0 (#274)
* Add docs for Authentik #253 * Update Authelia guide #254 * Update Pocket ID guide #255
This commit is contained in:
committed by
GitHub
parent
3ba65adc8b
commit
2a5d3e589f
@@ -1,6 +1,22 @@
|
||||
# Authelia
|
||||
|
||||
## Public client configuration
|
||||
> [!TIP]
|
||||
> This guide describes configuring Authelia using the UI method. You can also configure Authelia by hand with YAML. Instructions for configuring any provider using YAML can be found here: [YAML Configuration Guide](../configuration.md).
|
||||
|
||||
|
||||
## Step 1. Install the integration
|
||||
|
||||
Make sure that you have fully installed the latest release of the integration. The easiest way to install the integration is through [the Home Assistant Community Store (HACS)](https://hacs.xyz/). You can find usage instructions for HACS here: https://hacs.xyz/docs/use/.
|
||||
|
||||
After installing HACS, search for "OpenID Connect" in the HACS search box or click the button below:
|
||||
|
||||
[](https://my.home-assistant.io/redirect/hacs_repository/?owner=christiaangoossens&repository=hass-oidc-auth&category=Integration)
|
||||
|
||||
## Step 2. Configure Authelia
|
||||
|
||||
You can choose between configuring Authelia as a public or confidential client.
|
||||
|
||||
### Public client configuration
|
||||
|
||||
> [!NOTE]
|
||||
> This configuration strictly requires a HTTPS redirect uri.
|
||||
@@ -17,24 +33,11 @@ identity_providers:
|
||||
public: true
|
||||
require_pkce: true
|
||||
pkce_challenge_method: 'S256'
|
||||
authorization_policy: 'two_factor'
|
||||
redirect_uris:
|
||||
- 'https://hass.example.com/auth/oidc/callback'
|
||||
scopes:
|
||||
- 'openid'
|
||||
- 'profile'
|
||||
- 'groups'
|
||||
id_token_signed_response_alg: 'RS256'
|
||||
```
|
||||
|
||||
Home Assistant `configuration.yaml`
|
||||
```yaml
|
||||
auth_oidc:
|
||||
client_id: "homeassistant"
|
||||
discovery_url: "https://auth.example.com/.well-known/openid-configuration"
|
||||
```
|
||||
|
||||
## Confidential client configuration:
|
||||
### Confidential client configuration:
|
||||
|
||||
Authelia `configuration.yml`
|
||||
```yaml
|
||||
@@ -49,21 +52,43 @@ identity_providers:
|
||||
public: false
|
||||
require_pkce: true
|
||||
pkce_challenge_method: 'S256'
|
||||
authorization_policy: 'two_factor'
|
||||
redirect_uris:
|
||||
- 'https://hass.example.com/auth/oidc/callback'
|
||||
scopes:
|
||||
- 'openid'
|
||||
- 'profile'
|
||||
- 'groups'
|
||||
id_token_signed_response_alg: 'RS256'
|
||||
token_endpoint_auth_method: 'client_secret_post'
|
||||
```
|
||||
|
||||
Home Assistant `configuration.yaml`
|
||||
```yaml
|
||||
auth_oidc:
|
||||
client_id: "homeassistant"
|
||||
client_secret: "insecure_secret"
|
||||
discovery_url: "https://auth.example.com/.well-known/openid-configuration"
|
||||
```
|
||||
## Step 3. Home Assistant configuration
|
||||
|
||||
The recommended setup method for beginners is through the "Integrations" panel within the Home Assistant UI. You can also use YAML setup, for which you can find the configuration guide here: [YAML Configuration Guide](../configuration.md).
|
||||
|
||||
1. Open Home Assistant and go to **Settings -> Devices & Services**.
|
||||
2. Click Add Integration and select **OpenID Connect/SSO Authentication**.
|
||||
|
||||

|
||||
|
||||
3. Now click "Authelia" and continue to the next screen
|
||||
4. Set the discovery URL to `https://<your Authelia URL>/.well-known/openid-configuration` and click **Submit**
|
||||
|
||||

|
||||
|
||||
5. Your URL will be tested. You may see an error, such as the picture below. Check your URL and verify that Home Assistant can access your Authelia installation. Change the URL or retry.
|
||||
|
||||

|
||||
|
||||
6. If your discovery URL is tested succesfully, you will see something like this and you can continue with the **Submit** button to continue.
|
||||
|
||||
|
||||

|
||||
|
||||
7. You will then be prompted to fill in the client details, the **Client ID** and the **Client Secret** (if you used the Public Client type in the Authelia configuration, there is no Client Secret required). Paste them in the relevant input boxes and continue setup with **Submit**.
|
||||
|
||||

|
||||
|
||||
8. You will then be asked about **Groups & Role Configuration** and **User Linking**. Configure these options as you wish or leave the defaults in place. You can also change these settings later by opening the integration settings and clicking the reconfiguration icon.
|
||||
|
||||
|
||||

|
||||
|
||||
## Done!
|
||||
|
||||
You should now automatically see the welcome screen upon opening your Home Assistant URL. On the welcome screen you can choose to either start login through SSO or to use an alternative login method, which will bring you back to the normal Home Assistant username/password login screen.
|
||||
Reference in New Issue
Block a user