Chapter 1. Getting started
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 From a terminal, open the rhbk-22.0.13 directory. 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. Open http://localhost:8080/ . Fill in the form with your preferred username and password. 1.5. Log in to the Admin Console Go to the Red Hat build of Keycloak Admin Console . 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. Open the Red Hat build of Keycloak Admin Console . Click the word master in the top-left corner, then click Create Realm . Enter myrealm in the Realm name field. Click Create . 1.7. Create a user Initially, the realm has no users. Use these steps to create a user: Open the Red Hat build of Keycloak Admin Console . Click the word master in the top-left corner, then click myrealm . Click Users in the left-hand menu. Click Add user . Fill in the form with the following values: Username : myuser First name : any first name Last name : any last name Click Create . This user needs a password to log in. To set the initial password: Click Credentials at the top of the page. Fill in the Set password form with a password. Toggle Temporary to Off so that the user does not need to update this password at the first login. 1.8. Log in to the Account Console You can now log in to the Account Console to verify this user is configured correctly. Open the Red Hat build of Keycloak Account Console . 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. 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: Open the Red Hat build of Keycloak Admin Console . Click the word master in the top-left corner, then click myrealm . Click Clients . Click Create client Fill in the form with the following values: Client type : OpenID Connect Client ID : myclient Click Confirm that Standard flow is enabled. Click . Make these changes under Login settings . Set Valid redirect URIs to https://www.keycloak.org/app/* Set Web origins to https://www.keycloak.org Click Save . To confirm the client was created successfully, you can use the SPA testing application on the Keycloak website . Open https://www.keycloak.org/app/ . Click Save to use the default configuration. Click Sign in to authenticate to this application using the Red Hat build of Keycloak server you started earlier. 1.10. Taking the 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 .
bin/kc.sh start-dev bin\kc.bat start-dev