From 288b0992d9188bf2c918292438fb7a2c8d07a51e Mon Sep 17 00:00:00 2001 From: Alexander Schwartz Date: Thu, 1 Oct 2026 16:54:59 +0200 Subject: [PATCH 1/3] Fixing docs CI and links Closes #53422 Signed-off-by: Alexander Schwartz --- docs/documentation/release_notes/topics/26_8_0.adoc | 6 +++--- .../server_admin/topics/authentication/x509.adoc | 2 +- .../tests/src/test/resources/ignored-variables | 3 ++- .../documentation/topics/templates/document-attributes.adoc | 1 + 4 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/documentation/release_notes/topics/26_8_0.adoc b/docs/documentation/release_notes/topics/26_8_0.adoc index d2ccc49a5076..fa9ca9504e74 100644 --- a/docs/documentation/release_notes/topics/26_8_0.adoc +++ b/docs/documentation/release_notes/topics/26_8_0.adoc @@ -185,7 +185,7 @@ Session data is stored in the database, simplifying the deployment architecture In this release, multi-cluster v2 and the `stateless` feature are promoted from preview to supported. The feature is disabled by default and can be enabled with `--features=stateless`. A new deployment guide for bare-metal and VM environments is now available alongside the existing Kubernetes guide. -For more details, see <@links.ha id="multi-cluster-v2-introduction" />. +For more details, see link:{highavailabilityguide_base_link}/multi-cluster-v2/introduction[Multi-cluster deployments (v2)]. == Multi-cluster v1 (deprecated) // https://github.com/keycloak/keycloak/issues/52772 @@ -195,7 +195,7 @@ Multi-cluster v2, which uses the `stateless` feature, is the recommended replace It simplifies the deployment architecture by eliminating the external {jdgserver_name} cluster and its cross-site replication. If you are using `--features=multi-site`, migrate to `--features=stateless`. -For migration instructions, see https://www.keycloak.org/high-availability/multi-cluster-v2/migrate-from-v1-to-v2[Migrating from multi-cluster v1 to v2] in the {highavailabilityguide_name}. +For migration instructions, see link:{highavailabilityguide_base_link}/multi-cluster-v2/migrate-from-v1-to-v2[Migrating from multi-cluster v1 to v2] in the {highavailabilityguide_name}. == Support for encrypted PEM files for TLS certificate and private key // https://github.com/keycloak/keycloak/issues/27437 @@ -205,7 +205,7 @@ Deploying {project_name} with encrypted private keys previously required convert {project_name} now supports encrypted PKCS#8 private keys in PEM format for HTTPS configuration. Use the new `--https-certificate-key-file-password` option to provide the decryption password. The management interface also supports this via `--https-management-certificate-key-file-password`. -For details, see <@links.server id="enabletls"/>. +For details, see link:{server_guide_base_link}/outgoinghttp[Configuring outgoing HTTP requests]. == Login failures now stored in the database // https://github.com/keycloak/keycloak/issues/52126 diff --git a/docs/documentation/server_admin/topics/authentication/x509.adoc b/docs/documentation/server_admin/topics/authentication/x509.adoc index 1ad53f045d53..b5447cebc554 100644 --- a/docs/documentation/server_admin/topics/authentication/x509.adoc +++ b/docs/documentation/server_admin/topics/authentication/x509.adoc @@ -151,7 +151,7 @@ Checks the certificate revocation status by using Online Certificate Status Prot *OCSP Fail-Open Behavior*:: By default the OCSP check must return a positive response in order to continue with a successful authentication. Sometimes however this check can be inconclusive: for example, the OCSP server could be unreachable, overloaded, or the client certificate may not contain an OCSP responder URI. When this setting is turned ON, authentication will be denied only if an explicit negative response is received by the OCSP responder and the certificate is definitely revoked. If a valid OCSP response is not available the authentication attempt will be accepted. -NOTE: OCSP retry behavior is configured server-wide through the HTTP client provider. See <@links.server id="outgoinghttp"/> for details on configuring retry settings for all outgoing HTTP requests, including OCSP validation. +NOTE: OCSP retry behavior is configured server-wide through the HTTP client provider. See link:{server_guide_base_link}/outgoinghttp[Configuring outgoing HTTP requests] for details on configuring retry settings for all outgoing HTTP requests, including OCSP validation. *OCSP Responder URI*:: Override the value of the OCSP responder URI in the certificate. diff --git a/docs/documentation/tests/src/test/resources/ignored-variables b/docs/documentation/tests/src/test/resources/ignored-variables index caf4cb0569a0..fb02a5640662 100644 --- a/docs/documentation/tests/src/test/resources/ignored-variables +++ b/docs/documentation/tests/src/test/resources/ignored-variables @@ -51,4 +51,5 @@ param 2 3 4 -5 \ No newline at end of file +5 +method="GET",outcome="SUCCESS",status="200",uri="/realms/{realm \ No newline at end of file diff --git a/docs/documentation/topics/templates/document-attributes.adoc b/docs/documentation/topics/templates/document-attributes.adoc index 4e8df9642fa3..f116ccf05031 100644 --- a/docs/documentation/topics/templates/document-attributes.adoc +++ b/docs/documentation/topics/templates/document-attributes.adoc @@ -85,6 +85,7 @@ :gettingstarted_link: https://www.keycloak.org/guides#getting-started :gettingstarted_link_latest: https://www.keycloak.org/guides#getting-started :grafanadashboards_link: https://www.keycloak.org/observability/grafana-dashboards +:highavailabilityguide_base_link: https://www.keycloak.org/high-availability :highavailabilityguide_name: High Availability Guide :highavailabilityguide_link: https://www.keycloak.org/guides#high-availability :loggingguide_name: Logging Guide From e27957ca288a8e9caa5bd6083e7f9f09d3486b06 Mon Sep 17 00:00:00 2001 From: Alexander Schwartz Date: Thu, 1 Oct 2026 18:50:26 +0200 Subject: [PATCH 2/3] Support encrypted PKCS#8 keys for HTTPS configuration Added support for encrypted PKCS#8 private keys in PEM format for HTTPS configuration and updated management interface options. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Signed-off-by: Alexander Schwartz --- docs/documentation/release_notes/topics/26_8_0.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/documentation/release_notes/topics/26_8_0.adoc b/docs/documentation/release_notes/topics/26_8_0.adoc index fa9ca9504e74..6e83e13fe994 100644 --- a/docs/documentation/release_notes/topics/26_8_0.adoc +++ b/docs/documentation/release_notes/topics/26_8_0.adoc @@ -205,7 +205,7 @@ Deploying {project_name} with encrypted private keys previously required convert {project_name} now supports encrypted PKCS#8 private keys in PEM format for HTTPS configuration. Use the new `--https-certificate-key-file-password` option to provide the decryption password. The management interface also supports this via `--https-management-certificate-key-file-password`. -For details, see link:{server_guide_base_link}/outgoinghttp[Configuring outgoing HTTP requests]. +For details, see link:{server_guide_base_link}/enabletls[Configuring TLS]. == Login failures now stored in the database // https://github.com/keycloak/keycloak/issues/52126 From 7d8a97c741a041296b74ad0a0ad3f5ea5bb24d26 Mon Sep 17 00:00:00 2001 From: Alexander Schwartz Date: Fri, 2 Oct 2026 12:42:07 +0200 Subject: [PATCH 3/3] Partly reverted the change Signed-off-by: Alexander Schwartz --- docs/documentation/tests/src/test/resources/ignored-variables | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/documentation/tests/src/test/resources/ignored-variables b/docs/documentation/tests/src/test/resources/ignored-variables index fb02a5640662..caf4cb0569a0 100644 --- a/docs/documentation/tests/src/test/resources/ignored-variables +++ b/docs/documentation/tests/src/test/resources/ignored-variables @@ -51,5 +51,4 @@ param 2 3 4 -5 -method="GET",outcome="SUCCESS",status="200",uri="/realms/{realm \ No newline at end of file +5 \ No newline at end of file