diff --git a/docbook/reference/en/en-US/modules/server-installation.xml b/docbook/reference/en/en-US/modules/server-installation.xml
index 223c3303d8..5b4b043fe9 100755
--- a/docbook/reference/en/en-US/modules/server-installation.xml
+++ b/docbook/reference/en/en-US/modules/server-installation.xml
@@ -8,21 +8,21 @@
- keycloak-appliance-dist-all-&project.version;.zip
+ keycloak-&project.version;.zip
- keycloak-war-dist-all-&project.version;.zip
+ keycloak-overlay-&project.version;.zip
-
- Appliance Install
+
+ Server Install
The
- keycloak-appliance-dist-all-&project.version;.zip
+ 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
@@ -31,15 +31,13 @@
-keycloak-appliance-dist-all-&project.version;/
- keycloak/
- bin/
- standalone.sh
- standalone.bat
- standalone/configuration/
- keycloak-server.json
- themes/
- examples/
+keycloak-&project.version;/
+ bin/
+ standalone.sh
+ standalone.bat
+ standalone/configuration/
+ keycloak-server.json
+ themes/
docs/
@@ -58,51 +56,32 @@ keycloak-appliance-dist-all-&project.version;/
- WAR Distribution Installation
+ Server Overlay Installation
The
- keycloak-war-dist-all-&project.version;.zip
+ keycloak-overlay-&project.version;.zip
contains
- just the bits you need to install keycloak on your favorite web container. We currently only support
- installing it on top of an existing Wildfly 8 or JBoss EAP 6.x distribution. We may in the
- future provide directions on how to install it on another web container like Tomcat or Jetty. If anybody
- in the community is interested in pulling this together, please contact us. Its mostly Maven pom work.
+ 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:
-keycloak-war-dist-all-&project.version;/
- deployments/
- auth-server.war/
- keycloak-ds.xml
- configuration/
- keycloak-server.json
- themes/
- examples/
+ standalone/
+ configuration/
+ keycloak-server.json
+ themes/
+ providers/
+ modules
docs/
- After unzipping this file, copy everything in deployments directory into the
- standalone/deployments of your JBoss or Wildfly distro. Also, copy everything in
- configuration directory into the standalone/configuration directory.
+ Unzip this archive into the root of your WildFly installation.
-
- $ cd keycloak-war-dist-all-&project.version;
- $ cp -r deployments $JBOSS_HOME/standalone/deployments
- $ cp -r configuration $JBOSS_HOME/standalone/configuration
-
-
-
- After these steps you MUST then download and install the client adapter
- as this may contain modules the server needs (like Bouncycastle). You will also need to install the adapter
- to run the examples on the same server.
-
-
- After booting up the JBoss or Wildfly distro, you can then make sure it is installed properly
+ 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.
@@ -110,9 +89,6 @@ keycloak-war-dist-all-&project.version;/
Password: admin. Keycloak will then prompt you to
enter in a new password.
-
- You can no longer run Keycloak on JBoss AS 7.1.1. You must run on EAP 6.x or Wildfly.
- Configuring the Server
@@ -137,56 +113,12 @@ keycloak-war-dist-all-&project.version;/
Relational Database Configuration
- By default, Keycloak uses a relational database to store Keycloak data. This datasource is the standalone/deployments/keycloak-ds.xml
- file of your Keycloak Server installation if you used or in standalone/configuration/standalone.xml
- if you used . File keycloak-ds.xml is used in WAR
- distribution, so that you have datasource available out of the box and you don't need to edit standalone.xml file.
- However a good thing is to always delete the file keycloak-ds.xml and move its configuration text
- into the centrally managed standalone.xml file.
- This will allow you to manage the database connection pool from the Wildfly/JBoss administration console. Here's what
- standalone/configuration/standalone.xml should look like after you've done this:
+ You might want to use a better relational database for Keycloak like PostgreSQL or MySQL. You might also
+ want to tweak the configuration settings of the datasource. Please see the Wildfly
+ documentation on how to do this.
-
-
-
- jdbc:h2:mem:test;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE
- h2
-
- sa
- sa
-
-
-
- jdbc:h2:${jboss.server.data.dir}/keycloak;AUTO_SERVER=TRUE
- h2
-
- sa
- sa
-
-
-
-
- org.h2.jdbcx.JdbcDataSource
-
-
-
-
-]]>
-
-
-
- Besides moving the database config into the central standalone.xml configuration file
- you might want to use a better relational database for Keycloak like PostgreSQL or MySQL. You might also
- want to tweak the configuration settings of the datasource. Please see the Wildfly,
- JBoss AS7,
- or JBoss EAP 6.x documentation on how to do this.
-
-
- Keycloak also runs on a Hibernate/JPA backend which is configured in the
+ Keycloak runs on a Hibernate/JPA backend which is configured in the
standalone/configuration/keycloak-server.json.
By default the setting is like this:
-
- EAP6.x Logging
-
- Accessing the admin console will get these annoying log messages:
-
-
- WARN [org.jboss.resteasy.core.ResourceLocator] (http-/127.0.0.1:8080-3)
- Field providers of subresource xxx will not be injected according to spec
-
-
-
-
- These can be ignored by editing standalone.xml of your jboss installation:
-
-
-
-
-
-]]>
-
-
-
SSL/HTTPS Requirement/Modes
@@ -553,7 +462,7 @@ All configuration options are optional. Default value for directory is
- Enable JBoss or Wildfly to use this certificate and turn on SSL/HTTPS.
+ Enable Wildfly to use this certificate and turn on SSL/HTTPS.
@@ -674,29 +583,6 @@ All configuration options are optional. Default value for directory is
Check the Wildfly Undertow documentation for more information on fine tuning the socket connections.
-
- Installing the keystore to JBoss EAP6
-
- Now that you have a Java keystore with the appropriate certificates, you need to configure your
- JBoss EAP6 installation to use it. First step is to move the keystore file to a directory
- you can reference in configuration. I like to put it in standalone/configuration.
- Then you need to edit standalone/configuration/standalone.xml to enable SSL/HTTPS.
-
-
-
-
-
-
-
- ...
-]]>
-
-
- Check the JBoss documentation for more information on fine tuning the socket connections.
-
-
@@ -710,7 +596,7 @@ All configuration options are optional. Default value for directory is
- WildFly
+ Configure WildFly
Open standalone/configuration/standalone.xml in your favorite editor.
@@ -742,39 +628,6 @@ All configuration options are optional. Default value for directory is
Check the WildFly documentation for more information.
-
-
- EAP
-
-
- Open standalone/configuration/standalone.xml in your favorite editor.
-
-
-
- You need to add redirect-port to http connector element and
- add the RemoteIpValve valve:
-
-
-
-
-
-
-
-
-
-
-]]>
-
-
-
-
-
-