diff --git a/book.json b/book.json index 85bef509e2..32fd74ac21 100755 --- a/book.json +++ b/book.json @@ -35,7 +35,43 @@ "link": "https://keycloak.gitbooks.io/keycloak-documentation/content/server_installation/index.html" }, - "appServer": "WildFly 10", - "quickstartRepo": "https://github.com/keycloak/keycloak-quickstarts" + "quickstartRepo": "https://github.com/keycloak/keycloak-quickstarts", + + "appserver": { + "name": "Wildfly", + "version": "10", + "admindoc": { + "name": "WildFly 10 Documentation", + "link": "https://docs.jboss.org/author/display/WFLY10/Documentation" + }, + "datasource": { + "name": "WildFly 10 Documentation", + "link": "https://docs.jboss.org/author/display/WFLY10/DataSource+configuration" + }, + "network": { + "name": "WildFly 10 Documentation", + "link": "https://docs.jboss.org/author/display/WFLY10/Interfaces+and+ports" + }, + "socket": { + "name": "WildFly 10 Documentation", + "link": "https://docs.jboss.org/author/display/WFLY10/Interfaces+and+ports" + }, + "loadbalancer": { + "name": "WildFly 10 Documentation", + "link": "https://docs.jboss.org/author/display/WFLY10/High+Availability+Guide" + }, + "jgroups": { + "name": "WildFly 10 Documentation", + "link": "https://docs.jboss.org/author/display/WFLY10/JGroups+Subsystem" + }, + "caching": { + "name": "WildFly 10 Documentation", + "link": "https://docs.jboss.org/author/display/WFLY10/Infinispan+Subsystem" + }, + "jpa": { + "name": "WildFly 10 Documentation", + "link": "https://docs.jboss.org/author/display/WFLY10/JPA+Reference+Guide#JPAReferenceGuide-Hibernateproperties" + } + } } } diff --git a/getting_started/book.json b/getting_started/book.json deleted file mode 100755 index fd3933ddf9..0000000000 --- a/getting_started/book.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "gitbook": "2.x.x", - "structure": { - "readme": "README.adoc" - }, - "plugins": [ - "toggle-chapters", - "ungrey", - "splitter" - ], - "variables": { - "title": "Getting Started Guide", - "project": { - "name": "Keycloak", - "version": "SNAPSHOT" - }, - "community": true, - "product": false, - "images": "keycloak-images", - - "installguide": { - "name": "Server Installation and Configuration Guide", - "link": "https://keycloak.gitbooks.io/server-installation-and-configuration/content/" - - }, - "adminguide": { - "name": "Server Administration Guide", - "link": "https://keycloak.gitbooks.io/server-adminstration-guide/content/" - }, - "clientadapter": "RH-SSO-{{book.project.version}}-eap7-adapter.zip", - "appServer": "WildFly 10", - "quickstartRepo": "https://github.com/redhat-developer/redhat-sso-quickstarts" - } -} \ No newline at end of file diff --git a/getting_started/topics/secure-jboss-app.adoc b/getting_started/topics/secure-jboss-app.adoc index ffe967344c..ba07252c10 100644 --- a/getting_started/topics/secure-jboss-app.adoc +++ b/getting_started/topics/secure-jboss-app.adoc @@ -1,7 +1,7 @@ == Securing a JBoss Servlet Application -In this section you will learn how to secure a Java Servlet application on the {{book.appServer}} application server. You will learn how to install the -{{book.project.name}} Client Adapter onto a {{book.appServer}} application server distribution. You will create and register a client application in the +In this section you will learn how to secure a Java Servlet application on the {{book.appserver.name}} application server. You will learn how to install the +{{book.project.name}} Client Adapter onto a {{book.appserver.name}} application server distribution. You will create and register a client application in the {{book.project.name}} Admin Console. Finally, you will configure the application to be secured by {{book.project.name}}. diff --git a/getting_started/topics/secure-jboss-app/before.adoc b/getting_started/topics/secure-jboss-app/before.adoc index 7951fb9cc9..2d204182dd 100755 --- a/getting_started/topics/secure-jboss-app/before.adoc +++ b/getting_started/topics/secure-jboss-app/before.adoc @@ -3,7 +3,7 @@ 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. There is one -caveat to this. You have to run a separate {{book.appServer}} instance on the same machine as the +caveat to this. You have to run a separate {{book.appserver.name}} instance on the same machine as the {{book.project.name}} server. This separate instance will run your Java Servlet application. Because of this you will have to run the {{book.project.name}} under a different port so that there are no port conflicts when running on the same machine. Use the `jboss.socket.binding.port-offset` system property on the command line. The value of this property diff --git a/getting_started/topics/secure-jboss-app/create-client.adoc b/getting_started/topics/secure-jboss-app/create-client.adoc index 38902ff641..0bbd96d42c 100644 --- a/getting_started/topics/secure-jboss-app/create-client.adoc +++ b/getting_started/topics/secure-jboss-app/create-client.adoc @@ -19,7 +19,7 @@ image:../../{{book.images}}/clients.png[] .Add Client image:../../{{book.images}}/add-client.png[] -. After clicking the `Save` button your client application entry will be created. You now have to go back to the {{book.appServer}} +. After clicking the `Save` button your client application entry will be created. You now have to go back to the {{book.appserver.name}} instance that the application is deployed on and configure it so that this app is secured by {{book.project.name}}. You can obtain a template for the configuration you need by going to the `Installation` tab in the client entry in the {{book.project.name}} Admin Console. + diff --git a/getting_started/topics/secure-jboss-app/download-quickstarts.adoc b/getting_started/topics/secure-jboss-app/download-quickstarts.adoc index 316d29ed0d..5173b96a43 100644 --- a/getting_started/topics/secure-jboss-app/download-quickstarts.adoc +++ b/getting_started/topics/secure-jboss-app/download-quickstarts.adoc @@ -9,7 +9,7 @@ installed on your machine and available in your PATH before you can continue: * Git You can obtain the code by cloning the repository at {{book.quickstartRepo}}. Use the branch matching the version of Red Hat Single Sign-On in use. Follow these steps to download the code, build it, -and deploy it. Make sure your {{book.appServer}} application server is started before you run these steps. +and deploy it. Make sure your {{book.appserver.name}} application server is started before you run these steps. .Clone Project [source, subs="attributes"] diff --git a/getting_started/topics/secure-jboss-app/install-client-adapter.adoc b/getting_started/topics/secure-jboss-app/install-client-adapter.adoc index 23e92a577e..f1cc1b05c1 100644 --- a/getting_started/topics/secure-jboss-app/install-client-adapter.adoc +++ b/getting_started/topics/secure-jboss-app/install-client-adapter.adoc @@ -1,7 +1,7 @@ === Installing the Client Adapter -Download the {{book.appServer}} distribution and unzip +Download the {{book.appserver.name}} distribution and unzip it into a directory on your machine. {% if book.community %} @@ -12,7 +12,7 @@ Next download the keycloak-wildfly-adapter-dist-{{book.project.version}}.zip dis Next download the RH-SSO-{{book.project.version}}-eap7-adapter.zip distribution. {% endif %} -Unzip this file into the root directory of your {{book.appServer}} distribution. +Unzip this file into the root directory of your {{book.appserver.name}} distribution. Next perform the following actions: