diff --git a/docbook/reference/en/en-US/modules/server-installation.xml b/docbook/reference/en/en-US/modules/server-installation.xml index 0c419b7101..6d6061a24b 100755 --- a/docbook/reference/en/en-US/modules/server-installation.xml +++ b/docbook/reference/en/en-US/modules/server-installation.xml @@ -1,95 +1,130 @@ Installation and Configuration of Keycloak Server - - The Keycloak Server has two downloadable distributions. - - - - - - keycloak-&project.version;.zip - - - - keycloak-overlay-&project.version;.zip - - - - - -
- Server Install +
+ Installation - The - keycloak-&project.version;.zip - is quite large, but contains a complete server (backed by Wildfly) - that runs out of the box. The only thing you'll have to enable and configure is SSL. Unzipping it, the - directory layout looks - something like this: - - - - -keycloak-&project.version;/ - bin/ - standalone.sh - standalone.bat - standalone/configuration/ - keycloak-server.json - themes/ - docs/ - + Keycloak Server has three downloadable distributions. - The - standalone.sh - or - standalone.bat - script is used to start the server. - After executing that, log into the admin console at - http://localhost:8080/auth/admin/index.html. - Username: admin - Password: admin. Keycloak will then prompt you to - enter in a new password. - -
-
- Server Overlay Installation - - The - keycloak-overlay-&project.version;.zip - contains - just the bits you need to install keycloak on an existing WildFly 8.2.0.Final installation. - - - The directory structure of this distro looks like this: - - - - standalone/ - configuration/ - keycloak-server.json - themes/ - providers/ - modules - docs/ - - - - Unzip this archive into the root of your WildFly installation. - - - After booting up the Wildfly distro, you can then make sure it is installed properly - by logging into the admin console at - http://localhost:8080/auth/admin/index.html. - Username: admin - Password: admin. Keycloak will then prompt you to - enter in a new password. + + + keycloak-&project.version;.[zip|tar.gz] - Standalone server + + + keycloak-overlay-&project.version;.[zip|tar.gz] - Installer for WildFly or JBoss EAP + + + keycloak-demo-&project.version;.[zip|tar.gz] - Development bundle including WildFly, Keycloak, examples and documentation + + +
+ Install Standalone Server + + For production and for non-JavaEE developers we recommend using the standalone Keycloak server. All you need to + do is to download keycloak-&project.version;.zip or keycloak-&project.version;.tar.gz, + unpackage and start to have a Keycloak server up and running. + + + + To install first download either the zip or tar.gz and extract. Then start by running either: + keycloak-&project.version;/bin/standalone.sh + or: + keycloak-&project.version;/bin/standalone.bat + + + Once the server is started log into the admin console at + http://localhost:8080/auth/admin/index.html + (username: admin and password: admin). Keycloak will then prompt you to + enter in a new password. + +
+ + +
+ Install on existing WildFly 8.2.0.Final + + Keycloak can be installed into an existing WildFly 8.2.0.Final server. To do this download + keycloak-overlay-&project.version;.zip or keycloak-overlay-&project.version;.tar.gz. + Once downloaded extract into the root directory of your WildFly installation. To start WildFly with Keycloak + run: + keycloak-&project.version;/bin/standalone.sh --server-config=standalone-keycloak.xml + or: + keycloak-&project.version;/bin/standalone.bat --server-config=standalone-keycloak.xml + + + Once the server is started log into the admin console at + http://localhost:8080/auth/admin/index.html + (username: admin and password: admin). Keycloak will then prompt you to + enter in a new password. + + + To add Keycloak to other sever configurations (standalone.xml, standalone-ha.xml, etc.) open + standalone/configuration/standalone-keycloak.xml and the configuration you want to add it + to, for example standalone/configuration/standalone.xml. From standalone-keycloak.xml + you need to copy 3 elements: + + <extension module="org.keycloak.keycloak-subsystem"/> + <datasource jndi-name="java:jboss/datasources/KeycloakDS" ...> + <subsystem xmlns="urn:jboss:domain:security:1.2" ...> + + +
+
+ Install on existing EAP 6.4.0.GA + + Keycloak can be installed into an existing EAP 6.4.0.GA server. To do this download + keycloak-overlay-&project.version;.zip or keycloak-overlay-&project.version;.tar.gz. + Once downloaded extract into the root directory of your EAP installation. + + + To add Keycloak to the a EAP sever configurations (standalone.xml, standalone-ha.xml, etc.) open + standalone/configuration/standalone-keycloak.xml and the configuration you want to add it + to, for example standalone/configuration/standalone.xml. From standalone-keycloak.xml + you need to copy 3 elements: + + <extension module="org.keycloak.keycloak-subsystem"/> + <datasource jndi-name="java:jboss/datasources/KeycloakDS" ...> + <subsystem xmlns="urn:jboss:domain:security:1.2" ...> + + + standalone-keycloak.xml is aimed at WildFly and won't work with EAP so you need to + copy the required configuration + + + + Once the server is started log into the admin console at + http://localhost:8080/auth/admin/index.html + (username: admin and password: admin). Keycloak will then prompt you to + enter in a new password. + +
+
+ Install Development Bundle + + The demo bundle contains everything you need to get started with Keycloak including documentation and examples. + To install it first download keycloak-demo-&project.version;.zip or + keycloak-demo-&project.version;.tar.gz. Once downloaded extract it inside + keycloak-demo-&project.version; you'll find keycloak which contains + a full WildFly 8.2.0.Final server with Keycloak Server and Adapters included. You'll also find docs + and examples which contains everything you need to get started developing applications that use Keycloak. + + + To start WildFly with Keycloak run: + keycloak-&project.version;/bin/standalone.sh + or: + keycloak-&project.version;/bin/standalone.bat + + + Once the server is started log into the admin console at + http://localhost:8080/auth/admin/index.html + (username: admin and password: admin). Keycloak will then prompt you to + enter in a new password. + +
+
Configuring the Server