KEYCLOAK-14758 Using a variable for the base version: 7.4 (also deleted a blank line to allow me to recommit, becuase I don't see a problem with the variable I added)

This commit is contained in:
Andy Munro 2020-07-20 17:00:52 -04:00 committed by Bruno Oliveira da Silva
parent af5e005c20
commit 73902f607f
49 changed files with 144 additions and 112 deletions

View file

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

View file

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View file

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

View file

Before

Width:  |  Height:  |  Size: 56 KiB

After

Width:  |  Height:  |  Size: 56 KiB

View file

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 53 KiB

View file

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 53 KiB

View file

Before

Width:  |  Height:  |  Size: 51 KiB

After

Width:  |  Height:  |  Size: 51 KiB

View file

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

View file

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 53 KiB

View file

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

View file

@ -2,6 +2,7 @@
:toclevels: 3
:numbered:
:linkattrs:
:context:
include::topics/templates/document-attributes-product.adoc[]

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 17 KiB

View file

@ -1,24 +1,6 @@
ifeval::[{project_community}==true]
include::topics/introduction-keycloak.adoc[]
endif::[]
include::topics/first-boot.adoc[]
ifeval::[{project_community}==true]
include::topics/first-boot/distribution-files-community.adoc[]
endif::[]
ifeval::[{project_product}==true]
include::topics/first-boot/distribution-files-product.adoc[]
endif::[]
include::topics/first-boot/boot.adoc[]
include::topics/first-boot/initial-user.adoc[]
include::topics/first-boot/admin-console.adoc[]
include::topics/first-realm.adoc[]
include::topics/first-realm/realm-definition.adoc[]
include::topics/first-realm/realm.adoc[]
include::topics/first-realm/user.adoc[]
include::topics/first-realm/account.adoc[]
include::topics/secure-jboss-app.adoc[]
include::topics/secure-jboss-app/before.adoc[]
include::topics/secure-jboss-app/install-client-adapter.adoc[]
include::topics/secure-jboss-app/create-client.adoc[]
include::topics/secure-jboss-app/subsystem.adoc[]
include::topics/secure-jboss-app/download-quickstarts.adoc[]
include::topics/assembly-installing-standalone.adoc[]
include::topics/assembly-creating-first-realm.adoc[]
include::topics/assembly-securing-sample-app.adoc[]

View file

@ -0,0 +1,22 @@
// UserStory: As an RH SSO customer, I want to perform initial admin procedures
// This assembly is included in the following assemblies:
//
// <List assemblies here, each on a new line>
// Retains the context of the parent assembly if this assembly is nested within another assembly.
// See also the complementary step on the last line of this file.
ifdef::context[:parent-context: {context}]
[id="creating-first-realm_{context}"]
== Creating a realm and a user
The first use of the {project_name} admin console is to create a realm and create a user in that realm. You use that user to log in to your new realm and visit the built-in account console, to which all users have access.
include::first-realm/con-realms-apps.adoc[leveloffset=2]
include::first-realm/proc-create-realm.adoc[leveloffset=2]
include::first-realm/proc-create-user.adoc[leveloffset=2]
include::first-realm/proc-view-account.adoc[leveloffset=2]
// Restore the context to what it was before this assembly.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]

View file

@ -0,0 +1,36 @@
// UserStory: As an RH SSO customer, I want to perform a quick setup of SSO.
// This assembly is included in the following assemblies:
//
// <List assemblies here, each on a new line>
// Retains the context of the parent assembly if this assembly is nested within another assembly.
// See also the complementary step on the last line of this file.
ifdef::context[:parent-context: {context}]
[id="installing-standalone_{context}"]
== Installing a sample instance of {project_name}
This section describes how to install and start a {project_name} server in standalone mode, set up the initial admin user, and log in to the {project_name} Admin Console.
ifeval::[{project_product}==true]
.Additional Resources
This installation is intended for practice use of {project_name}. For instructions on installation in a production environment and full details on all product features, see the other guides in the link:http://access.redhat.com/documentation/en-us/red_hat_single_sign-on/{project_versionDoc}/[{project_name}] documentation.
endif::[]
ifeval::[{project_community}==true]
include::standalone/proc-installing-server-community.adoc[leveloffset=2]
endif::[]
ifeval::[{project_product}==true]
include::standalone/proc-installing-server-product.adoc[leveloffset=2]
endif::[]
include::standalone/proc-starting-server.adoc[leveloffset=2]
include::standalone/proc-creating-admin.adoc[leveloffset=2]
include::standalone/proc-logging-in-admin-console.adoc[leveloffset=2]
// Restore the context to what it was before this assembly.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]

View file

@ -0,0 +1,28 @@
// UserStory: As an RH SSO customer, I want to complete the initial configuration of my standalone server
// This assembly is included in the following assemblies:
//
// <List assemblies here, each on a new line>
// Retains the context of the parent assembly if this assembly is nested within another assembly.
// See also the complementary step on the last line of this file.
ifdef::context[:parent-context: {context}]
[id="securing-sample-app_{context}"]
== Securing a sample application
Now that you have an admin account, a realm, and a user, you can use {project_name} to secure a sample {appserver_name} servlet application. You install a {appserver_name} client adapter, register the application in the admin console, modify the {appserver_name} instance to work with {project_name}, and use {project_name} with some sample code to secure the application.
.Prerequisites
* You need to adjust the port used by {project_name} to avoid port conflicts with {appserver_name}.
include::sample-app/proc-adjusting-ports.adoc[leveloffset=2]
include::sample-app/proc-installing-client-adapter.adoc[leveloffset=2]
include::sample-app/proc-registering-app.adoc[leveloffset=2]
include::sample-app/proc-modifying-app.adoc[leveloffset=2]
include::sample-app/proc-installing-sample-code.adoc[leveloffset=2]
// Restore the context to what it was before this assembly.
ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]

View file

@ -1,9 +0,0 @@
[[_install-boot]]
== Installing a sample instance of {project_name}
This section describes how to install and start a {project_name} server in standalone mode, set up the initial admin user, and log in to the {project_name} admin console.
.Additional resources
This installation is intended for practice use of {project_name}. For instructions on installation in a production environment and full details on all product features, see the other guides in the {project_name} documentation.

View file

@ -1,4 +0,0 @@
[id="_first-steps"]
== Creating a realm and a user
The first use of the {project_name} admin console is to create a realm and create a user in that realm. You use that user to log in to your new realm and visit the built-in account console, to which all users have access.

View file

@ -1,5 +0,0 @@
=== Before You Start
Before you can create your first realm, complete the installation of {project_name} and create the initial admin user as shown in <<_install-boot, Installing and Booting>>.

View file

@ -1,10 +1,12 @@
// UserStory: As an RH SSO customer, I need to know what are the purposes of different realms
[id="realms-users"]
=== Realms and users
[id="realms-apps_{context}"]
= Realms and users
When you log in to the admin console, you work in a realm, which is a space where you manage objects. Two types of realms exist:
* `Master realm` - This realm was created for you when you first started {project_name}. It contains the admin account you created at the first login. You use this realm only to create other realms.
* `Other realms` - These realms are created by the admin in the master realm. In these realms, administrators create users and applications. The applications are owned by the users.
image:images/master_realm.png[]
image:images/master_realm.png[Realms and applications]

View file

@ -1,5 +1,7 @@
[[_create-realm]]
=== Creating a realm
// UserStory: As an RH SSO customer, I need to know hoq to create a realm that protects applications
[id="create-realm_{context}"]
= Creating a realm
As the admin in the master realm, you create the realms where administrators create users and applications.
@ -17,7 +19,7 @@ As the admin in the master realm, you create the realms where administrators cre
. Type `demo` in the *Name* field.
+
.A new realm
image:{project_images}/add-demo-realm.png[]
image:images/add-demo-realm.png[A new realm]
+
NOTE: The realm name is case-sensitive, so make note of the case that you use.
@ -26,6 +28,6 @@ NOTE: The realm name is case-sensitive, so make note of the case that you use.
The main admin console page opens with realm set to `demo`.
+
.Demo realm
image:{project_images}/demo-realm.png[]
image:images/demo-realm.png[Demo realm]
. Switch between managing the `master` realm and the realm you just created by clicking entries in the *Select realm* drop-down list.

View file

@ -1,6 +1,7 @@
[[_create-user]]
// UserStory: As an RH SSO customer, I want to create a user in my first realm
=== Creating a user
[id="create-user_{context}"]
= Creating a user
In the `demo` realm, you create a new user and a temporary password for that new user.
@ -15,7 +16,7 @@ In the `demo` realm, you create a new user and a temporary password for that new
This is the only required field.
+
.Add user page
image:{project_images}/add-user.png[]
image:images/add-user.png[Add user page]
. Flip the *Email Verified* switch to *On* and click *Save*.
+
@ -28,10 +29,9 @@ The management page for the new user opens.
. Click *Set Password* to set the user password to the new one you specified.
+
.Manage Credentials page
image:{project_images}/user-credentials.png[]
image:images/user-credentials.png[Manage Credentials page]
+
[NOTE]
====
This password is temporary and the user will be required to change it at the first login. If you prefer to create a password that is persistent, flip the *Temporary* switch to *Off* and click *Set Password*.
====

View file

@ -1,5 +1,7 @@
// UserStory: As an RH SSO customer, I want to test the login for the first user
=== Logging into the account console
[id="view-account_{context}"]
= Logging into the Account Console
Every user in a realm has access to the account console. You use this console to update your profile information and change your credentials. You can now test logging in with that user in the realm that you created.
.Procedure
@ -10,7 +12,7 @@ Every user in a realm has access to the account console. You use this console to
. When you are asked to supply a new password, enter a password that you can remember.
+
.Update password
image:{project_images}/update-password.png[]
image:images/update-password.png[Update password]
+
The account console opens for this user.
+
@ -21,4 +23,4 @@ image:images/account-console.png[]
.Next steps
You are now ready for the final procedure, which is to secure a sample application that runs on {appserver_name}. See xref:_sample-application[Securing a sample application].
You are now ready for the final procedure, which is to secure a sample application that runs on {appserver_name}. See xref:securing-sample-app_{context}[Securing a sample application].

View file

@ -1,12 +0,0 @@
[id="basic-install"]
== Installing a sample instance of {project_name}
This section describes how to install and start a {project_name} server in standalone mode, set up the initial admin user, and log in to the {project_name} Admin Console.
.Additional resources
This installation is intended for practice use of {project_name}. For instructions on installation in a production environment and full details on all product features, see the other guides in the {project_name} documentation.
ifeval::[{project_product}==true]
{project_name} is based on the open source link:https://www.keycloak.org/[Keycloak] community project, which has its documentation link:https://www.keycloak.org/documentation.html[here].
endif::[]

View file

@ -1,5 +1,6 @@
=== Adjusting the port used by {project_name}
[id="adjusting-ports_{context}"]
= Adjusting the port used by {project_name}
The instructions in this guide apply to running {appserver_name} on the same machine as the {project_name} server. In this situation, even though {appserver_name} is bundled with {project_name}, you cannot use {appserver_name} as an application container. You must run a separate {appserver_name} instance for your servlet application.

View file

@ -1,5 +1,6 @@
=== Installing the {appserver_name} client adapter
[id="installing-client-adapter_{context}"]
= Installing the {appserver_name} client adapter
When {appserver_name} and {project_name} are installed on the same machine, {appserver_name} requires some modification. To make this modification, you install a {project_name} client adapter.

View file

@ -1,6 +1,6 @@
[id="deploy-code"]
=== Installing sample code to secure the application
[id="installing-sample-code_{context}"]
= Installing sample code to secure the application
The final procedure is to make this application secure by installing some sample code from the {quickstartRepo_link} repository. The quickstarts work with the most recent {project_name} release.
@ -38,17 +38,17 @@ $ cd {quickstartRepo_dir}/app-profile-jee-vanilla/config
$ mvn clean wildfly:deploy
----
. Confirm that the application installationt succeeded. Go to http://localhost:8080/vanilla where a login page should appear.
. Confirm that the application installationt succeeded. Go to http://localhost:8080/vanilla where a login page is displayed.
+
.Login page confirming success
image:images/vanilla.png[]
image:images/vanilla.png[Login page confirming success]
. Log in using the account that you created in the demo realm.
+
.Login page to demo realm
image:images/demo-login.png[]
image:images/demo-login.png[Login page to demo realm]
+
A message appears indicating you have completed a successful use of {project_name} to protect a sample {appserver_name} application. Congratulations!
+
.Complete success
image:images/success.png[]
image:images/success.png[Complete success]

View file

@ -1,6 +1,6 @@
[id="configure-appserver"]
=== Modifying the {appserver_name} instance
[id="modifying-app_{context}"]
= Modifying the {appserver_name} instance
The {appserver_name} servlet application requires additional configuration before it is secured by {project_name}.

View file

@ -1,5 +1,6 @@
=== Registering the {appserver_name} application
[id="registering-app_{context}"]
= Registering the {appserver_name} application
You can now define and register the client in the {project_name} admin console.
@ -16,14 +17,14 @@ You can now define and register the client in the {project_name} admin console.
. Click `Clients` in the left side menu to open the Clients page.
+
.Clients
image:{project_images}/clients.png[]
image:images/clients.png[Clients]
. On the right side, click *Create*.
. On the Add Client dialog, create a client called *vanilla* by completing the fields as shown below:
+
.Add Client
image:{project_images}/add-client.png[]
image:images/add-client.png[Add Client]
. Click *Save*.
@ -32,7 +33,7 @@ image:{project_images}/add-client.png[]
. Select *Keycloak OIDC JSON* to generate a file that you need in a later procedure.
+
.Keycloak.json file
image:{project_images}/client-install-selected.png[]
image:images/keycloak-json.png[Keycloak.json file]
. Click *Download* to save *Keycloak.json* in a location that you can find later.
@ -40,8 +41,6 @@ image:{project_images}/client-install-selected.png[]
. Select *Keycloak OIDC JBoss Subsystem XML* to generate an XML template.
+
.Template XML
image:{project_images}/client-install-selected.png[]
. Click *Download* to save a copy for use in the next procedure, which involves {appserver_name} configuration.
image:images/client-install-selected.png[Template XML]
. Click *Download* to save a copy for use in the next procedure, which involves {appserver_name} configuration.

View file

@ -1,9 +0,0 @@
[id="_sample-application"]
== Securing a sample application
Now that you have an admin account, a realm, and a user, you can use {project_name} to secure a sample {appserver_name} servlet application. You install a {appserver_name} client adapter, register the application in the admin console, modify the {appserver_name} instance to work with {project_name}, and use {project_name} with some sample code to secure the application.
.Prerequisites
* You need to adjust the port used by {project_name} to avoid port conflicts with {appserver_name}.

View file

@ -1,6 +1,6 @@
[id="create-admin"]
=== Creating the admin account
[id="create-admin_{context}"]
= Creating the admin account
Before you can use {project_name}, you need to create an admin account which you use to log in to the {project_name} admin console.
@ -14,10 +14,7 @@ Before you can use {project_name}, you need to create an admin account which you
The welcome page opens, confirming that the server is running.
+
.Welcome page
image:{project_images}/welcome.png[]
image:images/welcome.png[Welcome page]
. Enter a username and password to create an initial admin user.
// Additional resources
// For more information, see the
// link:{installguide_link}[{installguide_name}] and the link:{adminguide_link}[{adminguide_name}].

View file

@ -1,6 +1,6 @@
[id="standalone-keycloak-install"]
=== Installing the Server
[id="installing-server-community_{context}"]
= Installing the Server
You can install the server on Linux or Windows. The server download ZIP file contains the scripts and binaries to run the {project_name} server.
.Procedure

View file

@ -1,10 +1,9 @@
[id="standalone-install"]
=== Installing the {project_name} server
[id="installing-server-product_{context}"]
= Installing the {project_name} server
For this sample instance of {project_name}, this procedure involves installation in standalone mode. The server download ZIP file contains the scripts and binaries to run the {project_name} server. You can install the server on Linux or Windows.
.Procedure
. Go to the https://access.redhat.com/jbossnetwork/restricted/listSoftware.html?downloadType=distributions&product=core.service.rhsso[Red Hat customer portal].
@ -32,4 +31,3 @@ $ tar -xvzf rh-sso-{project_version_base}.tar.gz
----
> Expand-Archive -Path 'C:Downloads\rhsso-{project_version_base}.zip` -DestinationPath 'C:\Downloads'
----

View file

@ -1,5 +1,5 @@
[id="login-admin"]
=== Logging into the admin console
[id="logging-in-admin-console_{context}"]
= Logging into the admin console
After you create the initial admin account, you can log in to the admin console. In this console, you add users and register applications to be secured by {project_name}.
@ -18,13 +18,13 @@ The Administration Console is generally referred to as the admin console for sho
. Enter the username and password you created on the *Welcome* page to open the *admin console*.
+
.Admin console login screen
image:images/admin-login.png[]
image:images/admin-login.png[Admin console login screen]
+
The initial screen for the admin console appears.
+
.Admin console
image:{project_images}/admin-console.png[]
image:images/admin-console.png[Admin console]
.Next steps
Now that you can log into the admin console, you can begin creating realms where administrators can create users and give them access to applications. For more details, see xref:_first-steps[Creating a realm and a user].
Now that you can log into the admin console, you can begin creating realms where administrators can create users and give them access to applications. For more details, see xref:creating-first-realm_{context}[Creating a realm and a user].

View file

@ -1,5 +1,5 @@
[id="boot-server"]
=== Starting the {project_name} server
[id="starting-server_{context}"]
= Starting the {project_name} server
You start the server on the system where you installed it.