Skip to content

fix: correcting the container examples wrt hostname (#33542) #33584

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
vmuzikar merged 1 commit into from
Oct 4, 2024
Merged

fix: correcting the container examples wrt hostname (#33542) #33584

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
8 changes: 4 additions & 4 deletions docs/guides/server/containers.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ To start the image, run:
podman|docker run --name mykeycloak -p 8443:8443 -p 9000:9000 \
-e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=change_me \
mykeycloak \
start --optimized
start --optimized --hostname=localhost
----

{project_name} starts in production mode, using only secured HTTPS communication, and is available on `https://localhost:8443`.
Expand All @@ -149,18 +149,18 @@ Opening up `https://localhost:9000/metrics` leads to a page containing operation

By default, the server is listening for `http` and `https` requests using the ports `8080` and `8443`, respectively.

If you want to expose the container using a different port, you need to set the `hostname-port` accordingly:
If you want to expose the container using a different port, you need to set the `hostname` accordingly:

. Exposing the container using a port other than the default ports
[source, bash]
----
podman|docker run --name mykeycloak -p 3000:8443 \
-e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=change_me \
mykeycloak \
start --optimized --hostname-port=3000
start --optimized --hostname=https://localhost:3000
----

By setting the `hostname-port` option you can now access the server at `https://localhost:3000`.
By setting the `hostname` option to a full url you can now access the server at `https://localhost:3000`.

== Trying {project_name} in development mode
The easiest way to try {project_name} from a container for development or testing purposes is to use the Development mode.
Expand Down
2 changes: 1 addition & 1 deletion docs/guides/server/reverseproxy.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<@tmpl.guide
title="Using a reverse proxy"
summary="Learn how to configure {project_name} together with a reverse proxy, api gateway, or load balancer."
includedOptions="proxy proxy-* hostname-path hostname-url http-relative-path">
includedOptions="proxy-* hostname hostname-admin http-relative-path">

Distributed environments frequently require the use of a reverse proxy. {project_name} offers several options to securely integrate with such environments.

Expand Down