Andreas/wekan
1
0
Fork 0
mirror of https://github.com/wekan/wekan.git synced 2025-12-18 00:10:13 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Simplified Keycloak setup thanks to Commit: bdbbb12f96

Karim Gillani 2019-02-23 19:33:56 -08:00
parent 3fd2b29812
commit 0c28320b34
1 changed files with 5 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

27
Keycloak.md

@ -4,32 +4,15 @@
Environment Variables that need to be set in your Wekan environment: Environment Variables that need to be set in your Wekan environment:
* OAUTH2_ENABLE = TRUE * OAUTH2_ENABLED = TRUE
* OAUTH2_CLIENT_ID = `<Keycloak create Client ID>` * OAUTH2_CLIENT_ID = `<Keycloak create Client ID>`
* OAUTH2_SERVER_URL = `<Keycloak server name>/auth` * OAUTH2_SERVER_URL = `<Keycloak server name>/auth`
* OAUTH2_AUTH_ENDPOINT = `/realms/<keycloak realm>/protocol/openid-connect/auth` * OAUTH2_AUTH_ENDPOINT = `/realms/<keycloak realm>/protocol/openid-connect/auth`
* OAUTH2_USERINFO_ENDPOINT = `/realms/<keycloak realm>/protocol/openid-connect/userinfo` * OAUTH2_USERINFO_ENDPOINT = `/realms/<keycloak realm>/protocol/openid-connect/userinfo`
* OAUTH2_TOKEN_ENDPOINT = `/realms/<keycloak realm>/protocol/openid-connect/token` * OAUTH2_TOKEN_ENDPOINT = `/realms/<keycloak realm>/protocol/openid-connect/token`
* OAUTH2_SECRET = `<keycloak client secret>` * OAUTH2_SECRET = `<keycloak client secret>`
* OAUTH2_ID_MAP = `uid` * OAUTH2_ID_MAP = `preferred_username`
* OAUTH2_USERNAME_MAP = `uid` * OAUTH2_USERNAME_MAP = `preferred_username`
* OAUTH2_FULLNAME_MAP = `displayName` * OAUTH2_FULLNAME_MAP = `given_name`
* OAUTH2_EMAIL_MAP = `email` * OAUTH2_EMAIL_MAP = `email`
> When creating a Client in keycloak, ensure the access type is confidential under the settings tab. After clicking save, you will have a Credentials tab. You can retrieve the secret from that location. > When creating a Client in keycloak, ensure the access type is confidential under the settings tab. After clicking save, you will have a Credentials tab. You can retrieve the secret from that location.
Under the Client area in Keycloak, click on the Mappers area and "create" the two following mappers:
1. displayName
* Name: displayName
* Consent Required: Off
* Mapper Type: User Attribute
* User Attribute: displayName
* Token Claim Name: displayName
* Claim JSON Type: String
* Add to ID token: on
* Add to access token : on
* Add to userinfo : on
* Multivalued: off
Then Edit the existing username mapper and update the following:
* Token Claim Name: uid