Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update /auth context path requirements for Keycloak #3550

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,8 +1,28 @@
[id="prerequisites-for-configuring-{project-context}-with-keycloak-authentication_{context}"]
= Prerequisites for configuring {Project} with {keycloak-quarkus} authentication

* A {keycloak} account with administrative privileges.
* A {keycloak} server that uses HTTPS instead of HTTP and has been initialized with the `--http-relative-path=/auth` context path.
On your {ProjectServer}:

* Install the packages required for registering a {keycloak} client:
+
[options="nowrap", subs="verbatim,quotes,attributes"]
----
# {project-package-install} mod_auth_openidc keycloak-httpd-client-install python3-lxml
----
// python3-lxml is only needed on EL8 because of https://issues.redhat.com/browse/RHEL-31496
ifeval::["{context}" == "keycloak-quarkus"]
* Check which `keycloak-httpd-client-install` version is installed:
+
[options="nowrap", subs="verbatim,quotes,attributes"]
----
# rpm --query keycloak-httpd-client-install
----
endif::[]

On the {keycloak} side, ensure you meet the following requirements:

ifeval::["{context}" == "keycloak-quarkus"]
* If `keycloak-httpd-client-install` version 1.2 or earlier is installed on your {ProjectServer}, you must use a {keycloak} server that has been initialized with the `--http-relative-path=/auth` context path.
To access a {keycloak} server initialized with `--http-relative-path=/auth` from its web UI, go to `https://_{keycloak-example-com}_:8443/auth`.
+
[NOTE]
Expand All @@ -12,9 +32,14 @@ ifndef::orcharhino[]
For more information about configuring a different context path, see the {RHDocsBaseURL}red_hat_build_of_keycloak/24.0/html-single/server_guide/index#reverseproxy-different-context-path-on-reverse-proxy[_{RHBK} Administration Guide_].
endif::[]
====
* If the certificates or the CA are self-signed, add them to the end-user certificate truststore.
* A {keycloak} realm created for {Project} user accounts, for example `_{Project}_Realm_`.
* Users imported or added to {keycloak}.
+
If `keycloak-httpd-client-install` version 1.3 or later is installed, your {keycloak} server does not need to be initialized with the `--http-relative-path=/auth` context path.
endif::[]
* Your {keycloak} server uses HTTPS instead of HTTP.
* If the certificates or the CA are self-signed, they have been added to the end-user certificate truststore.
* Your {keycloak} account has administrative privileges.
* A realm is created on the {keycloak} server for {Project} user accounts, for example `_{Project}_Realm_`.
* User accounts have been imported or added to {keycloak}.
ifndef::orcharhino[]
For more information on importing or creating users, see the {RHDocsBaseURL}red_hat_build_of_keycloak/24.0/html/server_administration_guide/user-storage-federation[_{RHBK} Administration Guide_].
endif::[]
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
[id="prerequisites-for-configuring-{project-context}-with-keycloak-authentication_{context}"]
= Prerequisites for configuring {Project} with {keycloak-wildfly} authentication

* A {keycloak} account with administrative privileges.
* A {keycloak} server that uses HTTPS instead of HTTP.
* If the certificates or the CA are self-signed, ensure that they are added to the end-user certificate truststore.
* A {keycloak} realm created for {Project} user accounts, for example `_{Project}_Realm_`.
* Users imported or added to {keycloak}.
On your {ProjectServer}:

* Install the packages required for registering a {keycloak} client:
+
[options="nowrap", subs="verbatim,quotes,attributes"]
----
# {project-package-install} mod_auth_openidc keycloak-httpd-client-install python3-lxml
----
// python3-lxml is only needed on EL8 because of https://issues.redhat.com/browse/RHEL-31496

On the {keycloak} side, ensure you meet the following requirements:

* Your {keycloak} server uses HTTPS instead of HTTP.
* If the certificates or the CA are self-signed, they have been added to the end-user certificate truststore.
* Your {keycloak} account has administrative privileges.
* A realm is created on the {keycloak} server for {Project} user accounts, for example `_{Project}_Realm_`.
* User accounts have been imported or added to {keycloak}.
ifndef::orcharhino[]
For more information about importing or creating users, see the {RHDocsBaseURL}red_hat_single_sign-on/7.6/html/server_administration_guide/assembly-managing-users_server_administration_guide#proc-creating-user_server_administration_guide[_{RHSSO} Server Administration Guide_].
endif::[]
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,6 @@ endif::[]

On your {ProjectServer}:

. Install the packages required for registering a {keycloak} client:
+
[options="nowrap", subs="verbatim,quotes,attributes"]
----
# {project-package-install} mod_auth_openidc keycloak-httpd-client-install python3-lxml
----
// python3-lxml is only needed on EL8 because of https://issues.redhat.com/browse/RHEL-31496
. Choose the authentication method you want {keycloak} users to use when authenticating to {Project}:
* If you want users to authenticate by using the {ProjectWebUI}:
.. Create a client for {Project}.
Expand Down