KEYCLOAK-2805 Minor changes - cleanup and docs

This commit is contained in:
mposolda 2016-05-05 15:37:05 +02:00
parent 534a7b6e59
commit 741e10060e
6 changed files with 20 additions and 18 deletions

View file

@ -19,7 +19,7 @@
<title>JBoss Fuse and Apache Karaf Adapter</title>
<para>
Currently Keycloak supports securing your web applications running inside <ulink url="http://www.jboss.org/products/fuse/overview/">JBoss Fuse</ulink>
or <ulink url="http://karaf.apache.org/">Apache Karaf</ulink> . It leverages <link linkend="jetty8-adapter">Jetty 8 adapter</link> as both JBoss Fuse 6.2.1
or <ulink url="http://karaf.apache.org/">Apache Karaf</ulink> . It leverages <link linkend="jetty8-adapter">Jetty 8 adapter</link> as all of JBoss Fuse 6.2.1, JBoss Fuse 6.2.0
and Apache Karaf 3 are bundled with <ulink url="http://eclipse.org/jetty/">Jetty 8.1 server</ulink> under the covers and Jetty is used for running various kinds of web applications.
For JBoss Fuse 6.3 and Karaf 4, bundled with Jetty 9 server, it leverages <link linkend="jetty9-adapter">Jetty 9 adapter</link>.
</para>

View file

@ -43,13 +43,13 @@ cd keycloak-examples-<VERSION>/fuse
mvn clean install
```
Running demo on JBoss Fuse 6.2.1
------------------------------
Running demo on JBoss Fuse 6.2.1 or JBoss Fuse 6.2.0
----------------------------------------------------
You just need to download and run JBoss Fuse and then run those commands from the karaf terminal to install the needed features and Keycloak fuse demo (Replace Keycloak versions with the current Keycloak version number):
```
features:addurl mvn:org.keycloak/keycloak-osgi-features/1.2.0.Beta1/xml/features
features:addurl mvn:org.keycloak.example.demo/keycloak-fuse-example-features/1.2.0.Beta1/xml/features
features:addurl mvn:org.keycloak/keycloak-osgi-features/1.9.4.Final/xml/features
features:addurl mvn:org.keycloak.example.demo/keycloak-fuse-example-features/1.9.4.Final/xml/features
features:install keycloak-fuse-6.2-example
```
@ -69,10 +69,10 @@ Similar steps to the instructions for JBoss Fuse 6.2.1 but you need to install a
You just need to download and run JBoss Fuse and then run those commands from the karaf terminal to install the needed features and Keycloak fuse demo (Replace Keycloak versions with the current Keycloak version number):
```
features:addurl mvn:org.keycloak/keycloak-osgi-features/1.2.0.Beta1/xml/features
features:addurl mvn:org.keycloak.example.demo/keycloak-fuse-example-features/1.2.0.Beta1/xml/features
features:addurl mvn:org.keycloak/keycloak-osgi-features/1.9.4.Final/xml/features
features:addurl mvn:org.keycloak.example.demo/keycloak-fuse-example-features/1.9.4.Final/xml/features
features:install keycloak-fuse-6.3-example
```
Running demo on Apache Karaf 3.0.3
----------------------------------
@ -86,8 +86,8 @@ Once you run Apache Karaf, you need to run these commands from Karaf console (Ma
```
feature:repo-add mvn:org.apache.camel.karaf/apache-camel/2.15.1/xml/features
feature:repo-add mvn:org.apache.cxf.karaf/apache-cxf/3.0.4/xml/features
feature:repo-add mvn:org.keycloak/keycloak-osgi-features/1.2.0.Beta1/xml/features
feature:repo-add mvn:org.keycloak.example.demo/keycloak-fuse-example-features/1.2.0.Beta1/xml/features
feature:repo-add mvn:org.keycloak/keycloak-osgi-features/1.9.4.Final/xml/features
feature:repo-add mvn:org.keycloak.example.demo/keycloak-fuse-example-features/1.9.4.Final/xml/features
feature:install keycloak-fuse-example
```
@ -127,6 +127,13 @@ original unsecured servlet on `/cxf` context is deployed back and hence context
It's recommended to use your own Jetty engine for your apps (similarly like `cxf-jaxws` application is doing).
How to secure WAR application with external keycloak.json configuration
-----------------------------------------------------------------------
It's possible to secure your WAR application with the `keycloak.json` configuration provided outside of the WAR bundle itself.
See [external-config](external-config/README.md) for more details. This is supported on JBoss Fuse 6.3.
How to secure Fuse admin services
---------------------------------
It's possible to secure fuse admin services with Keycloak too. See [fuse-admin](fuse-admin/README.md) for info on how to secure

View file

@ -19,4 +19,4 @@ Inside one of those folders it will look for a file called `<your_web_context>-k
For this example you need to copy the file `external-config-keycloak.json` to your JBoss Fuse `etc/` folder.
Once you have done that, you can try to access the endpoint: http://localhost:8181/external-config/index.html
Once you have done that and once you added feature `keycloak-fuse-6.3-example` (See [here](../README.md) for more details), you can try to access the endpoint: http://localhost:8181/external-config/index.html

View file

@ -69,11 +69,6 @@
<artifactId>keycloak-adapter-spi</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.keycloak</groupId>
<artifactId>keycloak-adapter-spi</artifactId>
<scope>provided</scope>
</dependency>
<!-- Contains KeycloakPrincipal -->
<dependency>

View file

@ -24,8 +24,7 @@
<body bgcolor="#E3F6CE">
<h1>External configuration worked.</h1>
<p><a href="http://localhost:8080/auth/realms/demo/protocol/openid-connect/logout">Log out</a></p>
<p><a href="http://localhost:8080/auth/realms/demo/protocol/openid-connect/logout?redirect_uri=http%3A%2F%2Flocalhost%3A8181%2Fexternal-config%2Findex.html">Log out</a></p>
</body>
</html>

View file

@ -30,6 +30,7 @@
<bundle dependency="true">mvn:com.fasterxml.jackson.jaxrs/jackson-jaxrs-json-provider/${jackson.version}</bundle>
<bundle>mvn:org.keycloak.example.demo/product-portal-fuse-example/${project.version}</bundle>
<bundle>mvn:org.keycloak.example.demo/customer-portal-fuse-example/${project.version}/war</bundle>
<bundle>mvn:org.keycloak.example.demo/external-config/${project.version}/war</bundle>
<bundle>mvn:org.keycloak.example.demo/camel-endpoint-example/${project.version}</bundle>
<bundle>mvn:org.keycloak.example.demo/cxf-jaxws-example/${project.version}</bundle>
<bundle>mvn:org.keycloak.example.demo/cxf-jaxrs-example/${project.version}</bundle>