From e1266c267824eb74ff31f7e6170407e8b1f55955 Mon Sep 17 00:00:00 2001 From: Giuseppe Graziano Date: Tue, 30 Jul 2024 11:45:27 +0200 Subject: [PATCH] Move mod-auth-openidc.adoc to guides Closes #31697 Signed-off-by: Giuseppe Graziano --- docs/documentation/securing_apps/topics.adoc | 4 ---- .../securing-apps}/mod-auth-openidc.adoc | 24 ++++++++++++------- 2 files changed, 16 insertions(+), 12 deletions(-) rename docs/{documentation/securing_apps/topics/oidc => guides/securing-apps}/mod-auth-openidc.adoc (73%) diff --git a/docs/documentation/securing_apps/topics.adoc b/docs/documentation/securing_apps/topics.adoc index 3db3376636..dc5f7027c8 100644 --- a/docs/documentation/securing_apps/topics.adoc +++ b/docs/documentation/securing_apps/topics.adoc @@ -10,10 +10,6 @@ include::topics/oidc/oidc-overview.adoc[] include::topics/oidc/javascript-adapter.adoc[] -ifeval::[{project_community}==true] -include::topics/oidc/mod-auth-openidc.adoc[] -endif::[] - include::topics/saml/saml-overview.adoc[] ifeval::[{project_product}==true] include::topics/saml/java/java-adapters-product.adoc[] diff --git a/docs/documentation/securing_apps/topics/oidc/mod-auth-openidc.adoc b/docs/guides/securing-apps/mod-auth-openidc.adoc similarity index 73% rename from docs/documentation/securing_apps/topics/oidc/mod-auth-openidc.adoc rename to docs/guides/securing-apps/mod-auth-openidc.adoc index 0e58ac5cc7..b45df39ee8 100644 --- a/docs/documentation/securing_apps/topics/oidc/mod-auth-openidc.adoc +++ b/docs/guides/securing-apps/mod-auth-openidc.adoc @@ -1,5 +1,11 @@ -[[_mod_auth_openidc]] -=== mod_auth_openidc Apache HTTPD Module +<#import "/templates/guide.adoc" as tmpl> +<#import "/templates/links.adoc" as links> + +<@tmpl.guide +title="mod_auth_openidc Apache HTTPD Module" +priority=40 +summary="Configuring the mod_auth_openidc Apache module with {project_name}"> + WARNING: {project_name} does not provide any official support to mod_auth_openidc. The instructions below are best-effort and may not be up-to-date. We recommend that you stick to official mod_auth_openidc documentation for more details. @@ -22,7 +28,7 @@ An example configuration would look like the following. ---- LoadModule auth_openidc_module modules/mod_auth_openidc.so -ServerName ${HOSTIP} +ServerName ${r"${HOSTIP}"} @@ -32,16 +38,16 @@ ServerName ${HOSTIP} #this is required by mod_auth_openidc OIDCCryptoPassphrase a-random-secret-used-by-apache-oidc-and-balancer - OIDCProviderMetadataURL ${KC_ADDR}{kc_realms_path}/${KC_REALM}/.well-known/openid-configuration + OIDCProviderMetadataURL ${r"${KC_ADDR}"}{kc_realms_path}/${r"${KC_REALM}"}/.well-known/openid-configuration - OIDCClientID ${CLIENT_ID} - OIDCClientSecret ${CLIENT_SECRET} - OIDCRedirectURI http://${HOSTIP}/${CLIENT_APP_NAME}/redirect_uri + OIDCClientID ${r"${CLIENT_ID}"} + OIDCClientSecret ${r"${CLIENT_SECRET}"} + OIDCRedirectURI http://${r"${HOSTIP}"}/${r"${CLIENT_APP_NAME}"}/redirect_uri # maps the preferred_username claim to the REMOTE_USER environment variable OIDCRemoteUserClaim preferred_username - + AuthType openid-connect Require valid-user @@ -50,3 +56,5 @@ ServerName ${HOSTIP} Further information on how to configure mod_auth_openidc can be found on the https://github.com/OpenIDC/mod_auth_openidc[mod_auth_openidc] project page. + +