libre.sh/keycloak-scim
4
0
Fork 0
Code Issues 15 Pull requests Releases 1 Activity Actions

Add section about hostname syntax to hostname guide

Browse source 
Superseeds PR #11139, as validation needs more investigation to work for everyone

Closes #11134
This commit is contained in:
Dominik Guhr 2022-04-07 08:07:12 +02:00 committed by Pedro Igor
parent f4f5928727
commit 9cb38087b4
2 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/guides/src/main/server/containers.adoc
View file

@ -38,7 +38,7 @@ ENV KEYCLOAK_ADMIN_PASSWORD=change_me
ENV KC_DB_URL=<DBURL>
ENV KC_DB_USERNAME=<DBUSERNAME>
ENV KC_DB_PASSWORD=<DBPASSWORD>
ENV KC_HOSTNAME=localhost:8443
ENV KC_HOSTNAME=localhost
ENTRYPOINT ["/opt/keycloak/bin/kc.sh", "start"]
----
The build process includes multiple stages:

8
docs/guides/src/main/server/hostname.adoc
View file

@ -8,9 +8,15 @@ summary="Learn how to configure the frontend and backchannel endpoints exposed b
includedOptions="hostname-* proxy">
When running Keycloak in environments such as Kubernetes, OpenShift, or on-premise, you want to protect the internal URLs from exposure to the public facing internet.
You want to use your public hostname.
Instead, You want to expose your public hostname.
This guide describes how to configure Keycloak to use the right hostname for different scenarios.
== Hostname Syntax:
Keycloak does not impose strict validation for the configured hostname value. Please make sure the hostname value you configure complies to the standardized hostname syntax as outlined in RFC 952, RFC 1123 and others.
.Example:
`LOCALHOST` is a non-compliant hostname and leads to problems when the browser tries to resolve your requests. Instead, `localhost` will work fine.
== Keycloak API Endpoint categories
As this section explains, Keycloak exposes three API endpoint categories: frontend, backend, and administrative.
Each category uses a specific base URL.