Skip to content

Keycloak

Lauri Ojansivu edited this page Apr 21, 2019 · 14 revisions

OIDC Integration

Outstanding Bug: Create the first user (admin) with the regular process. Then the remaining users can use the Register with OIDC process.

Keycloak settings: realm-export.zip

Environment Variables that need to be set in your Wekan environment:

  • OAUTH2_ENABLED = TRUE
  • OAUTH2_CLIENT_ID = <Keycloak create Client ID>
  • OAUTH2_SERVER_URL = <Keycloak server name>/auth
  • OAUTH2_AUTH_ENDPOINT = /realms/<keycloak realm>/protocol/openid-connect/auth
  • OAUTH2_USERINFO_ENDPOINT = /realms/<keycloak realm>/protocol/openid-connect/userinfo
  • OAUTH2_TOKEN_ENDPOINT = /realms/<keycloak realm>/protocol/openid-connect/token
  • OAUTH2_SECRET = <keycloak client secret>
  • OAUTH2_ID_MAP = preferred_username
  • OAUTH2_USERNAME_MAP = preferred_username
  • OAUTH2_FULLNAME_MAP = given_name
  • 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.

Snap

Copy below commands to auth.sh textfile, make it executeable chmod +x auth.sh and run it with ./auth.sh.

sudo snap set wekan oauth2-enabled='true'
sudo snap set wekan oauth2-client-id='<Keycloak create Client ID>'
sudo snap set wekan oauth2-secret='<Keycloak Client secret>'
sudo snap set wekan oauth2-server-url='<Keycloak server name>/auth'
sudo snap set wekan oauth2-auth-endpoint='/realms/<keycloak realm>/protocol/openid-connect/auth'
sudo snap set wekan oauth2-userinfo-endpoint='/realms/<keycloak realm>/protocol/openid-connect/userinfo'
sudo snap set wekan oauth2-token-endpoint='/realms/<keycloak realm>/protocol/openid-connect/token'
sudo snap set wekan oauth2-id-map='preferred_username'
sudo snap set wekan oauth2-username-map='preferred_username'
sudo snap set wekan oauth2-fullname-map='given_name'
sudo snap set wekan oauth2-email-map='email'

Wekan

General

Security

Scaling

Migrating

Support priorities for new features and bugfixes

  1. Commercial Support
  2. Community Support
  3. Debugging

Backup

Repair

Themes

Markdown Syntax

Login Auth

Metrics, Logs, Stats

Integrations

Time

Features

Email

Required Settings

Download

Webservers

REST API Docs

REST API issue

REST API client code

Webhooks

Case Studies

Development

Issues

Clone this wiki locally