Breadcrumbs

Setup Keycloak for VRS

Follow the below steps for setting up keycloak for VRS

  1. Go to FQDN:8088/auth and click on the Administration console

  2. Log in to the administration console using the password set in environment variables (KEYCLOAK_USER and KEYCLOAK_PASSWORD). The default username is admin and the password is admin

  3. Bring the cursor to the Master  (below the keycloak logo) and click on the Create realm button 

Screenshot 2024-01-23 at 5.20.22 PM.png
  1. Enter Realm name and click on the Create button

Screenshot 2024-01-23 at 5.20.33 PM.png
  1. Once Realm is created, click on clients under the created realm and then click create client button

Screenshot 2024-01-23 at 5.20.45 PM.png
  1. Enter Client ID vrs and click on Next.

Screenshot 2024-01-23 at 5.20.59 PM.png
  1. Toggle the Client authentication and Authorization to ON, click Next, and Click Save

Screenshot 2024-01-23 at 5.23.55 PM.png
  1. Once the client is saved, go to Credentials tab and copy the client secret. The Client ID (vrs) and Secret will be used in environment variables (KEYCLOAK_CLIENT_ID and KEYCLOAK_CLIENT_SECRET)

Screenshot 2024-01-23 at 5.24.28 PM.png
  1. Click on Realm Roles in left panel and create a role with name admin

Screenshot 2024-01-23 at 5.24.39 PM.png
  1. Go to Users and create user by entering Username and click Create.

Screenshot 2024-01-23 at 5.25.03 PM.png
  1. Go to the Credentials tab of the created user and set a password, toggle the Temporary button to OFF, and click Save.

Screenshot 2024-01-23 at 5.25.13 PM.png
  1. Go to the Roles Mappings tab on created user details, click on Assign Role, select the admin role and click on Assign

Screenshot 2024-01-23 at 5.25.34 PM.png


This created user should be able to login to VRS once Keycloak env variables are updated in config.env and ./install.sh executed.