Make minor changes to Getting Started

Closes #23951
This commit is contained in:
AndyMunro 2023-10-12 17:33:25 -04:00 committed by Alexander Schwartz
parent b3be89de9b
commit 7dda393120
4 changed files with 26 additions and 4 deletions

View file

@ -55,7 +55,7 @@ oc process -f https://raw.githubusercontent.com/keycloak/keycloak-quickstarts/la
| oc create -f -
----
+
In this example, the user name and and password are `admin`.
In this example, the user name and password are `admin`.
. Once the command above completes, look for a message similar to this:
+

View file

@ -1,4 +1,5 @@
<#import "/templates/guide.adoc" as tmpl>
<#import "/templates/profile.adoc" as profile>
<@tmpl.guide
title="OpenJDK"
@ -10,14 +11,20 @@ summary="Get started with Keycloak on bare metal">
== Before you start
Make sure you have https://openjdk.java.net/[OpenJDK 17] or a higher version installed.
Make sure you have https://openjdk.java.net/[OpenJDK 17] installed.
== Download Keycloak
Download and extract https://github.com/keycloak/keycloak/releases/download/{version}/keycloak-{version}.zip[keycloak-{version}.zip]
from the Keycloak website.
After extracting this file, you should have a directory named keycloak-{version}.
<@profile.ifCommunity>
After extracting this file, you should have a directory with a name that starts with `keycloak-{version}`.
</@profile.ifCommunity>
<@profile.ifProduct>
After extracting this file, you should have a directory with a name that starts with `rhbk-{version}`.
</@profile.ifProduct>
include::templates/start-keycloak-localhost.adoc[]

View file

@ -37,6 +37,6 @@ 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 update this password at the first login.
. Toggle *Temporary* to *Off* so that the user does not need to update this password at the first login.
image::set-password.png[Set password]

View file

@ -1,7 +1,18 @@
<#import "/templates/profile.adoc" as profile>
== Start Keycloak
. From a terminal, open the keycloak-{version} directory.
. Enter the following command:
<@profile.ifProduct>
+
[source,bash,subs="attributes+"]
----
bin/kc.sh start-dev
----
</@profile.ifProduct>
<@profile.ifCommunity>
* On Linux, run:
+
[source,bash,subs="attributes+"]
@ -15,3 +26,7 @@ bin/kc.sh start-dev
----
bin\kc.bat start-dev
----
</@profile.ifCommunity>
Using the `start-dev` option, you are starting Keycloak development mode. In this mode, you can try out 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 Keycloak theme.