Skip to content

Commit 99fa9bc

Browse files
committed
📝 Add documentation for 'appConfig.auth.keycloak.idpHint' option.
1 parent d974042 commit 99fa9bc

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/authentication.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,8 @@ appConfig:
164164

165165
Note that if you are using Keycloak V 17 or older, you will also need to set `legacySupport: true` (also under `appConfig.auth.keycloak`). This is because the API endpoint was updated in later versions.
166166

167+
If you use Keycloak with an external Identity Provier, you can set the `idpHint: 'alias-of-kc-idp'` option to allow the IdP Hint to be passed to Keycloak. This will cause Keycloak to skip its login page and redirect the user directly to the specified IdP's login page. Set to the value of the 'Alias' field of the desired IdP as defined in Keycloak under 'Identity Providers'.
168+
167169
### 4. Add groups and roles (Optional)
168170
169171
Keycloak allows you to assign users roles and groups. You can use these values to configure who can access various sections or items in Dashy.

0 commit comments

Comments
 (0)