Skip to content

Fixes to hostname #10820

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.

Sign up for GitHub

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

Merged
stianst merged 1 commit into from
Mar 22, 2022
Merged

Fixes to hostname #10820

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions docs/guides/src/main/server/hostname.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,11 @@ To set the hostname part of the frontend base URL, enter this command:

<@kc.start parameters="--hostname=<value>"/>

You can also set a different port if your proxy is exposing the frontend URL using a port other than the default HTTP (80) and HTTPS(443) ports. For that,
set the `hostname-port` option.

<@kc.start parameters="--hostname=<value> --hostname-port=<port>"/>

=== Backend Endpoints
Backend endpoints are used for direct communication between Keycloak and applications.
Examples of backend endpoints are the Token endpoint and the User info endpoint.
Expand All @@ -39,11 +44,6 @@ When all applications connected to Keycloak communicate through the public URL,
Otherwise, leave this parameter as false to allow internal applications to communicate with Keycloak through an internal URL.

=== Administrative Endpoints
When the Admin Console is exposed on a different hostname, use `--hostname-admin` to link to it as shown in this example:

<@kc.start parameters="--hostname=<hostname> --hostname-admin=<adminHostname>"/>

When `hostname-admin` is configured, all links and static resources used to render the Admin Console are served from the value you enter for `<adminHostname>` instead of the value for `<hostname>`.

To reduce attack surface, the administration endpoints for Keycloak and the Admin Console should not be publicly accessible.
Therefore, you can secure them by using a reverse proxy.
Expand Down
3 changes: 0 additions & 3 deletions docs/guides/src/main/server/reverseproxy.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,6 @@ For Keycloak, your choice of proxy modes depends on the TLS termination in your
== Proxy modes
The following proxy modes are available:

none:: Disables proxy support.
It is the default mode.

edge:: Enables communication through HTTP between the proxy and Keycloak.
This mode is suitable for deployments with a highly secure internal network where the reverse proxy keeps a secure connection (HTTP over TLS) with clients while communicating with Keycloak using HTTP.

Expand Down
Loading