2016-09-06 09:45:57 +00:00
[[_fuse_install_feature]]
2017-02-27 01:45:09 +00:00
===== Installing the Keycloak Feature
2016-09-06 09:45:57 +00:00
2017-02-27 01:45:09 +00:00
You must first install the `keycloak` feature in the JBoss Fuse environment. The keycloak feature includes the Fuse adapter and all third-party dependencies. You can install it either from the Maven repository or from an archive.
2016-09-06 09:45:57 +00:00
2017-02-27 01:45:09 +00:00
====== Installing from the Maven Repository
2016-09-06 09:45:57 +00:00
2017-02-27 01:45:09 +00:00
As a prequisite, you need to be online and have access to the Maven repository.
2016-09-06 09:45:57 +00:00
{% if book.community %}
2017-02-27 01:45:09 +00:00
For community it's sufficient to be online as all the artifacts and 3rd party dependencies should be available in the maven central repository.
2016-09-06 09:45:57 +00:00
{% endif %}
2016-09-09 04:26:32 +00:00
{% if book.product %}
2017-02-27 01:45:09 +00:00
For {{book.project.name}} you first need to configure a proper Maven repository, so you can install the artifacts. For more information see the
https://access.redhat.com/maven-repository[Maven Repository] page.
2016-09-09 04:26:32 +00:00
2017-02-27 01:45:09 +00:00
Assuming the Maven repository is https://maven.repository.redhat.com/ga/, add the following to the `$FUSE_HOME/etc/org.ops4j.pax.url.mvn.cfg` file and add the repository to the list of supported repositories. For example:
2016-09-09 04:26:32 +00:00
[source]
----
2017-02-27 01:45:09 +00:00
org.ops4j.pax.url.mvn.repositories= \
2016-09-09 04:26:32 +00:00
https://maven.repository.redhat.com/ga@id=redhat.product.repo
http://repo1.maven.org/maven2@id=maven.central.repo, \
...
----
{% endif %}
2016-09-06 09:45:57 +00:00
2017-02-27 01:45:09 +00:00
To install the keycloak feature using the maven repository complete the following steps:
. Start {{book.fuseVersion}}; then in the Karaf terminal type:
2016-09-06 09:45:57 +00:00
2016-12-05 12:31:38 +00:00
[source,subs="attributes"]
2016-09-06 09:45:57 +00:00
----
features:addurl mvn:org.keycloak/keycloak-osgi-features/{{book.project.versionMvn}}/xml/features
features:install keycloak
----
2017-02-27 01:45:09 +00:00
. You might also need to install the Jetty 9 feature:
2016-09-06 09:45:57 +00:00
[source]
----
features:install keycloak-jetty9-adapter
----
2017-02-27 01:45:09 +00:00
NOTE: If you are using JBoss Fuse 6.2 or later, you should use `keycloak-jetty8-adapter`. However, upgrading {{book.fuseVersion}} instead.
2016-11-24 15:48:35 +00:00
2017-02-27 01:45:09 +00:00
. Ensure that the features were installed:
2016-09-06 09:45:57 +00:00
[source]
----
features:list | grep keycloak
----
2017-02-27 01:45:09 +00:00
====== Installing from the ZIP bundle
This is useful if you are offline or do not want to use Maven to obtain the JAR files and other artifacts.
2016-09-06 09:45:57 +00:00
2017-02-27 01:45:09 +00:00
To install the Fuse adapter from the ZIP archive, complete the following steps:
2016-09-06 09:45:57 +00:00
2017-02-27 01:45:09 +00:00
. Download the {{book.project.name}} Fuse adapter ZIP archive.
. Unzip it into the root directory of JBoss Fuse. The dependencies are then installed under the `system` directory. You can overwrite all existing jar files.
+
Use this for {{book.fuseVersion}}:
+
2016-12-05 12:31:38 +00:00
[source,subs="attributes"]
2016-09-06 09:45:57 +00:00
----
2016-11-24 15:48:35 +00:00
cd /path-to-fuse/jboss-fuse-6.3.0.redhat-198
2016-09-06 09:45:57 +00:00
unzip -q /path-to-adapter-zip/keycloak-fuse-adapter-dist-{{book.project.versionMvn}}.zip
----
2017-02-27 01:45:09 +00:00
. Start Fuse and run these commands in the fuse/karaf terminal:
+
2016-12-05 12:31:38 +00:00
[source,subs="attributes"]
2016-09-06 09:45:57 +00:00
----
features:addurl mvn:org.keycloak/keycloak-osgi-features/{{book.project.versionMvn}}/xml/features
features:install keycloak
----
2017-02-27 01:45:09 +00:00
. Install the corresponding Jetty adapter. Since the artifacts are available directly in the JBoss Fuse `system` directory, you do not need to use the Maven repository.
2016-09-06 09:45:57 +00:00
