...
To quickly get started on Keycloak and for ease of testing, we recommend installing Keycloak via Docker in your local development environment.
Do follow the guide until the part where you have successfully created a sample user in Keycloak & verify by logging in with this new user credentials in the Keycloak Account Console.
At this point of time after completing the Keycloak installation tutorial, you should have:
- A separate realm called myrealm in Keycloak
- A sample user created in Keycloak
Tip: If your Joget instance currently does not have a license, it is limited to free first 3 users only, sorted alphabetically. For ease of testing, you can create a sample user with username of cactus-jim for example.
| Note | ||
|---|---|---|
| ||
In this tutorial, it is presumed that the Keycloak instance will be running and exposed on the same host machine running your Joget instance. In this case, since the default bundled Tomcat server hosting the Joget platform operates on port 8080 by default, do ensure the deployed Keycloak container does not clash with the same host port. For example, you can map Keycloak container to expose on host port 8500 or any other non-clashing port instead. |
...
- Download the SAML Directory Manager Plugin from the Joget Marketplace, and upload the plugin .jar file into your Joget instance.
This plugin's source code is also available in JogetOSS Github. Projects under JogetOSS are community-driven and community-supported, and you are welcome to contribute to the projects. - Then, in Admin Bar → Settings → General Settings → API IP Whitelist, do whitelist external IP addresses. For now, you can allow all public users (using * symbol to indicate "allow all").
This is to allow end user browsers to communicate with the SAML plugin.
- Save the settings.
3. Plugin Configuration
...
- In Admin Bar → Settings → Directory Manager Settings
...
- → Select Plugin
...
- , select SAML Directory Manager
...
...
- to start configuring the plugin.
- Copy both values of Entity ID and ACS URL, and temporarily save these values in a convenient place for later use.
These values are required in order to create a valid client in Keycloak.
...
- IDP Certificates need to be copied from the admin console of the keycloak.
Open your KeyCloak admin console->Realm Settings ->Keys Tab -> Click on the Certificate RSA 256 Key.
...
...
Paste this value in the IDP Certificate field.
...