Chapter 1. Getting Started

Procedure

1. Download Red Hat build of Keycloak from the Red Hat website and extract it.
2. After extracting this file, look for a directory that is named rhbk-26.6.7.

Procedure

1. From a terminal, open the rhbk-26.6.7 directory.

2. Enter the following command:

   • On Linux, run:

     bin/kc.sh start-dev

   • On Windows, run:

     bin\kc.bat start-dev

     Using the start-dev option, you are starting Red Hat build of Keycloak in development mode. In this mode, you can try out Red Hat build of Keycloak for the first time to get it up and running quickly. This mode offers convenient defaults for developers, such as for developing a new Red Hat build of Keycloak theme.

Procedure

1. Open http://localhost:8080/.
2. Fill in the form with your preferred username and password.

Procedure

1. Go to the Red Hat build of Keycloak Admin Console.
2. Log in with the username and password you created earlier.

Procedure

1. Open the Red Hat build of Keycloak Admin Console.
2. Click Manage realms in the left column.
3. Click Create realm.
4. Enter myrealm in the Realm name field.

5. Click Create.

   Figure 1.1. Add realm

   

Procedure

1. Verify that you are still in the myrealm realm, which is next to Current realm.
2. Click Users in the left-hand menu.
3. Click Create new user.

4. Fill in the form with the following values:

   • Username: myuser
   • First name: any first name
   • Last name: any last name

5. Click Create.

   Figure 1.2. Create user

   

6. To set the initial password for this users

   1. Click Credentials at the top of the page.
   2. Fill in the Set password form with a password.

   3. Toggle Temporary to Off so that the user does not need to update this password at the first login.

      Figure 1.3. Set password

      

Procedure

1. Open the Red Hat build of Keycloak Account Console.

2. Log in with myuser and the password you created earlier.

   As a user in the Account Console, you can manage your account including modifying your profile, adding two-factor authentication, and including identity provider accounts.

   

Procedure

1. Open the Red Hat build of Keycloak Admin Console.
2. Click myrealm next to Current realm.
3. Click Clients.
4. Click Create client

5. Fill in the form with the following values:

   • Client type: OpenID Connect

   • Client ID: myclient

     Figure 1.4. Add client

     
6. Click Next.
7. Confirm that Standard flow is enabled.
8. Click Next.

9. Make these changes under Login settings.

   • Set Valid redirect URIs to https://www.keycloak.org/app/*
   • Set Web origins to https://www.keycloak.org

10. Click Save.

    Figure 1.5. Update client

    

11. To confirm the client was created successfully, you can use the SPA testing application on the Keycloak website.

    1. Open https://www.keycloak.org/app/.
    2. Click Save to use the default configuration.
    3. Click Sign in to authenticate to this application using the Red Hat build of Keycloak server you started earlier.