libre.sh/keycloak-scim
4
0
Fork 0
Code Issues 15 Pull requests Releases 1 Activity Actions

KEYCLOAK-7127 third and final set of changes from Getting Started review

Browse source
This commit is contained in:
Matthew Helmke 2018-05-07 11:43:10 -05:00
parent 099e783052
commit e2d85aca8d
7 changed files with 14 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
getting_started/topics/first-boot.adoc
View file

@ -2,6 +2,5 @@
== Installing and Booting
This very short tutorial walks you through booting up the server in standalone mode, setting up the initial admin user,
and logging into the {project_name} admin console.
This very short section describes how to boot a {project_name} server in standalone mode, set up the initial admin user, and log in to the {project_name} admin console.

8
getting_started/topics/first-boot/admin-console.adoc
View file

@ -1,21 +1,21 @@
=== Logging in to the Admin Console
After you create the initial admin account, you can log in to the Admin Console by completing the following steps:
After you create the initial admin account, use the following steps to log in to the Admin Console:
. At the bottom of the Welcome page click the _Administration Console_ link.
. At the bottom of the *Welcome* page click the *Administration Console* link.
Alternatively you can go to the console URL directly at http://localhost:8080/auth/admin/
+
.Login Page
image:{project_images}/login-page.png[]
. Type the username and password you created on the Welcome page. The {project_name} Admin Console page opens.
. Type the username and password you created on the Welcome page to open the *{project_name} Admin Console* page.
+
.Admin Console
image:{project_images}/admin-console.png[]
NOTE: If you are curious about a certain feature, button, or field within the Admin Console, hover your mouse
over the question mark `?` icon. This will pop up tooltip text to describe the area of the console you are interested in.
over the question mark `?` icon. This will pop up tooltip text to describe the area of the console you are interested in.
The image above shows the tooltip in action.

2
getting_started/topics/first-boot/boot.adoc
View file

@ -1,7 +1,7 @@
=== Booting the Server
To boot the {project_name} server, go to the _bin/_ directory of the server distribution.
To boot the {project_name} server, go to the _bin/_ directory of the server distribution and run the `standalone` boot script.
.Standalone Boot Scripts
image:{project_images}/standalone-boot-files.png[]

3
getting_started/topics/first-boot/distribution-files-community.adoc
View file

@ -5,7 +5,6 @@ The {project_name} Server is contained in one https://www.keycloak.org/downloads
* 'keycloak-{project_version}.[zip|tar.gz]'
The 'keycloak-{project_version}.[zip|tar.gz]' file is the server only distribution. It contains nothing other than the scripts and binaries
to run the {project_name} server.
The 'keycloak-{project_version}.[zip|tar.gz]' file is the server-only distribution. It contains only the scripts and binaries to run the {project_name} server.
To unpack these files run the `unzip` or `gunzip` and `tar` utilities.

6
getting_started/topics/first-boot/distribution-files-product.adoc
View file

@ -5,10 +5,8 @@ The {project_name} Server is contained in one distribution file:
* 'rh-sso-{project_version}.GA.zip'
NOTE: This file can be downloaded in the Red Hat customer portal
https://access.redhat.com/jbossnetwork/restricted/listSoftware.html?downloadType=distributions&product=core.service.rhsso[Downloads].
NOTE: This file can be downloaded from https://access.redhat.com/jbossnetwork/restricted/listSoftware.html?downloadType=distributions&product=core.service.rhsso[the Red Hat customer portal].
The 'rh-sso-{project_version}.GA.zip' file is the server-only distribution. It contains only the scripts and binaries
to run the {project_name} server.
The 'rh-sso-{project_version}.GA.zip' file is the server-only distribution. It contains only the scripts and binaries to run the {project_name} server.
To unpack these files run the `unzip` or `gunzip` utilities.

10
getting_started/topics/first-boot/initial-user.adoc
View file

@ -1,17 +1,15 @@
=== Creating the Admin Account
After the server boots, open your browser and go to the http://localhost:8080/auth URL. The page should look like this:
After the server boots, open http://localhost:8080/auth in your web browser. The page should look like this:
.Welcome Page
image:{project_images}/initial-welcome-page.png[]
{project_name} does not have a configured admin account by default. You must create one on the Welcome page.
This account will allow you to create an admin that can log into the _master_ realm's administration console so that
you can start creating realms and users and registering applications to be secured by {project_name}.
By default, {project_name} does not have a configured admin account. You must create one on the Welcome page. The admin account you create will be permitted to log in to the _master_ realm's administration console where you can start creating realms and users and registering applications to be secured by {project_name}.
NOTE: You can only create an initial admin user on the Welcome Page if you connect using `localhost`. This is a security
precaution. You can also create the initial admin user at the command line with the `add-user-keycloak.sh` script. For more details see
link:{installguide_link}[{installguide_name}] and link:{adminguide_link}[{adminguide_name}].
precaution. You can also create the initial admin user at the command line with the `add-user-keycloak.sh` script. For more details, see the
link:{installguide_link}[{installguide_name}] and the link:{adminguide_link}[{adminguide_name}].

5
getting_started/topics/overview.adoc
View file

@ -1,10 +1,7 @@
== Overview
The purpose of this guide is to get you up and running as quickly as possible so that you can
play with and test-drive various features that {project_name} has. It relies heavily on the default database
and server configuration and does not cover any complex deployment options. If you want a more
in-depth discussion of any features or configuration options, consult the various reference guides available.
The purpose of this guide is to install {project_name} as quickly as possible so that you can play with and test-drive various features. It relies heavily on the default database and server configuration and does not cover any complex deployment options. For a deeper description of features or configuration options, consult the other reference guides.
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].