Updating getting started guide for Dist.X

Closes keycloak#286

README.md

@@ -8,6 +8,7 @@ that can be used as a reference for your own project.
 ## Help and Documentation
 
 * [Documentation](https://www.keycloak.org/documentation.html)
+* [Server Guides](https://www.keycloak.org/guides#server)
 * [User Mailing List](https://lists.jboss.org/mailman/listinfo/keycloak-user) - Mailing list for help and general questions about Keycloak
 
 ## Reporting Security Vulnerabilities

app-angular2/README.md

@@ -33,7 +33,8 @@ the the following command will install TypeScript:
 ````
 npm install -g typescript
 ````
-To build and run this project as a WAR you will need Java 8.0 (Java SDK 1.8) or later and Maven 3.3.3 or later.
+
+See the [Getting Started Guide](../docs/getting-started.md) for the minimum requirements and steps to build and run the quickstart.
 
 
 Configuration in <span>Keycloak</span>

app-authz-jee-servlet/README.md

@@ -31,9 +31,7 @@ You'll also learn how to use the `AuthorizationContext` object to obtain permiss
 System Requirements
 -------------------
 
-If you are deploying the application as a WAR you need to have <span>WildFly 10</span> running.
-
-All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.3 or later.
+See the [Getting Started Guide](../docs/getting-started.md) for the minimum requirements and steps to build and run the quickstart.
 
 Configure the Client Adapter
 ----------------------------------

app-authz-jee-vanilla/README.md

@@ -21,9 +21,7 @@ You'll also learn how to use the `AuthorizationContext` object to obtain permiss
 System Requirements
 -------------------
 
-If you are deploying the application as a WAR you need to have <span>WildFly 10</span> running.
-
-All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.3 or later.
+See the [Getting Started Guide](../docs/getting-started.md) for the minimum requirements and steps to build and run the quickstart.
 
 Configure the Client Adapter
 ----------------------------------

app-authz-photoz/README.md

@@ -69,6 +69,11 @@ regular access tokens instead of RPTs. The `photoz-html5-client` application doe
 obtain RPTs from the Keycloak server but just use the access token obtained during the authentication as a bearer token
 when accessing protected resources.
 
+System Requirements
+-------------------
+
+See the [Getting Started Guide](../docs/getting-started.md) for the minimum requirements and steps to build and run the quickstart.
+
 Create the Example Realm and a Resource Server
 -----------
 

app-authz-photoz/photoz-testsuite/src/test/resources/arquillian.xml

@@ -37,7 +37,7 @@
                 <property name="jbossHome">${basedir}/target/wildfly-${version.wildfly}</property>
             </configuration>
         </container>
-    
+
         <container qualifier="keycloak">
             <configuration>
                 <property name="managementAddress">127.0.0.1</property>

app-authz-springboot-multitenancy/README.md

@@ -48,7 +48,7 @@ Based on these initial settings, you should be able to not only support authenti
 System Requirements
 -------------------
 
-All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.1.1 or later.
+See the [Getting Started Guide](../docs/getting-started.md) for the minimum requirements and steps to build and run the quickstart.
 
 
 Configuration in <span>Keycloak</span>

app-authz-springboot/README.md

@@ -41,7 +41,7 @@ You can use two distinct users to access this application:
 System Requirements
 -------------------
 
-All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.3 or later.
+See the [Getting Started Guide](../docs/getting-started.md) for the minimum requirements and steps to build and run the quickstart.
 
 
 Configuration in <span>Keycloak</span>

app-authz-uma-photoz/photoz-testsuite/src/test/resources/arquillian.xml

@@ -37,7 +37,7 @@
                 <property name="jbossHome">${basedir}/target/wildfly-${version.wildfly}</property>
             </configuration>
         </container>
-    
+
         <container qualifier="keycloak">
             <configuration>
                 <property name="managementAddress">127.0.0.1</property>

app-jee-html5/README.md

@@ -24,9 +24,7 @@ The quickstart requires that you have the [example services](../service-jee-jaxr
 services are located at `http://localhost:8080/service`. If the services are running elsewhere you need to edit
 `app.js` and replace the value of `serviceUrl`.
 
-If you are deploying the application as a WAR you need to have <span>WildFly 10</span> running.
-
-All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.3 or later.
+See the [Getting Started Guide](../docs/getting-started.md) for the minimum requirements and steps to build and run the quickstart.
 
 
 Configuration in <span>Keycloak</span>

app-jee-jsp/README.md

@@ -22,9 +22,7 @@ The quickstart requires that you have the [example services](../service-jee-jaxr
 services are located on the same host as the application. If the service is running elsewhere you need to set the URL
 of the service as an environment variable (SERVICE_URL) and restart <span>WildFly</span>.
 
-If you are deploying the application as a WAR you need to have <span>WildFly 10</span> running.
-
-All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.3 or later.
+See the [Getting Started Guide](../docs/getting-started.md) for the minimum requirements and steps to build and run the quickstart.
 
 
 Configuration in <span>Keycloak</span>

app-profile-jee-html5/README.md

@@ -22,10 +22,7 @@ As the example only contains static html pages the files in `src/main/webapp` ca
 System Requirements
 -------------------
 
-If you are deploying the application as a WAR you need to have <span>WildFly 10</span> running.
-
-All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.3 or later.
-
+See the [Getting Started Guide](../docs/getting-started.md) for the minimum requirements and steps to build and run the quickstart.
 
 Configuration in <span>Keycloak</span>
 -----------------------

app-profile-jee-jsp/README.md

@@ -19,10 +19,7 @@ display the token retrieved from <span>Keycloak</span>.
 System Requirements
 ------------
 
-If you are deploying the application as a WAR you need to have <span>WildFly 10</span> running.
-
-All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.3 or later.
-
+See the [Getting Started Guide](../docs/getting-started.md) for the minimum requirements and steps to build and run the quickstart.
 
 Configuration in <span>Keycloak</span>
 -----------------------

app-profile-jee-vanilla/README.md

@@ -19,10 +19,7 @@ configuration is done automatically by the <span>Keycloak</span> client adapter
 System Requirements
 -------------------
 
-If you are deploying the application as a WAR you need to have <span>WildFly 10</span> running.
-
-All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.3 or later.
-
+See the [Getting Started Guide](../docs/getting-started.md) for the minimum requirements and steps to build and run the quickstart.
 
 Build and Deploy the Quickstart
 -------------------------------

app-profile-saml-jee-jsp/README.md

@@ -18,10 +18,7 @@ authenticates using <span>Keycloak</span> over the SAML protocol. Once authentic
 System Requirements
 -------------------
 
-If you are deploying the application as a WAR you need to have <span>WildFly 10</span> running.
-
-All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.3 or later.
-
+See the [Getting Started Guide](../docs/getting-started.md) for the minimum requirements and steps to build and run the quickstart.
 
 Configuration in <span>Keycloak</span>
 -----------------------

app-springboot/README.md

@@ -28,7 +28,7 @@ The quickstart requires that you have the [SpringBoot Service](../service-spring
 services are located at `http://localhost:8081/products`. If the services are running elsewhere you need to edit
 `resources/application.properties` and replace the value of `product.service.url`.
 
-All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.3 or later.
+See the [Getting Started Guide](../docs/getting-started.md) for the minimum requirements and steps to build and run the quickstart.
 
 
 Configuration in <span>Keycloak</span>

docs/getting-started-legacy.md

@@ -0,0 +1,170 @@
+# Getting started
+
+These quickstarts run on <span>WildFly 10</span>.
+
+Prior to running the quickstarts you should read this entire document and have completed the following steps:
+
+* [Start and configure the <span>Keycloak</span> Server](#keycloak)
+* [Start and configure the <span>WildFly</span> Server](#wildfly)
+
+Afterwards you should read the README file for the quickstart you would like to deploy. See [examples](#examples) for
+a list of the available quickstarts.
+
+If you run into any problems please refer to the [troubleshooting](#troubleshooting) section.
+
+
+## Use of <span>KEYCLOAK_HOME</span> and <span>WILDFLY_HOME</span> Variables
+
+The quickstart README files use the replaceable value <span>KEYCLOAK_HOME</span> to denote the path to the <span>Keycloak</span> installation and the
+value <span>WILDFLY_HOME</span> to denote the path to the <span>WildFly</span> installation. When you encounter this value in a README file, be sure
+to replace it with the actual path to your installations.
+
+
+## System Requirements
+
+The applications these projects produce are designed to be run on <span>WildFly</span> Application Server 10.
+
+All you need to build these projects is Java 8.0 (Java SDK 1.8) or later and Maven 3.1.1 or later.
+
+
+## <a id="keycloak"></a>Start the <span>Keycloak</span> Server
+
+By default the <span>Keycloak</span> Server uses the same ports as the <span>WildFly</span> Server. To run the quickstarts you can either run the
+<span>Keycloak</span> Server on a separate host (machine, VM, Docker, etc..) or on different ports.
+
+To start the <span>Keycloak</span> server on a separate host:
+
+1. Open a terminal on the separate machine and navigate to the root of the <span>Keycloak</span> server directory.
+
+2. The following shows the command to start the <span>Keycloak</span> server:
+
+   ````
+   For Linux:   KEYCLOAK_HOME/bin/standalone.sh -b 0.0.0.0
+   For Windows: KEYCLOAK_HOME\bin\standalone.bat -b 0.0.0.0
+   ````
+
+3. The URL of the <span>Keycloak</span> server will be http://&lt;HOSTNAME&gt;:8080 (replace &lt;HOSTNAME&gt; with the hostname of the separate host).
+
+To start the <span>Keycloak</span> server on different ports:
+
+1. Open a terminal and navigate to the root of the <span>Keycloak</span> server directory.
+
+2. The following shows the command to start the <span>Keycloak</span> server:
+
+   ````
+   For Linux:   KEYCLOAK_HOME/bin/standalone.sh -Djboss.socket.binding.port-offset=100
+   For Windows: KEYCLOAK_HOME\bin\standalone.bat -Djboss.socket.binding.port-offset=100
+   ````
+
+3. The URL of the <span>Keycloak</span> server will be http://localhost:8180
+
+## <a id="add-admin"></a>Add Admin User
+
+Open the main page for the <span>Keycloak</span> server ([localhost:8180](http://localhost:8180) or http://&lt;HOSTNAME&gt;:8080). If
+this is a new installation of <span>Keycloak</span> server you will be instructed to create an initial admin user. To continue with
+the quickstarts you need to do this prior to continuing.
+
+## <a id="add-roles-user"></a>Create Roles and User
+
+To be able to use the examples you need to create some roles as well as at least one sample user. To do first this open
+the <span>Keycloak</span> admin console ([localhost:8180/auth/admin](http://localhost:8180/auth/admin) or http://&lt;HOSTNAME&gt;:8080/auth/admin) and
+login with the admin user you created in the [add admin user](#add-admin) section.
+
+Start by creating a user role:
+
+* Select `Roles` from the menu
+* Click `Add Role`
+* Enter `user` as `Role Name`
+* Click `Save`
+
+Next create a user:
+
+* Select `Users` from the menu
+* Click `Add user`
+* Enter any values you want for the user
+* Click `Save`
+* Select `Credentials` from the tabs
+* Enter a password in `New Password` and `Password Confirmation`
+* Click on the toggle to disable `Temporary`
+* Click `Reset Password`
+* Click `Role Mappings`
+* Select `user` under `Available Roles` and click `Add selected`
+
+As an alternative to manually creating the role and user you can use the partial import feature in the admin console and import
+the file [config/partial-import.json](../config/partial-import.json) into your realm.
+
+One more step, if you want to access the examples with the admin user you need to add the `user` role to admin user:
+
+* Select `Users` from the menu
+* Click `View all users`
+* Click `Edit` for admin user
+* Click `Role Mappings`
+* Select `user` under `Available Roles` and click `Add selected`
+
+## <a id="wildfly"></a>Start and Configure the <span>WildFly</span> Server
+
+Before starting the <span>WildFly</span> Server start by extracting the <span>Keycloak</span> client adapter into it.
+
+For <span>WildFly 10</span> extract `keycloak-wildfly-adapter-${project.version}.zip` into <span>WILDFLY_HOME</span>.
+
+If you plan to try the SAML examples you also need the SAML <span>WildFly</span> adapter. To do this for <span>WildFly 10</span>
+`keycloak-saml-wildfly-adapter-dist-${project.version}.zip` into <span>WILDFLY_HOME</span>.
+
+The next step is to start <span>WildFly</span> server:
+
+1. Open a terminal and navigate to the root of the <span>WildFly</span> server directory.
+2. Use the following command to start the <span>WildFly</span> server:
+   ````
+   For Linux:   WILDFLY_HOME/bin/standalone.sh
+   For Windows: WILDFLY_HOME\bin\standalone.bat
+   ````
+3. To install the <span>Keycloak</span> adapter run the following commands:
+   ````
+   For Linux:
+
+     WILDFLY_HOME/bin/jboss-cli.sh -c --file=WILDFLY_HOME/bin/adapter-install.cli
+     WILDFLY_HOME/bin/jboss-cli.sh -c --command=:reload
+
+   For Windows:
+
+    WILDFLY_HOME\bin\jboss-cli.bat -c --file=WILDFLY_HOME\bin\adapter-install.cli
+    WILDFLY_HOME\bin\jboss-cli.bat -c --command=:reload
+   ````
+4. If you plan to try the SAML examples you also need to install <span>Keycloak</span> SAML adapter:
+
+   ````
+   For Linux:
+
+     WILDFLY_HOME/bin/jboss-cli.sh -c --file=WILDFLY_HOME/bin/adapter-install-saml.cli
+     WILDFLY_HOME/bin/jboss-cli.sh -c --command=:reload
+
+   For Windows:
+
+     WILDFLY_HOME\bin\jboss-cli.bat -c --file=WILDFLY_HOME\bin\adapter-install-saml.cli
+     WILDFLY_HOME\bin\jboss-cli.bat -c --command=:reload
+   ````
+
+# Examples
+
+* [app-angular2](../app-angular2/README.md) - Angular 2 application that invokes the example service. Requires service example to be deployed.
+* [app-authz-rest-employee](../app-authz-rest-employee/README.md) - SpringBoot REST Service Protected Using Keycloak Authorization Services
+* [app-jee-html5](../app-jee-html5/README.md) - HTML5 application that invokes the example service. Requires service example to be deployed.
+* [app-jee-jsp](../app-jee-jsp/README.md) - JSP application packaged that invokes the example service. Requires service example to be deployed.
+* [app-profile-jee-html5](../app-profile-jee-html5/README.md) - HTML5 application that displays user profile and token details.
+* [app-profile-jee-jsp](../app-profile-jee-jsp/README.md) - JSP application that displays user profile and token details.
+* [app-profile-jee-vanilla](../app-profile-jee-vanilla/README.md) - JSP application configured with basic authentication. Shows how to secure an application with the client adapter subsystem.
+* [app-profile-saml-jee-jsp](../app-profile-saml-jee-jsp/README.md) - JSP application that uses SAML and displays user profile.
+* [app-springboot](../app-springboot/README.md) - SpringBoot application that is secured with Keycloak. [Requires SpringBoot Service](../service-springboot-rest/README.md).
+* [service-jee-jaxrs](../service-jee-jaxrs/README.md) - JAX-RS Service with public and protected endpoints.
+
+
+# Troubleshooting
+
+| Problem | Probable Cause | Possible Solution |
+|---------|----------------|-------------------|
+| Some required files are missing / Some Enforcer rules have failed | Client adapter config is missing | Add client adapter installation file to `config` directory as specified in quickstart README.md |
+| Unknown authentication mechanism KEYCLOAK | OpenID Connect client adapter missing | Install OpenID Connect adapter as specified in the [Start and Configure the WildFly Server](#wildfly) section |
+| Unknown authentication mechanism KEYCLOAK-SAML | SAML client adapter missing | Install SAML adapter as specified in the [Start and Configure the WildFly Server](#wildfly) section |
+| Failed to invoke service: 404 Not Found | Service not deployed, or service URL not correct | Deploy service or change the URL for the service as specified in the quickstart README
+| Failed to invoke service: Request failed message with no error code | CORS not enabled | Most likely cause is that you've deployed the HTML5 application to a different host than the service, if so the solution is to add CORS support to the service. See the README for the service for how to enable. |
+| Page displays: Forbidden | Authenticated user is missing a role required to access the url | This can happen if you fail to add `user` role to admin user as instructed in [Create Roles and User](#add-roles-user). |