Change documentation to a better format (#25)
Added new documentation style, added Authentik & Authelia examples. THank you Hendrik & Ivan! --------- Co-authored-by: Hendrik Sievers <89412959+hendrik1120@users.noreply.github.com> Co-authored-by: Ivan Vasquez <ivanvasquezp@outlook.com>
This commit is contained in:
committed by
GitHub
parent
d565380435
commit
f24519787b
69
docs/provider-configurations/authelia.md
Normal file
69
docs/provider-configurations/authelia.md
Normal file
@@ -0,0 +1,69 @@
|
||||
# Authelia
|
||||
|
||||
## Public client configuration
|
||||
|
||||
> [!NOTE]
|
||||
> This configuration strictly requires a HTTPS redirect uri.
|
||||
|
||||
Authelia `configuration.yml`
|
||||
```yaml
|
||||
identity_providers:
|
||||
oidc:
|
||||
## The other portions of the mandatory OpenID Connect 1.0 configuration go here.
|
||||
## See: https://www.authelia.com/c/oidc
|
||||
clients:
|
||||
- client_id: 'homeassistant'
|
||||
client_name: 'Home Assistant'
|
||||
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'
|
||||
userinfo_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:
|
||||
|
||||
Authelia `configuration.yml`
|
||||
```yaml
|
||||
identity_providers:
|
||||
oidc:
|
||||
## The other portions of the mandatory OpenID Connect 1.0 configuration go here.
|
||||
## See: https://www.authelia.com/c/oidc
|
||||
clients:
|
||||
- client_id: 'homeassistant'
|
||||
client_name: 'Home Assistant'
|
||||
client_secret: '$pbkdf2-sha512$310000$c8p78n7pUMln0jzvd4aK4Q$JNRBzwAo0ek5qKn50cFzzvE9RXV88h1wJn5KGiHrD0YKtZaR/nCb2CJPOsKaPK0hjf.9yHxzQGZziziccp6Yng' # The digest of 'insecure_secret'.
|
||||
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'
|
||||
userinfo_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"
|
||||
```
|
||||
40
docs/provider-configurations/authentik.md
Normal file
40
docs/provider-configurations/authentik.md
Normal file
@@ -0,0 +1,40 @@
|
||||
# Authentik
|
||||
|
||||
## Public client configuration
|
||||
Under construction.
|
||||
|
||||
## Confidential client configuration
|
||||
|
||||
1. From the admin interface, go to `Applications > Providers` and click on `Create`
|
||||
2. Select `OAuth2/OpenID Provider` and click `Next`
|
||||
3. Fill the following details:
|
||||
- Name: `Home Assistant Provider`
|
||||
- Authorization flow: `default-provider-authorization-explicit-consent`
|
||||
- Client type: `Confidential`
|
||||
- Client ID: `homeassistant`
|
||||
- Client Secret: **Copy this value**
|
||||
- Redirect URIs/Origins: Click on `Add entry` (You can use either DNS, Internal/External IP or localhost)
|
||||
- Strict: https://hass.example.com/auth/oidc/callback
|
||||
4. Click `Finish` to save the provider configuration
|
||||
5. Open the created Provider
|
||||
6. On the Assigned to application section click on `Create`:
|
||||
- Name: `Home Assistant`
|
||||
- Slug: `home-assistant`
|
||||
- Provider: `Home Assistant Provider`
|
||||
|
||||
Then save the configuration
|
||||
|
||||
## Home Assistant configuration
|
||||
|
||||
> [!IMPORTANT]
|
||||
> For HTTPS configuration make sure to have a public valid SSL certificate (i.e. LetsEncrypt), if not, use HTTP instead (more insecure) or add your Authentik CA certificate to `network.tls_ca_path`.
|
||||
|
||||
After installing this HACS addon, edit your `configuration.yaml` file and add:
|
||||
```yaml
|
||||
auth_oidc:
|
||||
client_id: "homeassistant"
|
||||
client_secret: "client_secret"
|
||||
discovery_url: "https://auth.example.com/application/o/home-assistant/.well-known/openid-configuration"
|
||||
```
|
||||
|
||||
Restart Home Assistant and go to https://hass.example.com/auth/oidc/welcome
|
||||
2
docs/provider-configurations/other.md
Normal file
2
docs/provider-configurations/other.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# Other providers
|
||||
Under construction.
|
||||
2
docs/provider-configurations/pocket-id.md
Normal file
2
docs/provider-configurations/pocket-id.md
Normal file
@@ -0,0 +1,2 @@
|
||||
# Pocket ID
|
||||
Under construction.
|
||||
Reference in New Issue
Block a user