Skip to content
This repository has been archived by the owner on Apr 19, 2023. It is now read-only.

Added install instructions for EAP adapters via RPM (KEYCLOAK-5598) #232

Merged
merged 2 commits into from
Nov 10, 2017
Merged

Added install instructions for EAP adapters via RPM (KEYCLOAK-5598) #232

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
44861c3
Added install instructions for EAP adapters via RPM
matthewhelmke Nov 9, 2017
055cbca
Added information about EAP 6 from RPM
matthewhelmke Nov 9, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
108 changes: 106 additions & 2 deletions securing_apps/topics/oidc/java/jboss-adapter.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,25 +69,129 @@ $ unzip keycloak-as7-adapter-dist-{project_version}.zip
endif::[]

ifeval::[{project_product}==true]

Install on JBoss EAP 7:

You can install the EAP 7 adapters either by unzipping a ZIP file, or by using an RPM.

Install the EAP 7 Adapters from a ZIP File:

[source, subs="attributes"]
----
$ cd $EAP_HOME
$ unzip rh-sso-{project_version}-eap7-adapter.zip
----

Install the EAP 7 Adapters from an RPM:

NOTE: With Red Hat Enterprise Linux 7, the term channel was replaced with the term repository. In these instructions only the term repository is used.

You must subscribe to the JBoss EAP 7.0 repository before you can install the EAP 7 adapters from an RPM.

.Prerequisites

. Ensure that your Red Hat Enterprise Linux system is registered to your account using Red Hat Subscription Manager. For more information see the link:https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html-single/quick_registration_for_rhel/index[Red Hat Subscription Management documentation].

. If you are already subscribed to another JBoss EAP repository, you must unsubscribe from that repository first.

Using Red Hat Subscription Manager, subscribe to the JBoss EAP 7.0 repository using the following command. Replace <RHEL_VERSION> with either 6 or 7 depending on your Red Hat Enterprise Linux version.
Copy link

@alicerum alicerum Nov 9, 2017 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We also have EAP 6 adapters, would be a nice idea to add them to docs

These are repos for eap6 and eap7 respectively

jb-eap-6-for-rhel-${RHEL_VERSION}-server-rpms
jb-eap-7-for-rhel-${RHEL_VERSION}-server-rpms

and package names for eap6 look about the same:

eap6-keycloak-adapter
eap6-keycloak-saml-adapter

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ooh, thanks! I didn't know these existed.


----
$ sudo subscription-manager repos --enable=jb-eap-7-for-rhel-<RHEL_VERSION>-server-rpms
----

Install the EAP 7 adapters for OIDC using the following command:

----
$ sudo yum install eap7-keycloak-adapter
----

Install the EAP 7 adapters for SAML using the following command:

----
$ sudo yum install eap7-keycloak-saml-adapter
----

NOTE: The default EAP_HOME path for the RPM installation is /opt/rh/eap7/root/usr/share/wildfly.

Run the appropriate module installation script.

For the OIDC module, enter the following command:

----
$ {EAP_HOME}/bin/jboss-cli.sh -c --file=${EAP_HOME}/bin/adapter-install.cli
----

For the SAML module, enter the following command:

----
$ {EAP_HOME}/bin/jboss-cli.sh -c --file=${EAP_HOME}/bin/adapter-install-saml.cli
----

Your installation is complete.

Install on JBoss EAP 6:

You can install the EAP 6 adapters either by unzipping a ZIP file, or by using an RPM.

Install the EAP 6 Adapters from a ZIP File:

[source, subs="attributes"]
----
$ cd $EAP_HOME
$ unzip rh-sso-{project_version}-eap6-adapter.zip
----

Install the EAP 6 Adapters from an RPM:

NOTE: With Red Hat Enterprise Linux 7, the term channel was replaced with the term repository. In these instructions only the term repository is used.

You must subscribe to the JBoss EAP 6.0 repository before you can install the EAP 6 adapters from an RPM.

.Prerequisites

. Ensure that your Red Hat Enterprise Linux system is registered to your account using Red Hat Subscription Manager. For more information see the link:https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html-single/quick_registration_for_rhel/index[Red Hat Subscription Management documentation].

. If you are already subscribed to another JBoss EAP repository, you must unsubscribe from that repository first.

Using Red Hat Subscription Manager, subscribe to the JBoss EAP 6.0 repository using the following command. Replace <RHEL_VERSION> with either 6 or 7 depending on your Red Hat Enterprise Linux version.

----
$ sudo subscription-manager repos --enable=jb-eap-6-for-rhel-<RHEL_VERSION>-server-rpms
----

Install the EAP 6 adapters for OIDC using the following command:

----
$ sudo yum install eap6-keycloak-adapter
----

Install the EAP 6 adapters for SAML using the following command:

----
$ sudo yum install eap6-keycloak-saml-adapter
----

NOTE: The default EAP_HOME path for the RPM installation is /opt/rh/eap6/root/usr/share/wildfly.

Run the appropriate module installation script.

For the OIDC module, enter the following command:

----
$ {EAP_HOME}/bin/jboss-cli.sh -c --file=${EAP_HOME}/bin/adapter-install.cli
----

For the SAML module, enter the following command:

----
$ {EAP_HOME}/bin/jboss-cli.sh -c --file=${EAP_HOME}/bin/adapter-install-saml.cli
----

Your installation is complete.
endif::[]

This ZIP archive contains JBoss Modules specific to the {project_name} adapter. It also contains JBoss CLI scripts
to configure the adapter subsystem.
This ZIP archive contains JBoss Modules specific to the {project_name} adapter. It also contains JBoss CLI scripts to configure the adapter subsystem.

To configure the adapter subsystem if the server is not running execute:

Expand Down