Contents
| Table of Contents |
|---|
Introduction
This document list all the features related to Synergy.
...
Below are the steps involved in configuring Keycloak, and you may choose to skip the Optional steps based on your preferences:
Logging into Keycloak admin panel
The Keycloak admin URL will consist of the following components:
...
Once logged into the portal, there are a few steps to complete in order to configure Keycloak.
Completing the Realm Configuration
In Keycloak, a Realm is a top level authentication domain which contains an isolated authentication configuration.
...
Click on the left-side menu item Realm Settings.
This will load the Gv Realm Settings → General tab, enter your desired user-friendly reseller name into both the Display name and HTML Display name fields
Click the Save button to commit these changes to the Realm Settings.
Completing the Dashboard Client Configuration
Click on the Clients menu item on the left-side menu, this should load a list of authentication clients
Click on Edit (or click on the name link) on the item labelled dashboard in order to load the client
Open the dropdown for Login Theme and select the theme created for your reseller (E.g. my-reseller-theme)
Update the Valid Redirect URIs to include the URL you have configured for the Dashboard UI (remember to click the + plus icon after entering the value).
This will allow Keycloak to redirect back to your Dashboard UI after authenticating
Update the Web Origins to include the URL you have configured for the Dashboard UI (remember to click the + plus icon after entering the value).
This will allow CORS endpoint calls to Keycloak from the Dashboard UI.
Click the Save button at the bottom of the screen
(Required for Synergy) Setting up a default Agent user
This step is important and required for the agent to work correctly.
...
Click on the Users menu item on the left-side menu, this should load the Users list
Click the Add user button in the top right to open the Add user screen
It’s only necessary to complete two fields on this form; The Username field should contain agent, and the Email field should contain agent@gv.com:
Click the Save button at the bottom of the screen
(Optional) Completing the Agent Client Configuration
Click on the Clients menu item on the left-side menu, this should load a list of authentication clients
Click on Edit (or click on the name link) on the item labelled agent in order to load the client
Update the Valid Redirect URIs value (default is https://localhost:80) to a secure address that you know is not vulnerable or exposed.
This is a required field and requires at least one value, so while we have set it to a temporary value, it’s encouraged to change this to something internal.
Click the Save button at the bottom of the screen
(Optional) Completing the User Federation Configuration
The authentication protocol that the customer decides to use is different per use case.
Below is some guidance on how to configure a User Federation in Keycloak.
Configuring the User Federation
Click on the User Federation menu item on the left-side menu, this should load a list of configured user federations
Click on Edit (or click on the name link) on the item labelled ldap in order to load the LDAP (Lightweight Directory Access Protocol) configuration
Update the Connection URL field to reflect the LDAP server address where the Active Directory is hosted.
Update the Users DN field (see the above image) to contain the Full DN of the LDAP tree where your users are
Click on the button Test connection to test the connection from the Keycloak instance to the LDAP server address.
This should succeed quickly, and if it hangs, there is a possibility that the LDAP server is not allowing access from the Keycloak instance server address, or you may need to use the Public IP address of the LDAP server.
Update the Bind DN field to reflect the relevant username used to access the LDAP server
Update the Bind Credential field (see the above image) to contain the relevant password used to access the LDAP server
(Optional) Click on the Accordion option Sync Settings in order to set up automatic synchronization of users from the LDAP Active Directory to Keycloak.
You are able to configure the auto-synchronization settings here, if you like.
Click the Save button at the bottom of the screen
Synchronizing the Users to Keycloak DB
In order to get the users into the Keycloak DB, we need to synchronize the users for the first time (before the automatic synchronization happens, if applicable).
...
| Info |
|---|
Synchronizing all users may take some time, please be patient. |
Troubleshooting Keycloak LDAP integration
Usually any issues which occur during the LDAP Active Directory configuration process above will be related to Network accessibility concerns or authentication credentials being incorrect.
...