diff --git a/SUMMARY.adoc b/SUMMARY.adoc index 5479e6f138..44fdbe06b9 100755 --- a/SUMMARY.adoc +++ b/SUMMARY.adoc @@ -11,6 +11,10 @@ .. link:topics/first-boot/boot.adoc[Boot Server] .. link:topics/first-boot/initial-user.adoc[Create Admin Account] .. link:topics/first-boot/admin-console.adoc[Login Into Admin Console] - . link:topics/first-realm-user.adoc[Creating Your First Realm and User] + . link:topics/first-realm.adoc[Creating Your First Realm and User] + .. link:topics/first-realm/before.adoc[Before You Start] + .. link:topics/first-realm/realm.adoc[Create a New Realm] + .. link:topics/first-realm/user.adoc[Create a New User] + .. link:topics/first-realm/account.adoc[User Account Service] . link:topics/first-jboss-servlet.adoc[Securing a JBoss Servlet Application] .. link:topics/installation/system-requirements.adoc[System Requirements] diff --git a/keycloak-images/add-realm-menu.png b/keycloak-images/add-realm-menu.png new file mode 100755 index 0000000000..9989759cf0 Binary files /dev/null and b/keycloak-images/add-realm-menu.png differ diff --git a/keycloak-images/add-user.png b/keycloak-images/add-user.png new file mode 100755 index 0000000000..95cb156cba Binary files /dev/null and b/keycloak-images/add-user.png differ diff --git a/keycloak-images/create-realm.png b/keycloak-images/create-realm.png new file mode 100755 index 0000000000..2543f39421 Binary files /dev/null and b/keycloak-images/create-realm.png differ diff --git a/keycloak-images/credentials.png b/keycloak-images/credentials.png new file mode 100755 index 0000000000..36a217db52 Binary files /dev/null and b/keycloak-images/credentials.png differ diff --git a/keycloak-images/logout.png b/keycloak-images/logout.png new file mode 100755 index 0000000000..8504a461b7 Binary files /dev/null and b/keycloak-images/logout.png differ diff --git a/keycloak-images/update-password.png b/keycloak-images/update-password.png new file mode 100755 index 0000000000..8c3e9b0e9d Binary files /dev/null and b/keycloak-images/update-password.png differ diff --git a/keycloak-images/user-account-service.png b/keycloak-images/user-account-service.png new file mode 100755 index 0000000000..f06b1344f3 Binary files /dev/null and b/keycloak-images/user-account-service.png differ diff --git a/keycloak-images/users.png b/keycloak-images/users.png new file mode 100755 index 0000000000..6d6ea14eb4 Binary files /dev/null and b/keycloak-images/users.png differ diff --git a/rhsso-images/add-realm-menu.png b/rhsso-images/add-realm-menu.png new file mode 100755 index 0000000000..fd25940fc5 Binary files /dev/null and b/rhsso-images/add-realm-menu.png differ diff --git a/rhsso-images/add-user.png b/rhsso-images/add-user.png new file mode 100755 index 0000000000..9185d09bc6 Binary files /dev/null and b/rhsso-images/add-user.png differ diff --git a/rhsso-images/create-realm.png b/rhsso-images/create-realm.png new file mode 100755 index 0000000000..681d0868a7 Binary files /dev/null and b/rhsso-images/create-realm.png differ diff --git a/rhsso-images/credentials.png b/rhsso-images/credentials.png new file mode 100755 index 0000000000..64df1a46d8 Binary files /dev/null and b/rhsso-images/credentials.png differ diff --git a/rhsso-images/logout.png b/rhsso-images/logout.png new file mode 100755 index 0000000000..a6e4575601 Binary files /dev/null and b/rhsso-images/logout.png differ diff --git a/rhsso-images/update-password.png b/rhsso-images/update-password.png new file mode 100755 index 0000000000..7862dd488c Binary files /dev/null and b/rhsso-images/update-password.png differ diff --git a/rhsso-images/user-account-service.png b/rhsso-images/user-account-service.png new file mode 100755 index 0000000000..386a672a65 Binary files /dev/null and b/rhsso-images/user-account-service.png differ diff --git a/rhsso-images/users.png b/rhsso-images/users.png new file mode 100755 index 0000000000..6d0d35d869 Binary files /dev/null and b/rhsso-images/users.png differ diff --git a/topics/first-boot.adoc b/topics/first-boot.adoc index fefd680b79..8ab231c943 100755 --- a/topics/first-boot.adoc +++ b/topics/first-boot.adoc @@ -1,3 +1,5 @@ +[[_install-boot]] + == Install and Boot This very short tutorial walks you through booting up the server in standalone mode, setting up the initial admin user, diff --git a/topics/first-realm.adoc b/topics/first-realm.adoc new file mode 100755 index 0000000000..97ccb152d8 --- /dev/null +++ b/topics/first-realm.adoc @@ -0,0 +1,6 @@ + +== Create a Realm and User + +This short tutorial walks you through creating a new realm within the {{book.project.name}} Admin Console and adding +a new user to that realm. With that new user you will log into your new realm and visit the built-in User Account +service that all users have access to. \ No newline at end of file diff --git a/topics/first-realm/account.adoc b/topics/first-realm/account.adoc new file mode 100755 index 0000000000..4d6fc89cdb --- /dev/null +++ b/topics/first-realm/account.adoc @@ -0,0 +1,24 @@ + +== User Account Service + +After creating the user, logout of the management console by clicking the right hand drop down menu and selecting `Sign Off`. +Next, login to the User Account Service of your `demo` realm with the user you just created by clicking this link: + +User Account Link:: + http://localhost:8080/auth/realms/demo/account + +Enter in the username and temporary password you created. You will be asked to change and create a permanent password after you +successfully login. + +.Update Password +image:../../{{book.images}}/update-password.png[] + +Finally, you will be brought to the User Account Service. Every user in a realm has access to this Account Service by default. +It allows you to update profile information and change or add additional credentials. More information on this service is provided +in the link:{{book.adminguide.link}}[{{book.adminguide.name}}]. + + + + + + diff --git a/topics/first-realm/before.adoc b/topics/first-realm/before.adoc new file mode 100755 index 0000000000..4499ca9801 --- /dev/null +++ b/topics/first-realm/before.adoc @@ -0,0 +1,6 @@ + +=== Before You Start + +Before you can participate in this tutorial, you need to complete the installation of {{book.project.name}} and create the +initial admin user as shown in the <> tutorial. + diff --git a/topics/first-realm/realm.adoc b/topics/first-realm/realm.adoc new file mode 100755 index 0000000000..3607bc17ec --- /dev/null +++ b/topics/first-realm/realm.adoc @@ -0,0 +1,29 @@ +[[_create-realm]] + +=== Create a New Realm + +Login to the {{book.project.name}} Admin Console using the account you created in the +<> tutorial. + +Admin Console Link:: + http://localhost:8080/auth/admin/ + +Mouse over the top left corner drop down menu that is titled with `Master`. If you are logged in the master realm +this drop down menu lists all the realms created. The last entry of this drop down menu is always `Add Realm`. Click +this to add a realm. + +.Add Realm Menu +image:../../{{book.images}}/add-realm-menu.png[] + +This menu option will bring you to the `Add Realm` page. You will be creating a brand new realm from scratch so +enter in `demo` for the realm name and click `Create`. + +.Create Realm +image:../../{{book.images}}/create-realm.png[] + +After creating the realm you are brought back to the main Admin Console page. The current realm will now be set to +`demo`. You can switch between managing the `master` realm and the realm you just created by doing a mouse over on the +top left corner drop down menu. + + + diff --git a/topics/first-realm/user.adoc b/topics/first-realm/user.adoc new file mode 100755 index 0000000000..625cd7e7b3 --- /dev/null +++ b/topics/first-realm/user.adoc @@ -0,0 +1,30 @@ + +=== Create a New User + +In this section you are going to create a new user in the `demo` realm as well as a temporary password for that account. +The first step is to click on the `Users` in the left menu bar. + +.Users +image:../../{{book.images}}/users.png[] + +This menu option brings you to the user list page. On the right side of the empty user list, you should see an `Add User` +button. Click that to start creating your new user. + +.Add User +image:../../{{book.images}}/add-user.png[] + +The only required field is `Username`. Click save. This will bring you to the management page for your new user. + +The next step is to define a temporary password for your new user. Click on the `Credentials` tab to bring you to +the page that will allo you to do this. + +.Set Temporary Password +image:../../{{book.images}}/credentials.png[] + +Enter in a new password and retype it within the `Password Confirmation` field. Once you do this a red `Reset Password` +button should reappear. Clicking on that will reset the user's password to the new one you specified. Please note that +this is a temporary password and the user will be required to change it after they first log in. You can make it permanent +by flipping the `Temporary` switch from `On` to `Off` before you click the `Reset Password` button. + + + diff --git a/topics/overview.adoc b/topics/overview.adoc index 0e7d3cdd22..6086dd7070 100755 --- a/topics/overview.adoc +++ b/topics/overview.adoc @@ -1,3 +1,4 @@ + == Overview The purpose of this guide is to get you up and running as quickly as possible so that you can