keycloak-memoizeit
Changes
distribution/modules/src/main/resources/modules/org/keycloak/keycloak-saml-protocol/main/module.xml 1(+0 -1)
distribution/modules/src/main/resources/modules/org/keycloak/keycloak-services/main/module.xml 1(+0 -1)
distribution/server-overlay/assembly.xml 17(+1 -16)
distribution/server-overlay/pom.xml 2(+1 -1)
misc/ReleaseProcess.md 16(+3 -13)
pom.xml 41(+25 -16)
services/pom.xml 49(+20 -29)
Details
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 687cb6b..45a63fa 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 @@
<module name="org.jboss.logging"/>
<module name="javax.ws.rs.api"/>
<module name="org.jboss.resteasy.resteasy-jaxrs"/>
- <module name="org.jboss.resteasy.resteasy-crypto"/>
<module name="org.jboss.resteasy.resteasy-multipart-provider"/>
<module name="javax.api"/>
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 9864a07..e6fe0ba 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 @@
<module name="javax.ws.rs.api"/>
<module name="org.jboss.resteasy.resteasy-jaxrs"/>
- <module name="org.jboss.resteasy.resteasy-crypto"/>
<module name="org.jboss.resteasy.resteasy-multipart-provider"/>
<module name="javax.servlet.api"/>
<module name="org.codehaus.jackson.jackson-core-asl"/>
diff --git a/distribution/server-dist/assembly.xml b/distribution/server-dist/assembly.xml
index 03adcc2..8cbea2d 100755
--- a/distribution/server-dist/assembly.xml
+++ b/distribution/server-dist/assembly.xml
@@ -26,6 +26,13 @@
</includes>
<fileMode>0755</fileMode>
</fileSet>
+ <fileSet>
+ <directory>src/main/welcome-content</directory>
+ <outputDirectory>welcome-content</outputDirectory>
+ <includes>
+ <include>*.*</include>
+ </includes>
+ </fileSet>
</fileSets>
<dependencySets>
distribution/server-overlay/assembly.xml 17(+1 -16)
diff --git a/distribution/server-overlay/assembly.xml b/distribution/server-overlay/assembly.xml
index 88d8fe9..8764a7d 100755
--- a/distribution/server-overlay/assembly.xml
+++ b/distribution/server-overlay/assembly.xml
@@ -20,14 +20,6 @@
<outputDirectory>docs</outputDirectory>
</fileSet>
<fileSet>
- <directory>${project.build.directory}/unpacked/wildfly-${wildfly.version}</directory>
- <outputDirectory></outputDirectory>
- <includes>
- <include>**/*.sh</include>
- </includes>
- <fileMode>0755</fileMode>
- </fileSet>
- <fileSet>
<directory>${project.build.directory}/unpacked/modules</directory>
<outputDirectory>modules/system/layers/base</outputDirectory>
</fileSet>
@@ -39,13 +31,6 @@
</includes>
</fileSet>
<fileSet>
- <directory>src/main/welcome-content</directory>
- <outputDirectory>welcome-content</outputDirectory>
- <includes>
- <include>*.*</include>
- </includes>
- </fileSet>
- <fileSet>
<directory>../../</directory>
<includes>
<include>License.html</include>
@@ -57,7 +42,7 @@
<outputDirectory>docs/javadocs</outputDirectory>
</fileSet>
<fileSet>
- <directory>../../services/target/site/apidocs</directory>
+ <directory>../../services/target/apidocs</directory>
<outputDirectory>docs/rest-api</outputDirectory>
</fileSet>
<fileSet>
distribution/server-overlay/pom.xml 2(+1 -1)
diff --git a/distribution/server-overlay/pom.xml b/distribution/server-overlay/pom.xml
index 68a38a1..a4ef9a0 100755
--- a/distribution/server-overlay/pom.xml
+++ b/distribution/server-overlay/pom.xml
@@ -27,7 +27,7 @@
</dependencies>
<build>
- <finalName>keycloak-${project.version}</finalName>
+ <finalName>keycloak-overlay-${project.version}</finalName>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
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 f44d7d6..44ecae0 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 @@
<module name="org.bouncycastle"/>
<module name="org.jboss.resteasy.resteasy-jackson-provider" services="import"/>
+ <module name="org.jboss.resteasy.resteasy-jaxrs"/>
</dependencies>
<exclusions>
<module name="org.jboss.resteasy.resteasy-jackson2-provider"/>
diff --git a/docbook/reference/en/en-US/modules/server-installation.xml b/docbook/reference/en/en-US/modules/server-installation.xml
index 223c330..5b4b043 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 @@
<itemizedlist>
<listitem>
- keycloak-appliance-dist-all-&project.version;.zip
+ keycloak-&project.version;.zip
</listitem>
<listitem>
- keycloak-war-dist-all-&project.version;.zip
+ keycloak-overlay-&project.version;.zip
</listitem>
</itemizedlist>
</para>
- <section id="Appliance_install">
- <title>Appliance Install</title>
+ <section id="server_install">
+ <title>Server Install</title>
<para>
The
- <literal>keycloak-appliance-dist-all-&project.version;.zip</literal>
+ <literal>keycloak-&project.version;.zip</literal>
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 @@
<para>
<programlisting>
-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/
</programlisting>
</para>
@@ -58,51 +56,32 @@ keycloak-appliance-dist-all-&project.version;/
</para>
</section>
<section id="WAR_distribution_installation">
- <title>WAR Distribution Installation</title>
+ <title>Server Overlay Installation</title>
<para>
The
- <literal>keycloak-war-dist-all-&project.version;.zip</literal>
+ <literal>keycloak-overlay-&project.version;.zip</literal>
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.
</para>
<para>
The directory structure of this distro looks like this:
</para>
<para>
<programlisting>
-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/
</programlisting>
</para>
<para>
- After unzipping this file, copy everything in <literal>deployments</literal> directory into the
- <literal>standalone/deployments</literal> of your JBoss or Wildfly distro. Also, copy everything in
- <literal>configuration</literal> directory into the <literal>standalone/configuration</literal> directory.
+ Unzip this archive into the root of your WildFly installation.
</para>
<para>
-<programlisting>
- $ cd keycloak-war-dist-all-&project.version;
- $ cp -r deployments $JBOSS_HOME/standalone/deployments
- $ cp -r configuration $JBOSS_HOME/standalone/configuration
-</programlisting>
- </para>
- <para>
- After these steps you MUST then <link linkend='jboss-adapter-installation'>download and install the client adapter</link>
- 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.
- </para>
- <para>
- 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<ulink
url="http://localhost:8080/auth/admin/index.html">
http://localhost:8080/auth/admin/index.html</ulink>.
@@ -110,9 +89,6 @@ keycloak-war-dist-all-&project.version;/
Password: <emphasis>admin</emphasis>. Keycloak will then prompt you to
enter in a new password.
</para>
- <para>
- You can no longer run Keycloak on JBoss AS 7.1.1. You must run on EAP 6.x or Wildfly.
- </para>
</section>
<section>
<title id="configure-server">Configuring the Server</title>
@@ -137,56 +113,12 @@ keycloak-war-dist-all-&project.version;/
<section>
<title>Relational Database Configuration</title>
<para>
- By default, Keycloak uses a relational database to store Keycloak data. This datasource is the <literal>standalone/deployments/keycloak-ds.xml</literal>
- file of your Keycloak Server installation if you used <xref linkend="WAR_distribution_installation" /> or in <literal>standalone/configuration/standalone.xml</literal>
- if you used <xref linkend="Appliance_install" />. File <literal>keycloak-ds.xml</literal> is used in WAR
- distribution, so that you have datasource available out of the box and you don't need to edit <literal>standalone.xml</literal> file.
- However a good thing is to always delete the file <literal>keycloak-ds.xml</literal> and move its configuration text
- into the centrally managed <literal>standalone.xml</literal> file.
- This will allow you to manage the database connection pool from the Wildfly/JBoss administration console. Here's what
- <literal>standalone/configuration/standalone.xml</literal> should look like after you've done this:
- </para>
- <para>
-<programlisting><![CDATA[
-<subsystem xmlns="urn:jboss:domain:datasources:2.0">
- <datasources>
- <datasource jndi-name="java:jboss/datasources/ExampleDS"
- pool-name="ExampleDS" enabled="true" use-java-context="true">
- <connection-url>jdbc:h2:mem:test;DB_CLOSE_DELAY=-1;DB_CLOSE_ON_EXIT=FALSE</connection-url>
- <driver>h2</driver>
- <security>
- <user-name>sa</user-name>
- <password>sa</password>
- </security>
- </datasource>
- <datasource jndi-name="java:jboss/datasources/KeycloakDS"
- pool-name="KeycloakDS" enabled="true" use-java-context="true">
- <connection-url>jdbc:h2:${jboss.server.data.dir}/keycloak;AUTO_SERVER=TRUE</connection-url>
- <driver>h2</driver>
- <security>
- <user-name>sa</user-name>
- <password>sa</password>
- </security>
- </datasource>
- <drivers>
- <driver name="h2" module="com.h2database.h2">
- <xa-datasource-class>org.h2.jdbcx.JdbcDataSource</xa-datasource-class>
- </driver>
- </drivers>
- </datasources>
-</subsystem>
-]]>
-</programlisting>
- </para>
- <para>
- Besides moving the database config into the central <literal>standalone.xml</literal> 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 <ulink url="https://docs.jboss.org/author/display/WFLY8/DataSource+configuration">Wildfly</ulink>,
- <ulink url="https://docs.jboss.org/author/display/AS71/DataSource+configuration">JBoss AS7</ulink>,
- or <ulink url="https://docs.jboss.org/author/display/AS71/DataSource+configuration">JBoss EAP 6.x</ulink> documentation on how to do 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 <ulink url="https://docs.jboss.org/author/display/WFLY8/DataSource+configuration">Wildfly</ulink>
+ documentation on how to do this.
</para>
<para>
- 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
<literal>standalone/configuration/keycloak-server.json</literal>.
By default the setting is like this:
<programlisting><![CDATA[
@@ -463,29 +395,6 @@ All configuration options are optional. Default value for directory is <literal>
</para>
</section>
- <section>
- <title>EAP6.x Logging</title>
- <para>
- Accessing the admin console will get these annoying log messages:
- </para>
-<programlisting>
- 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
-
-</programlisting>
-
- <para>
- These can be ignored by editing standalone.xml of your jboss installation:
- </para>
-<programlisting>
-<![CDATA[
- <logger category="org.jboss.resteasy.core.ResourceLocator">
- <level name="ERROR"/>
- </logger>
-]]>
-</programlisting>
- </section>
-
<section id="ssl_modes">
<title>SSL/HTTPS Requirement/Modes</title>
<warning>
@@ -553,7 +462,7 @@ All configuration options are optional. Default value for directory is <literal>
</listitem>
<listitem>
- Enable JBoss or Wildfly to use this certificate and turn on SSL/HTTPS.
+ Enable Wildfly to use this certificate and turn on SSL/HTTPS.
</listitem>
</itemizedlist>
</para>
@@ -674,29 +583,6 @@ All configuration options are optional. Default value for directory is <literal>
Check the <ulink url="https://docs.jboss.org/author/display/WFLY8/Undertow+(web)+subsystem+configuration">Wildfly Undertow</ulink> documentation for more information on fine tuning the socket connections.
</para>
</section>
- <section>
- <title>Installing the keystore to JBoss EAP6</title>
- <para>
- 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 <literal>standalone/configuration</literal>.
- Then you need to edit <literal>standalone/configuration/standalone.xml</literal> to enable SSL/HTTPS.
- </para>
- <para>
-<programlisting><![CDATA[<subsystem xmlns="urn:jboss:domain:web:1.1" default-virtual-server="default-host" native="false">
- <connector name="http" protocol="HTTP/1.1" scheme="http" socket-binding="http" redirect-port="443" />
- <connector name="https" scheme="https" protocol="HTTP/1.1" socket-binding="https"
- enable-lookups="false" secure="true">
- <ssl name="localhost-ssl" password="secret" protocol="TLSv1"
- key-alias="localhost" certificate-key-file="${jboss.server.config.dir}/keycloak.jks" />
- </connector>
- ...
-</subsystem>]]></programlisting>
- </para>
- <para>
- Check the <ulink url="https://docs.jboss.org/author/display/AS71/SSL+setup+guide">JBoss</ulink> documentation for more information on fine tuning the socket connections.
- </para>
- </section>
</section>
<section>
@@ -710,7 +596,7 @@ All configuration options are optional. Default value for directory is <literal>
</para>
<section>
- <title>WildFly</title>
+ <title>Configure WildFly</title>
<para>
Open <literal>standalone/configuration/standalone.xml</literal> in your favorite editor.
@@ -742,39 +628,6 @@ All configuration options are optional. Default value for directory is <literal>
Check the <ulink url="https://docs.jboss.org/author/display/WFLY8/Undertow+(web)+subsystem+configuration">WildFly</ulink> documentation for more information.
</para>
</section>
-
- <section>
- <title>EAP</title>
-
- <para>
- Open <literal>standalone/configuration/standalone.xml</literal> in your favorite editor.
- </para>
-
- <para>
- You need to add <literal>redirect-port</literal> to http <literal>connector</literal> element and
- add the <literal>RemoteIpValve</literal> valve:
-<programlisting><![CDATA[
-<subsystem xmlns="urn:jboss:domain:web:1.5"
- default-virtual-server="default-host" native="false">
- <connector name="http" protocol="HTTP/1.1" scheme="http"
- socket-binding="http"
- redirect-port="443"/>
- <virtual-server name="default-host" enable-welcome-root="true">
- <alias name="localhost"/>
- <alias name="example.com"/>
- </virtual-server>
- <valve name="remoteipvalve" module="org.jboss.as.web"
- class-name="org.apache.catalina.valves.RemoteIpValve">
- <param param-name="protocolHeader" param-value="x-forwarded-proto"/>
- </valve>
-</subsystem>
-]]></programlisting>
- </para>
-
-
-
- </section>
-
</section>
</section>
misc/ReleaseProcess.md 16(+3 -13)
diff --git a/misc/ReleaseProcess.md b/misc/ReleaseProcess.md
index 08fd1b6..6cf5c9d 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
pom.xml 41(+25 -16)
diff --git a/pom.xml b/pom.xml
index 8bf033d..c098507 100755
--- a/pom.xml
+++ b/pom.xml
@@ -1042,22 +1042,6 @@
</plugin>
</plugins>
</pluginManagement>
-
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-javadoc-plugin</artifactId>
- <configuration>
- <minmemory>128m</minmemory>
- <maxmemory>1024m</maxmemory>
- <quiet>false</quiet>
- <aggregate>true</aggregate>
- <excludePackageNames>
- se.unlogic.*:com.restfully.*:org.jboss.resteasy.examples.*:org.jboss.resteasy.tests.*
- </excludePackageNames>
- </configuration>
- </plugin>
- </plugins>
</build>
<profiles>
@@ -1067,6 +1051,31 @@
<module>docbook</module>
<module>distribution</module>
</modules>
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>aggregate</id>
+ <phase>package</phase>
+ <goals>
+ <goal>aggregate</goal>
+ </goals>
+ <configuration>
+ <minmemory>128m</minmemory>
+ <maxmemory>1024m</maxmemory>
+ <aggregate>true</aggregate>
+ <excludePackageNames>
+ se.unlogic.*:com.restfully.*:org.jboss.resteasy.examples.*:org.jboss.resteasy.tests.*
+ </excludePackageNames>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
</profile>
</profiles>
</project>
services/pom.xml 49(+20 -29)
diff --git a/services/pom.xml b/services/pom.xml
index bc5762f..2fa148d 100755
--- a/services/pom.xml
+++ b/services/pom.xml
@@ -183,35 +183,26 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
- <executions>
- <execution>
- <id>generate-service-docs</id>
- <phase>generate-resources</phase>
- <configuration>
- <subpackages>org.keycloak.services.resources.admin:org.keycloak.protocol.oidc</subpackages>
- <doclet>com.lunatech.doclets.jax.jaxrs.JAXRSDoclet</doclet>
- <docletArtifacts>
- <docletArtifact>
- <groupId>com.lunatech.jax-doclets</groupId>
- <artifactId>doclets</artifactId>
- <version>0.10.2</version>
- </docletArtifact>
- </docletArtifacts>
- <detectOfflineLinks>false</detectOfflineLinks>
- <offlineLinks>
- <offlineLink>
- <url>../javadocs</url>
- <location>${project.basedir}/../target/site/apidocs</location>
- </offlineLink>
- </offlineLinks>
- <additionalparam>-disablejavascriptexample</additionalparam>
- <additionalparam>-pathexcludefilter '/admin/.*index.*' -pathexcludefilter '/admin' -pathexcludefilter '/admin/\\{realm\\}/console.*'</additionalparam>
- </configuration>
- <goals>
- <goal>javadoc</goal>
- </goals>
- </execution>
- </executions>
+ <configuration>
+ <subpackages>org.keycloak.services.resources.admin:org.keycloak.protocol.oidc</subpackages>
+ <doclet>com.lunatech.doclets.jax.jaxrs.JAXRSDoclet</doclet>
+ <docletArtifacts>
+ <docletArtifact>
+ <groupId>com.lunatech.jax-doclets</groupId>
+ <artifactId>doclets</artifactId>
+ <version>0.10.2</version>
+ </docletArtifact>
+ </docletArtifacts>
+ <detectOfflineLinks>false</detectOfflineLinks>
+ <offlineLinks>
+ <offlineLink>
+ <url>../javadocs</url>
+ <location>${project.basedir}/../target/site/apidocs</location>
+ </offlineLink>
+ </offlineLinks>
+ <additionalparam>-disablejavascriptexample</additionalparam>
+ <additionalparam>-pathexcludefilter '/admin/.*index.*' -pathexcludefilter '/admin' -pathexcludefilter '/admin/\\{realm\\}/console.*'</additionalparam>
+ </configuration>
</plugin>
</plugins>
</build>