Skip to content

Commit c304cc7

Browse files
committed
Automatically set keycloak.server.version in documentation
See #51017 (comment)
1 parent 931f383 commit c304cc7

7 files changed

+7
-6
lines changed

docs/src/main/asciidoc/_attributes.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
:logstash-image: ${logstash.image}
2020
:kibana-image: ${kibana.image}
2121
:keycloak-docker-image: ${keycloak.docker.image}
22+
:keycloak-server-version: ${keycloak.server.version}
2223
:jandex-version: ${jandex.version}
2324
:jandex-gradle-plugin-version: ${jandex-gradle-plugin.version}
2425
:kotlin-version: ${kotlin.version}

docs/src/main/asciidoc/security-keycloak-authorization.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ docker run --name keycloak \
319319
quay.io/keycloak/keycloak:{keycloak.version} \ <1>
320320
start --hostname-strict=false --https-key-store-file=/etc/keycloak-keystore.jks <2>
321321
----
322-
<1> For `keycloak.version`, ensure the version is `26.4.5` or later.
322+
<1> For `keycloak.version`, ensure the version is `{keycloak-server-version}` or later.
323323
<2> For Keycloak keystore, use the `keycloak-keystore.jks` file located at https://github.com/quarkusio/quarkus-quickstarts/blob/main/security-keycloak-authorization-quickstart/config/keycloak-keystore.jks[quarkus-quickstarts/security-keycloak-authorization-quickstart/config].
324324

325325
.Accessing the Keycloak server

docs/src/main/asciidoc/security-oidc-bearer-token-authentication-tutorial.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ For more information, see the <<bearer-token-tutorial-keycloak-dev-mode>> sectio
217217
docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev
218218
----
219219
====
220-
* Where the `keycloak.version` is set to version `26.4.5` or later.
220+
* Where the `keycloak.version` is set to version `{keycloak-server-version}` or later.
221221
. You can access your Keycloak server at http://localhost:8180[localhost:8180].
222222
. To access the Keycloak Administration console, log in as the `admin` user by using the following login credentials:
223223

docs/src/main/asciidoc/security-oidc-code-flow-authentication-tutorial.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ To start a Keycloak server, use Docker and run the following command:
201201
docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev
202202
----
203203

204-
where `keycloak.version` is set to `26.4.5` or later.
204+
where `keycloak.version` is set to `{keycloak-server-version}` or later.
205205

206206
You can access your Keycloak Server at http://localhost:8180[localhost:8180].
207207

docs/src/main/asciidoc/security-openid-connect-client.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,7 @@ To start a Keycloak Server, you can use Docker and just run the following comman
505505
docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev
506506
----
507507

508-
Set `{keycloak.version}` to `26.4.5` or later.
508+
Set `{keycloak.version}` to `{keycloak-server-version}` or later.
509509

510510
You can access your Keycloak Server at http://localhost:8180[localhost:8180].
511511

docs/src/main/asciidoc/security-openid-connect-dev-services.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ For more information, see xref:security-oidc-bearer-token-authentication.adoc#be
247247
[[keycloak-initialization]]
248248
=== Keycloak initialization
249249

250-
The `quay.io/keycloak/keycloak:26.4.5` image which contains a Keycloak distribution powered by Quarkus is used to start a container by default.
250+
The `quay.io/keycloak/keycloak:{keycloak-server-version}` image which contains a Keycloak distribution powered by Quarkus is used to start a container by default.
251251
`quarkus.keycloak.devservices.image-name` can be used to change the Keycloak image name.
252252
For example, set it to `quay.io/keycloak/keycloak:19.0.3-legacy` to use a Keycloak distribution powered by WildFly.
253253
Be aware that a Quarkus-based Keycloak distribution is only available starting from Keycloak `20.0.0`.

docs/src/main/asciidoc/security-openid-connect-multitenancy.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ To start a Keycloak server, you can use Docker and run the following command:
346346
docker run --name keycloak -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin -p 8180:8080 quay.io/keycloak/keycloak:{keycloak.version} start-dev
347347
----
348348

349-
where `keycloak.version` is set to `26.4.5` or higher.
349+
where `keycloak.version` is set to `{keycloak-server-version}` or higher.
350350

351351
Access your Keycloak server at http://localhost:8180[localhost:8180].
352352

0 commit comments

Comments
 (0)