Introduction

As part of this guide, you will be taken through step-by-step to setup Keycloak for your Synergy SKY Management Suite. The naming of the realm, clients, and roles cannot be changed otherwise it will cause issues when attempting to access the Management Suite after Keycloak is configured.

This quick start shows how to enable Keycloak and add a local user. Azure user management can be found here.

Initial Setup

1. Select Synergy CONFIG from Synergy SKY Management Suite homepage
   
   
2. When using FQDN make sure it has been added to ‘External Address’ in Network under General Settings and click on the Save Changes button at the top right of the screen
   
   
3. Click on Keycloak on the Synergy SKY Management Suite homepage
4. Create an admin Username and Password account and then login with those details to the Administration Console
   
   
5. Move the cursor over the drop-down that says Keycloak(master) and click on Create Realm
   
6. Import the template, this will auto-populate the name. Do not change this.
   Download Keycloak Template
   
   
7. To get the Insight (Analyze) Client Secret, go back to the Keycloak configuration page and select the SynergySKYAnalyze client found under Clients.
8. Select the Credentials tab, click regenerate secret and copy the Secret from this page to the Analyze Client Secret in the Config Tool
   
9. To get the Public Key, click Realm Settings on the left side
10. Select the Keys tab and then click on the Public Key button across from RS256/RSA and copy text from the popup and paste into the Config Tool
    
11. Once Analyze Client Secret and Public Key have been added to config tool, click on Verify Keycloak Login button and Sign In with the User (E.g. demo@test.com) account
    Information on how to create a user for this step is below in the section "Add User"
    
    
12. Once verified, click on Save Changes in the Config Tool and then deploy the configuration
    
    

Add User

This explains how to add a local user in Keycloak. For AAD, please follow this guide.

1. Select Users from left hand panel and click Create New User
   
2. Create a local user (E.g. demo@test.com) then click Create at the bottom of the page
   
3. Under the Credentials tab, click set password type a password (E.g. password), toggle Temporary to OFF and Save
   
4. Under the Role Mappings tab click the Assign Role button to open the panel below. Select Filter by clients and select the required roles, such as; SynergySKYConfig for config tool and to verify your login (step 11 above)
   
5. (Optional) Add Roles from SynergySKYControl & SynergySKYAnalyze (Better known as Insight) in the same manner