SupportConsoleDevelopersStart a trialContact

Getting Started Guide

Red Hat build of Keycloak 22.0

Red Hat Customer Content Services

Abstract

This guide helps you practice using Red Hat build of Keycloak 22.0 to evaluate it before you use it in a production environment. It includes instructions for installing and running the Red Hat build of Keycloak server in development mode, creating realms and accounts for managing users and applications, and securing a Single Page Application (SPA)

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. We are beginning with these four terms: master, slave, blacklist, and whitelist. Because of the enormity of this endeavor, these changes will be implemented gradually over several upcoming releases. For more details, see our CTO Chris Wright’s message.

Chapter 1. Getting started

1.1. Before you start

Make sure you have OpenJDK 17 installed.

1.2. Download Red Hat build of Keycloak

Download Red Hat build of Keycloak from the Red Hat website and extract it.

After extracting this file, you should have a directory that is named rhbk-22.0.13.

1.3. Start Red Hat build of Keycloak

  1. From a terminal, open the rhbk-22.0.13 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.

1.4. Create an admin user

Red Hat build of Keycloak has no default admin user. You need to create an admin user before you can start Keycloak.

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

1.5. Log in to the Admin Console

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

1.6. Create a realm

A realm in Red Hat build of Keycloak is equivalent to a tenant. Each realm allows an administrator to create isolated groups of applications and users. Initially, Red Hat build of Keycloak includes a single realm, called master. Use this realm only for managing Red Hat build of Keycloak and not for managing any applications.

Use these steps to create the first realm.

  1. Open the Red Hat build of Keycloak Admin Console.
  2. Click the word master in the top-left corner, then click Create Realm.
  3. Enter myrealm in the Realm name field.
  4. Click Create.
Add realm

1.7. Create a user

Initially, the realm has no users. Use these steps to create a user:

  1. Open the Red Hat build of Keycloak Admin Console.
  2. Click the word master in the top-left corner, then click myrealm.
  3. Click Users in the left-hand menu.
  4. Click Add user.

  5. Fill in the form with the following values:

    • Username: myuser
    • First name: any first name
    • Last name: any last name
  6. Click Create.
Create user

This user needs a password to log in. To set the initial password:

  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.
Set password

1.8. Log in to the Account Console

You can now log in to the Account Console to verify this user is configured correctly.

  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.

Red Hat build of Keycloak Account Console

1.9. Secure the first application

To secure the first application, you start by registering the application with your Red Hat build of Keycloak instance:

  1. Open the Red Hat build of Keycloak Admin Console.
  2. Click the word master in the top-left corner, then click myrealm.
  3. Click Clients.
  4. Click Create client

  5. Fill in the form with the following values:

    • Client type: OpenID Connect

    • Client ID: myclient

      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.
Update Client

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.

1.10. Taking the next step

Before you run Red Hat build of Keycloak in production, consider the following actions:

  • Switch to a production ready database such as PostgreSQL.
  • Configure SSL with your own certificates.
  • Switch the admin password to a more secure password.

For more information, see the Server Guide.

Legal Notice

Copyright © 2024 Red Hat, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.