keycloak · stianst · Nov 8, 2023 · Nov 3, 2023
diff --git a/docs/documentation/securing_apps/topics/oidc/java/adapter-deprecation-notice.adoc b/docs/documentation/securing_apps/topics/oidc/java/adapter-deprecation-notice.adoc
@@ -1,5 +1,5 @@
 [WARNING]
 ====
-This adapter is deprecated and will be removed in a future release of Keycloak. No further enhancements or new features
+This adapter is deprecated and will be removed in a future release of {project_name}. No further enhancements or new features
 will be added to this adapter.
 ====
diff --git a/docs/documentation/securing_apps/topics/oidc/java/jboss-adapter.adoc b/docs/documentation/securing_apps/topics/oidc/java/jboss-adapter.adoc
@@ -20,11 +20,11 @@ ifeval::[{project_community}==true]
 
 [WARNING]
 ====
-This adapter is deprecated and will be removed in a future release of Keycloak. No further enhancements or new features
+This adapter is deprecated and will be removed in a future release of {project_name}. No further enhancements or new features
 will be added to this adapter.
 
 We recommend that you switch to the Elytron OIDC library to secure your applications.
-This library has a similar configuration to the Keycloak WildFly adapters, so you can expect a smooth migration of your applications.
+This library has a similar configuration to the {project_name} WildFly adapters, so you can expect a smooth migration of your applications.
 
 For more details about how to integrate {project_name} with JakartaEE applications running on latest Wildfly/EAP, consider looking at the
 {quickstartRepo_link}[Keycloak Quickstart GitHub Repository].

diff --git a/docs/documentation/securing_apps/topics/oidc/java/jetty9-adapter.adoc b/docs/documentation/securing_apps/topics/oidc/java/jetty9-adapter.adoc
@@ -4,13 +4,13 @@
 
 include::adapter-deprecation-notice.adoc[]
 
-Keycloak has a separate adapter for Jetty 9.4 that you will have to install into your Jetty installation.
+{project_name} has a separate adapter for Jetty 9.4 that you will have to install into your Jetty installation.
 You then have to provide some extra configuration in each WAR you deploy to Jetty.
 
 [[_jetty9_adapter_installation]]
 ===== Installing the adapter
 
-Adapters are no longer included with the appliance or war distribution. Each adapter is a separate download on the Keycloak downloads site. They are also available as a maven artifact.
+Adapters are no longer included with the appliance or war distribution. Each adapter is a separate download on the {project_name} downloads site. They are also available as a maven artifact.
 
 .Procedure
 .  Download the {project_name} Jetty 9.4 adapter ZIP archive from the link:https://www.keycloak.org/downloads[Keycloak Downloads] site.
@@ -42,7 +42,7 @@ Use this procedure to secure a WAR directly by adding config and editing files w
 
 .Procedure
 
-. Create a `WEB-INF/jetty-web.xml` file in your WAR package. This is a Jetty specific config fil. You define a Keycloak specific authenticator within it.
+. Create a `WEB-INF/jetty-web.xml` file in your WAR package. This is a Jetty specific config fil. You define a {project_name} specific authenticator within it.
 +
 [source]
 ----

diff --git a/docs/documentation/securing_apps/topics/oidc/mod-auth-openidc.adoc b/docs/documentation/securing_apps/topics/oidc/mod-auth-openidc.adoc
@@ -10,7 +10,7 @@ To configure _mod_auth_openidc_ you'll need
 * The client_id.
 * The client_secret.
 * The redirect_uri to your application.
-* The Keycloak openid-configuration url
+* The {project_name} openid-configuration url
 * _mod_auth_openidc_ specific Apache HTTPD module config.
 
 An example configuration would look like the following.

diff --git a/docs/documentation/securing_apps/topics/oidc/nodejs-adapter.adoc b/docs/documentation/securing_apps/topics/oidc/nodejs-adapter.adoc
@@ -82,12 +82,12 @@ Now we have the ability to run our server with following command:
 ----
 
 By default, this will locate a file named `keycloak.json` alongside
-the main executable of your application, in our case on the root folder, to initialize keycloak-specific
+the main executable of your application, in our case on the root folder, to initialize {project_name} specific
 settings such as public key, realm name, various URLs.
 
-In that case a Keycloak deployment is necessary to access Keycloak admin console.
+In that case a {project_name} deployment is necessary to access {project_name} admin console.
 
-Please visit links on how to deploy a Keycloak admin console with 
+Please visit links on how to deploy a {project_name} admin console with
 https://www.keycloak.org/getting-started/getting-started-podman[Podman] or https://www.keycloak.org/getting-started/getting-started-docker[Docker]
 
 Now we are ready to obtain the `keycloak.json` file by visiting the {project_name} Admin Console -> clients (left sidebar) -> choose your client -> Installation -> Format Option -> Keycloak OIDC JSON -> Download

diff --git a/docs/guides/attributes.adoc b/docs/guides/attributes.adoc
@@ -0,0 +1 @@
+:project_name: Keycloak
diff --git a/docs/guides/getting-started/getting-started-docker.adoc b/docs/guides/getting-started/getting-started-docker.adoc
@@ -2,13 +2,13 @@
 
 <@tmpl.guide
 title="Docker"
-summary="Get started with Keycloak on Docker">
+summary="Get started with {project_name} on Docker">
 
 :containerCommand: docker
 
 :links-local: true
-:links-admin-console: http://localhost:8080/admin[Keycloak Admin Console]
-:links-account-console: http://localhost:8080/realms/myrealm/account[Keycloak Account Console]
+:links-admin-console: http://localhost:8080/admin[{project_name} Admin Console]
+:links-account-console: http://localhost:8080/realms/myrealm/account[{project_name} Account Console]
 
 == Before you start
 

diff --git a/docs/guides/getting-started/getting-started-kube.adoc b/docs/guides/getting-started/getting-started-kube.adoc
@@ -2,10 +2,10 @@
 
 <@tmpl.guide
 title="Kubernetes"
-summary="Get started with Keycloak on Kubernetes">
+summary="Get started with {project_name} on Kubernetes">
 
-:links-admin-console: Keycloak Admin Console
-:links-account-console: Keycloak Account Console
+:links-admin-console: {project_name} Admin Console
+:links-account-console: {project_name} Account Console
 
 == Before you start
 
@@ -25,23 +25,23 @@ If the Ingress addon is not enabled, enter the following command to enable it:
 minikube addons enable ingress
 ----
 
-== Start Keycloak
+== Start {project_name}
 
-The Keycloak QuickStarts repository includes some example files to help deploy Keycloak to Kubernetes.
+The {project_name} QuickStarts repository includes some example files to help deploy {project_name} to Kubernetes.
 
-As a first step, create the Keycloak deployment and service by entering the following command:
+As a first step, create the {project_name} deployment and service by entering the following command:
 
 [source,bash,subs="attributes+"]
 ----
 kubectl create -f https://raw.githubusercontent.com/keycloak/keycloak-quickstarts/latest/kubernetes/keycloak.yaml
 ----
 
-This command starts Keycloak on Kubernetes and creates an initial admin user with the username `admin` and password
+This command starts {project_name} on Kubernetes and creates an initial admin user with the username `admin` and password
 `admin`.
 
-=== Access Keycloak with Ingress addon enabled
+=== Access {project_name} with Ingress addon enabled
 
-Now create an Ingress for Keycloak by entering the following command:
+Now create an Ingress for {project_name} by entering the following command:
 
 [source,bash,subs="attributes+"]
 ----
@@ -53,19 +53,19 @@ kubectl create -f -
 If `wget` and `sed` are not available, download the file and manually edit the file replacing `KEYCLOAK_HOST`
 with `keycloak.<minikube ip address>.nip.io`.
 
-Enter the following command to see the Keycloak URLs:
+Enter the following command to see the {project_name} URLs:
 
 [source,bash,subs="attributes+"]
 ----
 KEYCLOAK_URL=https://keycloak.$(minikube ip).nip.io &&
 echo "" &&
-echo "Keycloak:                 $KEYCLOAK_URL" &&
-echo "Keycloak Admin Console:   $KEYCLOAK_URL/admin" &&
-echo "Keycloak Account Console: $KEYCLOAK_URL/realms/myrealm/account" &&
+echo "{project_name}:                 $KEYCLOAK_URL" &&
+echo "{project_name} Admin Console:   $KEYCLOAK_URL/admin" &&
+echo "{project_name} Account Console: $KEYCLOAK_URL/realms/myrealm/account" &&
 echo ""
 ----
 
-=== Access Keycloak without Ingress
+=== Access {project_name} without Ingress
 
 If the Ingress addon is not enabled, enter the following command in a separate shell:
 
@@ -74,15 +74,15 @@ If the Ingress addon is not enabled, enter the following command in a separate s
 minikube tunnel
 ----
 
-You can now access Keycloak from the following URL:
+You can now access {project_name} from the following URL:
 
 [source,bash,subs="attributes+"]
 ----
 KEYCLOAK_URL=http://$(minikube ip):$(kubectl get services/keycloak -o go-template='{{(index .spec.ports 0).nodePort}}') &&
 echo "" &&
-echo "Keycloak:                 $KEYCLOAK_URL" &&
-echo "Keycloak Admin Console:   $KEYCLOAK_URL/admin" &&
-echo "Keycloak Account Console: $KEYCLOAK_URL/realms/myrealm/account" &&
+echo "{project_name}:                 $KEYCLOAK_URL" &&
+echo "{project_name} Admin Console:   $KEYCLOAK_URL/admin" &&
+echo "{project_name} Account Console: $KEYCLOAK_URL/realms/myrealm/account" &&
 echo ""
 ----
 

diff --git a/docs/guides/getting-started/getting-started-openshift.adoc b/docs/guides/getting-started/getting-started-openshift.adoc
@@ -2,10 +2,10 @@
 
 <@tmpl.guide
 title="OpenShift"
-summary="Get started with Keycloak on OpenShift">
+summary="Get started with {project_name} on OpenShift">
 
-:links-admin-console: Keycloak Admin Console
-:links-account-console: Keycloak Account Console
+:links-admin-console: {project_name} Admin Console
+:links-account-console: {project_name} Account Console
 
 == Before you start
 
@@ -42,9 +42,9 @@ oc login -u developer -p developer
 oc new-project keycloak
 ----
 
-== Start Keycloak
+== Start {project_name}
 
-. To start a Keycloak server in your project, enter the following command:
+. To start a {project_name} server in your project, enter the following command:
 +
 [source,bash,subs="attributes+"]
 ----
@@ -66,10 +66,10 @@ route.route.openshift.io/keycloak created
 deploymentconfig.apps.openshift.io/keycloak created.
 ----
 +
-At this point, OpenShift will provision a Keycloak pod and related resources. As part of the process, OpenShift will
-try to pull the Keycloak server image. This operation might take some time depending on your network connection.
+At this point, OpenShift will provision a {project_name} pod and related resources. As part of the process, OpenShift will
+try to pull the {project_name} server image. This operation might take some time depending on your network connection.
 
-. To make sure Keycloak is provisioned, execute the following command:
+. To make sure {project_name} is provisioned, execute the following command:
 +
 [source,bash,subs="attributes+"]
 ----
@@ -85,15 +85,15 @@ keycloak-1-deploy   0/1       Completed   0          1h
 keycloak-1-l9kdx    1/1       Running     0          1h
 ----
 
-. Once the server is provisioned, enter the following command to find out the Keycloak URLs:
+. Once the server is provisioned, enter the following command to find out the {project_name} URLs:
 +
 [source,bash,subs="attributes+"]
 ----
 KEYCLOAK_URL=https://$(oc get route keycloak --template='{{ .spec.host }}') &&
 echo "" &&
-echo "Keycloak:                 $KEYCLOAK_URL" &&
-echo "Keycloak Admin Console:   $KEYCLOAK_URL/admin" &&
-echo "Keycloak Account Console: $KEYCLOAK_URL/realms/myrealm/account" &&
+echo "{project_name}:                 $KEYCLOAK_URL" &&
+echo "{project_name} Admin Console:   $KEYCLOAK_URL/admin" &&
+echo "{project_name} Account Console: $KEYCLOAK_URL/realms/myrealm/account" &&
 echo ""
 ----
 

diff --git a/docs/guides/getting-started/getting-started-podman.adoc b/docs/guides/getting-started/getting-started-podman.adoc
@@ -2,13 +2,13 @@
 
 <@tmpl.guide
 title="Podman"
-summary="Get started with Keycloak on Podman">
+summary="Get started with {project_name} on Podman">
 
 :containerCommand: podman
 
 :links-local: true
-:links-admin-console: http://localhost:8080/admin[Keycloak Admin Console]
-:links-account-console: http://localhost:8080/realms/myrealm/account[Keycloak Account Console]
+:links-admin-console: http://localhost:8080/admin[{project_name} Admin Console]
+:links-account-console: http://localhost:8080/realms/myrealm/account[{project_name} Account Console]
 
 == Before you start
 

diff --git a/docs/guides/getting-started/getting-started-zip.adoc b/docs/guides/getting-started/getting-started-zip.adoc
@@ -3,20 +3,20 @@
 
 <@tmpl.guide
 title="OpenJDK"
-summary="Get started with Keycloak on bare metal">
+summary="Get started with {project_name} on bare metal">
 
 :links-local: true
-:links-admin-console: http://localhost:8080/admin[Keycloak Admin Console]
-:links-account-console: http://localhost:8080/realms/myrealm/account[Keycloak Account Console]
+:links-admin-console: http://localhost:8080/admin[{project_name} Admin Console]
+:links-account-console: http://localhost:8080/realms/myrealm/account[{project_name} Account Console]
 
 == Before you start
 
 Make sure you have https://openjdk.java.net/[OpenJDK 17] installed.
 
-== Download Keycloak
+== Download {project_name}
 
 Download and extract https://github.com/keycloak/keycloak/releases/download/{version}/keycloak-{version}.zip[keycloak-{version}.zip]
-from the Keycloak website.
+from the {project_name} website.
 
 <@profile.ifCommunity>
 After extracting this file, you should have a directory with a name that starts with `keycloak-{version}`.

diff --git a/docs/guides/getting-started/index.adoc b/docs/guides/getting-started/index.adoc
@@ -1,4 +1,7 @@
 = Keycloak getting started guide
+
+include::../attributes.adoc[]
+
 <#list ctx.guides as guide>
 :links_getting-started_${guide.id}_name: ${guide.title}
 :links_getting-started_${guide.id}_url: #${guide.id}

diff --git a/docs/guides/getting-started/templates/create-admin-localhost.adoc b/docs/guides/getting-started/templates/create-admin-localhost.adoc
@@ -1,6 +1,6 @@
 == Create an admin user
 
-Keycloak has no default admin user. You need to create an admin user before you can start Keycloak.
+{project_name} has no default admin user. You need to create an admin user before you can start Keycloak.
 
 . Open http://localhost:8080/[http://localhost:8080/].
 . Fill in the form with your preferred username and password.
diff --git a/docs/guides/getting-started/templates/first-app.adoc b/docs/guides/getting-started/templates/first-app.adoc
@@ -1,6 +1,6 @@
 == Secure the first application
 
-To secure the first application, you start by registering the application with your Keycloak instance:
+To secure the first application, you start by registering the application with your {project_name} instance:
 
 . Open the {links-admin-console}.
 . Click the word *master* in the top-left corner, then click *myrealm*.
@@ -30,8 +30,8 @@ endif::[]
 
 ifeval::[{links-local}!=true]
 . Open https://www.keycloak.org/app/.
-. Change `Keycloak URL` to the URL of your Keycloak instance.
+. Change `Keycloak URL` to the URL of your {project_name} instance.
 . Click *Save*.
 endif::[]
 
-. Click *Sign in* to authenticate to this application using the Keycloak server you started earlier.
+. Click *Sign in* to authenticate to this application using the {project_name} server you started earlier.
diff --git a/docs/guides/getting-started/templates/login-to-account.adoc b/docs/guides/getting-started/templates/login-to-account.adoc
@@ -7,4 +7,4 @@ You can now log in to the Account Console to verify this user is configured corr
 
 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.
 
-image::account-console.png[Keycloak Account Console]
+image::account-console.png[{project_name} Account Console]
diff --git a/docs/guides/getting-started/templates/next.adoc b/docs/guides/getting-started/templates/next.adoc
@@ -1,6 +1,6 @@
 == Taking the next step
 
-Before you run Keycloak in production, consider the following actions:
+Before you run {project_name} in production, consider the following actions:
 
 * Switch to a production ready database such as PostgreSQL.
 * Configure SSL with your own certificates.

diff --git a/docs/guides/getting-started/templates/realm-config.adoc b/docs/guides/getting-started/templates/realm-config.adoc
@@ -5,8 +5,8 @@
 
 == Create a realm
 
-A realm in Keycloak is equivalent to a tenant. Each realm allows an administrator to create isolated groups of applications and users. Initially, Keycloak
-includes a single realm, called `master`. Use this realm only for managing Keycloak and not for managing any applications.
+A realm in {project_name} is equivalent to a tenant. Each realm allows an administrator to create isolated groups of applications and users. Initially, {project_name}
+includes a single realm, called `master`. Use this realm only for managing {project_name} and not for managing any applications.
 
 Use these steps to create the first realm.
 

diff --git a/docs/guides/getting-started/templates/start-keycloak-container.adoc b/docs/guides/getting-started/templates/start-keycloak-container.adoc
@@ -1,11 +1,11 @@
-== Start Keycloak
+== Start {project_name}
 
-From a terminal, enter the following command to start Keycloak:
+From a terminal, enter the following command to start {project_name}:
 
 [source,bash,subs="attributes+"]
 ----
 {containerCommand} run -p 8080:8080 -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin quay.io/keycloak/keycloak:{version} start-dev
 ----
 
-This command starts Keycloak exposed on the local port 8080 and creates an initial admin user with the username `admin`
+This command starts {project_name} exposed on the local port 8080 and creates an initial admin user with the username `admin`
 and password `admin`.
diff --git a/docs/guides/getting-started/templates/start-keycloak-localhost.adoc b/docs/guides/getting-started/templates/start-keycloak-localhost.adoc
@@ -1,6 +1,6 @@
 <#import "/templates/profile.adoc" as profile>
 
-== Start Keycloak
+== Start {project_name}
 
 . From a terminal, open the keycloak-{version} directory.
 . Enter the following command:
@@ -28,5 +28,5 @@ 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.
+Using the `start-dev` option, you are starting {project_name} development mode. In this mode, you can try out {project_name} for the first time to get it up and running quickly. This mode offers convenient defaults for developers, such as for developing a new {project_name} theme.
 
diff --git a/docs/guides/getting-started/templates/test-app.adoc b/docs/guides/getting-started/templates/test-app.adoc
@@ -9,8 +9,8 @@ endif::[]
 
 ifeval::[{links-local}!=true]
 . Open https://www.keycloak.org/app/.
-. Change `Keycloak URL` to the URL of your Keycloak instance.
+. Change `Keycloak URL` to the URL of your {project_name} instance.
 . Click *Save*.
 endif::[]
 
-. Click *Sign in* to authenticate to this application using the Keycloak server you started earlier.
+. Click *Sign in* to authenticate to this application using the {project_name} server you started earlier.
diff --git a/docs/guides/migration/index.adoc b/docs/guides/migration/index.adoc
@@ -1,4 +1,7 @@
 = Keycloak migration guide
+
+include::../attributes.adoc[]
+
 <#list ctx.guides as guide>
 :links_migration_${guide.id}_name: ${guide.title}
 :links_migration_${guide.id}_url: #${guide.id}
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,4 +7,4 @@ You can now log in to the Account Console to verify this user is configured corr

		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.

		image::account-console.png[Keycloak Account Console]
		image::account-console.png[{project_name} Account Console]