more edits to streamline this part of the doc

This commit is contained in:
Matthew Helmke 2018-05-15 09:28:04 -05:00
parent e2d85aca8d
commit a577c993ff
13 changed files with 48 additions and 35 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 45 KiB

View file

@ -2,5 +2,5 @@
== Installing and Booting
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.
This 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.

View file

@ -1,23 +1,12 @@
=== Logging in to the Admin Console
After you create the initial admin account, use the following steps to log in to the Admin Console:
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.
Alternatively you can go to the console URL directly at http://localhost:8080/auth/admin/
+
.Login Page
image:{project_images}/login-page.png[]
. Click the *Administration Console* link on the *Welcome* page or go directly to the console URL http://localhost:8080/auth/admin/
. Type the username and password you created on the Welcome page to open the *{project_name} Admin Console* page.
. Type the username and password you created on the *Welcome* page to open the *{project_name} Admin Console*.
+
.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.
The image above shows the tooltip in action.

View file

@ -1,12 +1,7 @@
=== Booting the Server
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[]
To boot the server:
To boot the {project_name} server, go to the `bin` directory of the server distribution and run the `standalone` boot script:
.Linux/Unix
[source]

View file

@ -1,10 +1,28 @@
=== Installing Distribution Files
The {project_name} Server is contained in one https://www.keycloak.org/downloads.html[distribution file]:
Download the {project_name} Server:
* 'keycloak-{project_version}.[zip|tar.gz]'
* *keycloak-{project_version}.[zip|tar.gz]*
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.
NOTE: This file can be downloaded from https://www.keycloak.org/downloads.html[Keycloak downloads].
To unpack these files run the `unzip` or `gunzip` and `tar` utilities.
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.
Place the file in a directory you choose and use either the `unzip` or `tar` utility to extract it.
.Linux/Unix
[source]
----
$ unzip keycloak-{project_version}.zip
or
$ tar -xvzf keycloak-{project_version}.tar.gz
----
.Windows
[source]
----
> unzip keycloak-{project_version}.zip
----

View file

@ -1,12 +1,24 @@
=== Installing the Server
The {project_name} Server is contained in one distribution file:
Download the {project_name} Server:
* 'rh-sso-{project_version}.GA.zip'
* *rh-sso-{project_version}.GA.zip*
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.
Place the file in a directory you choose and use the `unzip` utility to unpack it, like this:
.Linux/Unix
[source]
----
$ unzip rh-sso-{project_version}.GA.zip
----
.Windows
[source]
----
> unzip rh-sso-{project_version}.GA.zip
----

View file

@ -1,15 +1,14 @@
=== Creating the Admin Account
After the server boots, open http://localhost:8080/auth in your web browser. The page should look like this:
After the server boots, open http://localhost:8080/auth in your web browser. The welcome page will indicate that the server is running.
.Welcome Page
image:{project_images}/initial-welcome-page.png[]
Enter a username and password to create an initial admin user.
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}.
This account will be permitted to log in to the `master` realm's administration console, from which you will create realms and users and register 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 the
precaution. You can create the initial admin user at the command line with the `add-user-keycloak.sh` script. For more information, see the
link:{installguide_link}[{installguide_name}] and the link:{adminguide_link}[{adminguide_name}].

View file

@ -1,7 +1,7 @@
== Overview
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.
This guide helps you get started with {project_name}. It covers server configuration and use of the default database. Advanced deployment options are not covered. 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].