From e64a2d8de575d2e6c3b00e3292bdad1ea2151523 Mon Sep 17 00:00:00 2001 From: Stian Thorgersen Date: Thu, 23 Apr 2015 14:19:27 +0200 Subject: [PATCH 1/5] Fixes --- distribution/server-overlay/assembly.xml | 2 +- pom.xml | 41 ++++++++++++-------- services/pom.xml | 49 ++++++++++-------------- 3 files changed, 46 insertions(+), 46 deletions(-) diff --git a/distribution/server-overlay/assembly.xml b/distribution/server-overlay/assembly.xml index 88d8fe9d3f..a85813a2b4 100755 --- a/distribution/server-overlay/assembly.xml +++ b/distribution/server-overlay/assembly.xml @@ -57,7 +57,7 @@ docs/javadocs - ../../services/target/site/apidocs + ../../services/target/apidocs docs/rest-api diff --git a/pom.xml b/pom.xml index 8bf033d326..c0985079f3 100755 --- a/pom.xml +++ b/pom.xml @@ -1042,22 +1042,6 @@ - - - - org.apache.maven.plugins - maven-javadoc-plugin - - 128m - 1024m - false - true - - se.unlogic.*:com.restfully.*:org.jboss.resteasy.examples.*:org.jboss.resteasy.tests.* - - - - @@ -1067,6 +1051,31 @@ docbook distribution + + + + org.apache.maven.plugins + maven-javadoc-plugin + + + aggregate + package + + aggregate + + + 128m + 1024m + true + + se.unlogic.*:com.restfully.*:org.jboss.resteasy.examples.*:org.jboss.resteasy.tests.* + + + + + + + diff --git a/services/pom.xml b/services/pom.xml index bc5762f535..2fa148d848 100755 --- a/services/pom.xml +++ b/services/pom.xml @@ -183,35 +183,26 @@ org.apache.maven.plugins maven-javadoc-plugin - - - generate-service-docs - generate-resources - - org.keycloak.services.resources.admin:org.keycloak.protocol.oidc - com.lunatech.doclets.jax.jaxrs.JAXRSDoclet - - - com.lunatech.jax-doclets - doclets - 0.10.2 - - - false - - - ../javadocs - ${project.basedir}/../target/site/apidocs - - - -disablejavascriptexample - -pathexcludefilter '/admin/.*index.*' -pathexcludefilter '/admin' -pathexcludefilter '/admin/\\{realm\\}/console.*' - - - javadoc - - - + + org.keycloak.services.resources.admin:org.keycloak.protocol.oidc + com.lunatech.doclets.jax.jaxrs.JAXRSDoclet + + + com.lunatech.jax-doclets + doclets + 0.10.2 + + + false + + + ../javadocs + ${project.basedir}/../target/site/apidocs + + + -disablejavascriptexample + -pathexcludefilter '/admin/.*index.*' -pathexcludefilter '/admin' -pathexcludefilter '/admin/\\{realm\\}/console.*' + From 927032997ed4de9ad9f4670453f72027153a2faa Mon Sep 17 00:00:00 2001 From: Stian Thorgersen Date: Thu, 23 Apr 2015 14:20:33 +0200 Subject: [PATCH 2/5] Updated release instructions --- misc/ReleaseProcess.md | 16 +++------------- 1 file changed, 3 insertions(+), 13 deletions(-) diff --git a/misc/ReleaseProcess.md b/misc/ReleaseProcess.md index 08fd1b6db4..6cf5c9d941 100644 --- a/misc/ReleaseProcess.md +++ b/misc/ReleaseProcess.md @@ -14,22 +14,12 @@ $ git@github.com:keycloak/keycloak.git * Build everything to make sure its kosher. ``` $ cd keycloak -$ mvn install -``` - -* Build javadoc and jaxrs-doc -``` -$ mvn javadoc:javadoc -# This is for jaxrs-docs -$ cd services -$ mvn package -# back to root keycloak dir -$ cd .. +$ mvn -Pjboss-release install ``` * Upload to Nexus (from project root) ``` -$ mvn -Pdistribution deploy +$ mvn -Pjboss-release deploy ``` * Login to Nexus and release the maven repository uploads in the staging area. @@ -77,4 +67,4 @@ Releases are automatically synced to Maven central, but this can take up to one ## Announce * Update Magnolia site to link keycloak docs and announcements. -* Write a blog and email about release including links to download, migration guide, docs, and blurb about what's new \ No newline at end of file +* Write a blog and email about release including links to download, migration guide, docs, and blurb about what's new From 37243d058ccf2de94034e119ad4dbc1e0c914ccf Mon Sep 17 00:00:00 2001 From: Stian Thorgersen Date: Thu, 23 Apr 2015 15:00:22 +0200 Subject: [PATCH 3/5] Fixes --- .../modules/org/keycloak/keycloak-saml-protocol/main/module.xml | 1 - .../modules/org/keycloak/keycloak-services/main/module.xml | 1 - distribution/server-overlay/pom.xml | 2 +- .../src/main/webapp/WEB-INF/jboss-deployment-structure.xml | 1 + 4 files changed, 2 insertions(+), 3 deletions(-) diff --git a/distribution/modules/src/main/resources/modules/org/keycloak/keycloak-saml-protocol/main/module.xml b/distribution/modules/src/main/resources/modules/org/keycloak/keycloak-saml-protocol/main/module.xml index 687cb6b4c2..45a63fa612 100755 --- a/distribution/modules/src/main/resources/modules/org/keycloak/keycloak-saml-protocol/main/module.xml +++ b/distribution/modules/src/main/resources/modules/org/keycloak/keycloak-saml-protocol/main/module.xml @@ -20,7 +20,6 @@ - diff --git a/distribution/modules/src/main/resources/modules/org/keycloak/keycloak-services/main/module.xml b/distribution/modules/src/main/resources/modules/org/keycloak/keycloak-services/main/module.xml index 9864a070c1..e6fe0ba310 100755 --- a/distribution/modules/src/main/resources/modules/org/keycloak/keycloak-services/main/module.xml +++ b/distribution/modules/src/main/resources/modules/org/keycloak/keycloak-services/main/module.xml @@ -65,7 +65,6 @@ - diff --git a/distribution/server-overlay/pom.xml b/distribution/server-overlay/pom.xml index 68a38a137c..a4ef9a04bc 100755 --- a/distribution/server-overlay/pom.xml +++ b/distribution/server-overlay/pom.xml @@ -27,7 +27,7 @@ - keycloak-${project.version} + keycloak-overlay-${project.version} org.apache.maven.plugins diff --git a/distribution/subsystem-war/src/main/webapp/WEB-INF/jboss-deployment-structure.xml b/distribution/subsystem-war/src/main/webapp/WEB-INF/jboss-deployment-structure.xml index f44d7d67a0..44ecae0c2f 100755 --- a/distribution/subsystem-war/src/main/webapp/WEB-INF/jboss-deployment-structure.xml +++ b/distribution/subsystem-war/src/main/webapp/WEB-INF/jboss-deployment-structure.xml @@ -55,6 +55,7 @@ + From f74e1463dff80c48f706a5bfc8e062cac26622e9 Mon Sep 17 00:00:00 2001 From: Stian Thorgersen Date: Thu, 23 Apr 2015 15:30:15 +0200 Subject: [PATCH 4/5] Updated docs for server dist changes --- .../en/en-US/modules/server-installation.xml | 205 +++--------------- 1 file changed, 29 insertions(+), 176 deletions(-) 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: - - - - - - - - - - -]]> - - - - -
-
From 35b6c88500533b95a5ec0ef0c7a281ce1356b7ce Mon Sep 17 00:00:00 2001 From: Stian Thorgersen Date: Thu, 23 Apr 2015 15:44:29 +0200 Subject: [PATCH 5/5] Don't replace welcome-content in server-overlay --- distribution/server-dist/assembly.xml | 7 ++ .../server-dist/src/main/providers/README.txt | 2 - .../server-dist/src/main/themes/README.txt | 3 - .../server-dist/src/main/xslt/standalone.xsl | 89 ------------------- distribution/server-overlay/assembly.xml | 15 ---- .../src/main/welcome-content/index.html | 32 ------- 6 files changed, 7 insertions(+), 141 deletions(-) delete mode 100644 distribution/server-dist/src/main/providers/README.txt delete mode 100644 distribution/server-dist/src/main/themes/README.txt delete mode 100755 distribution/server-dist/src/main/xslt/standalone.xsl delete mode 100644 distribution/server-overlay/src/main/welcome-content/index.html diff --git a/distribution/server-dist/assembly.xml b/distribution/server-dist/assembly.xml index 03adcc2ab2..8cbea2dc7b 100755 --- a/distribution/server-dist/assembly.xml +++ b/distribution/server-dist/assembly.xml @@ -26,6 +26,13 @@ 0755 + + src/main/welcome-content + welcome-content + + *.* + + diff --git a/distribution/server-dist/src/main/providers/README.txt b/distribution/server-dist/src/main/providers/README.txt deleted file mode 100644 index a6d523b43f..0000000000 --- a/distribution/server-dist/src/main/providers/README.txt +++ /dev/null @@ -1,2 +0,0 @@ -Any provider implementation jars and libraries in this folder will be loaded by Keycloak. See the providers -section in the documentation for more details. \ No newline at end of file diff --git a/distribution/server-dist/src/main/themes/README.txt b/distribution/server-dist/src/main/themes/README.txt deleted file mode 100644 index 705b73ac69..0000000000 --- a/distribution/server-dist/src/main/themes/README.txt +++ /dev/null @@ -1,3 +0,0 @@ -Themes to configure the look and feel of login pages and account management console. It's not recommended to -modify existing the built-in themes, instead you should create a new theme that extends a built-in theme. See the theme -section in the documentation for more details. \ No newline at end of file diff --git a/distribution/server-dist/src/main/xslt/standalone.xsl b/distribution/server-dist/src/main/xslt/standalone.xsl deleted file mode 100755 index 8973a4d71a..0000000000 --- a/distribution/server-dist/src/main/xslt/standalone.xsl +++ /dev/null @@ -1,89 +0,0 @@ - - - - - - - - - - - - - - - - - - - jdbc:h2:${jboss.server.data.dir}/keycloak;AUTO_SERVER=TRUE - h2 - - sa - sa - - - - - - - - - - - - true - auth - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/distribution/server-overlay/assembly.xml b/distribution/server-overlay/assembly.xml index a85813a2b4..8764a7d3ba 100755 --- a/distribution/server-overlay/assembly.xml +++ b/distribution/server-overlay/assembly.xml @@ -19,14 +19,6 @@ ${project.build.directory}/unpacked/docs docs - - ${project.build.directory}/unpacked/wildfly-${wildfly.version} - - - **/*.sh - - 0755 - ${project.build.directory}/unpacked/modules modules/system/layers/base @@ -38,13 +30,6 @@ **/** - - src/main/welcome-content - welcome-content - - *.* - - ../../ diff --git a/distribution/server-overlay/src/main/welcome-content/index.html b/distribution/server-overlay/src/main/welcome-content/index.html deleted file mode 100644 index ad7660ed03..0000000000 --- a/distribution/server-overlay/src/main/welcome-content/index.html +++ /dev/null @@ -1,32 +0,0 @@ - - - - - - Welcome to Keycloak - - - - - -