bitnami/keycloak
Bitnami container image for Keycloak
10M+
Keycloak is a high performance Java-based identity and access management solution. It lets developers add an authentication layer to their applications with minimum effort.
Overview of Keycloak Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
docker run --name keycloak bitnami/keycloak:latest
Warning: This quick setup is only intended for development environments. You are encouraged to change the insecure default credentials and check out the available configuration options in the Configuration section for a more secure deployment.
Looking to use Keycloak in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
Deploying Bitnami applications as Helm Charts is the easiest way to get started with our applications on Kubernetes. Read more about the installation in the Bitnami Keycloak Chart GitHub repository.
Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers in our docs.
Starting December 10th 2024, only the latest stable branch of any container will receive updates in the free Bitnami catalog. To access up-to-date releases for all upstream-supported branches, consider upgrading to Bitnami Premium. Previous versions already released will not be deleted. They are still available to pull from DockerHub.
Please check the Bitnami Premium page in our partner Arrow Electronics for more information.
Dockerfile
linksLearn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags in our documentation page.
You can see the equivalence between the different tags by taking a look at the tags-info.yaml
file present in the branch folder, i.e bitnami/ASSET/BRANCH/DISTRO/tags-info.yaml
.
Subscribe to project updates by watching the bitnami/containers GitHub repo.
The recommended way to get the Bitnami keycloak Docker Image is to pull the prebuilt image from the Docker Hub Registry.
docker pull bitnami/keycloak:latest
To use a specific version, you can pull a versioned tag. You can view the list of available versions in the Docker Hub Registry.
docker pull bitnami/keycloak:[TAG]
If you wish, you can also build the image yourself by cloning the repository, changing to the directory containing the Dockerfile and executing the docker build
command. Remember to replace the APP
, VERSION
and OPERATING-SYSTEM
path placeholders in the example command below with the correct values.
git clone https://github.com/bitnami/containers.git
cd bitnami/APP/VERSION/OPERATING-SYSTEM
docker build -t bitnami/APP:latest .
Customizable environment variables
Name | Description | Default Value |
---|---|---|
KEYCLOAK_MOUNTED_CONF_DIR | Directory for including custom configuration files (that override the default generated ones) | ${KEYCLOAK_VOLUME_DIR}/conf |
KC_RUN_IN_CONTAINER | Keycloak kc.sh context | true |
KEYCLOAK_ADMIN | Keycloak administrator user | user |
KEYCLOAK_ADMIN_PASSWORD | Keycloak administrator password | bitnami |
KEYCLOAK_HTTP_RELATIVE_PATH | Set the path relative to "/" for serving resources. | / |
KEYCLOAK_HTTP_PORT | HTTP port | 8080 |
KEYCLOAK_HTTPS_PORT | HTTPS port | 8443 |
KEYCLOAK_BIND_ADDRESS | Bind address | $(hostname --fqdn) |
KEYCLOAK_HOSTNAME | Keycloak hostname | nil |
KEYCLOAK_HOSTNAME_ADMIN | Keycloak admin hostname | nil |
KEYCLOAK_HOSTNAME_STRICT | Disables dynamically resolving the hostname from request headers | false |
KEYCLOAK_INIT_MAX_RETRIES | Maximum retries for checking that the database works | 10 |
KEYCLOAK_CACHE_TYPE | Defines the cache mechanism for high-availability. | ispn |
KEYCLOAK_CACHE_STACK | Apply a specific cache stack | nil |
KEYCLOAK_CACHE_CONFIG_FILE | Path to the cache config file | nil |
KEYCLOAK_EXTRA_ARGS | Add extra startup parameters to keycloak | nil |
KEYCLOAK_ENABLE_STATISTICS | Enable metrics for the database | false |
KEYCLOAK_ENABLE_HEALTH_ENDPOINTS | Enable health endpoints | false |
KEYCLOAK_ENABLE_HTTPS | Enable SSL certificates | false |
KEYCLOAK_HTTPS_TRUST_STORE_FILE | Path to the SSL truststore file | nil |
KEYCLOAK_HTTPS_TRUST_STORE_PASSWORD | Password for decrypting the truststore file | nil |
KEYCLOAK_HTTPS_KEY_STORE_FILE | Path to the SSL keystore file | nil |
KEYCLOAK_HTTPS_KEY_STORE_PASSWORD | Password for decrypting the keystore file | nil |
KEYCLOAK_HTTPS_USE_PEM | Set to true to configure HTTPS using PEM certificates | false |
KEYCLOAK_HTTPS_CERTIFICATE_FILE | Path to the PEM certificate file | nil |
KEYCLOAK_HTTPS_CERTIFICATE_KEY_FILE | Path to the PEM key file | nil |
KEYCLOAK_SPI_TRUSTSTORE_FILE | Path to the Keycloak SPI truststore file | nil |
KEYCLOAK_SPI_TRUSTSTORE_PASSWORD | Password for decrypting the SPI truststore file | nil |
KEYCLOAK_SPI_TRUSTSTORE_FILE_HOSTNAME_VERIFICATION_POLICY | Hostqname verification policy for SPI connection over HTTPS/TLS | nil |
KEYCLOAK_LOG_LEVEL | Keycloak log level | info |
KEYCLOAK_LOG_OUTPUT | Keycloak log output | default |
KEYCLOAK_ROOT_LOG_LEVEL | Keycloak root log level | INFO |
KEYCLOAK_PROXY_HEADERS | Keycloak reverse proxy headers | nil |
KEYCLOAK_PRODUCTION | Run in production mode | false |
KEYCLOAK_EXTRA_ARGS_PREPENDED | Run with flags which are applied directly to keycloak executable | nil |
KEYCLOAK_DATABASE_VENDOR | Database vendor | postgresql |
KEYCLOAK_DATABASE_HOST | Database backend hostname | postgresql |
KEYCLOAK_DATABASE_PORT | Database backend port | 5432 |
KEYCLOAK_DATABASE_USER | Database backend username | bn_keycloak |
KEYCLOAK_DATABASE_NAME | Database name | bitnami_keycloak |
KEYCLOAK_DATABASE_PASSWORD | Database backend password | nil |
KEYCLOAK_DATABASE_SCHEMA | PostgreSQL database schema | public |
KEYCLOAK_JDBC_PARAMS | Extra JDBC connection parameters for the database (e.g.: sslmode=verify-full&connectTimeout=30000 ) | nil |
KEYCLOAK_JDBC_DRIVER | JDBC driver to set in the connection string for the database | postgresql |
KEYCLOAK_DAEMON_USER | Keycloak daemon user when running as root | keycloak |
KEYCLOAK_DAEMON_GROUP | Keycloak daemon group when running as root | keycloak |
Read-only environment variables
Name | Description | Value |
---|---|---|
BITNAMI_VOLUME_DIR | Directory where to mount volumes. | /bitnami |
JAVA_HOME | Java installation directory | /opt/bitnami/java |
KEYCLOAK_BASE_DIR | Keycloak base directory | /opt/bitnami/keycloak |
KEYCLOAK_BIN_DIR | Keycloak bin directory | $KEYCLOAK_BASE_DIR/bin |
KEYCLOAK_PROVIDERS_DIR | Keycloak Wildfly extensions directory | $KEYCLOAK_BASE_DIR/providers |
KEYCLOAK_LOG_DIR | Keycloak bin directory | $KEYCLOAK_PROVIDERS_DIR/log |
KEYCLOAK_TMP_DIR | Keycloak tmp directory | $KEYCLOAK_PROVIDERS_DIR/tmp |
KEYCLOAK_DOMAIN_TMP_DIR | Keycloak tmp directory | $KEYCLOAK_BASE_DIR/domain/tmp |
WILDFLY_BASE_DIR | Wildfly base directory | /opt/bitnami/wildfly |
KEYCLOAK_VOLUME_DIR | Path to keycloak mount directory | /bitnami/keycloak |
KEYCLOAK_CONF_DIR | Keycloak configuration directory | $KEYCLOAK_BASE_DIR/conf |
KEYCLOAK_DEFAULT_CONF_DIR | Keycloak default configuration directory | $KEYCLOAK_BASE_DIR/conf.default |
KEYCLOAK_INITSCRIPTS_DIR | Path to keycloak init scripts directory | /docker-entrypoint-initdb.d |
KEYCLOAK_CONF_FILE | Name of the keycloak configuration file (relative path) | keycloak.conf |
KEYCLOAK_DEFAULT_CONF_FILE | Name of the keycloak configuration file (relative path) | keycloak.conf |
In case you want to add extra flags to the Keycloak use the KEYCLOAK_EXTRA_ARGS
variable. Example:
docker run --name keycloak \
-e KEYCLOAK_EXTRA_ARGS="-Dkeycloak.profile.feature.scripts=enabled" \
bitnami/keycloak:latest
Or, if you need flags which are applied directly to keycloak executable, you can use KEYCLOAK_EXTRA_ARGS_PREPENDED
variable. Example:
docker run --name keycloak \
-e KEYCLOAK_EXTRA_ARGS_PREPENDED="--spi-login-protocol-openid-connect-legacy-logout-redirect-uri=true" \
bitnami/keycloak:latest
When the container is launched, it will execute the files with extension .sh
located at /docker-entrypoint-initdb.d
.
In order to have your custom files inside the docker image you can mount them as a volume.
docker run --name keycloak \
-v /path/to/init-scripts:/docker-entrypoint-initdb.d \
bitnami/keycloak:latest
Or with docker-compose
keycloak:
image: bitnami/keycloak:latest
volumes:
- /path/to/init-scripts:/docker-entrypoint-initdb.d
The Bitnami Keycloak Docker image allows configuring HTTPS/TLS encription. This is done by mounting in /opt/bitnami/keycloak/certs
two files:
keystore
: File with the server keystoretruststore
: File with the server truststoreNote: find more information about how to create these files at the Keycloak documentation.
Apart from that, the following environment variables must be set:
KEYCLOAK_ENABLE_HTTPS
: Enable TLS encryption using the keystore. Default: false.KEYCLOAK_HTTPS_KEY_STORE_FILE
: Path to the keystore file (e.g. /opt/bitnami/keycloak/certs/keystore.jks
). No defaults.KEYCLOAK_HTTPS_TRUST_STORE_FILE
: Path to the truststore file (e.g. /opt/bitnami/keycloak/certs/truststore.jks
). No defaults.KEYCLOAK_HTTPS_KEY_STORE_PASSWORD
: Password for accessing the keystore. No defaults.KEYCLOAK_HTTPS_TRUST_STORE_PASSWORD
: Password for accessing the truststore. No defaults.KEYCLOAK_HTTPS_USE_PEM
: Set to true to configure HTTPS using PEM certificates'. Default: false.KEYCLOAK_HTTPS_CERTIFICATE_FILE
: Path to the PEM certificate file (e.g. /opt/bitnami/keycloak/certs/tls.crt
). No defaults.KEYCLOAK_HTTPS_CERTIFICATE_KEY_FILE
: Path to the PEM key file (e.g. /opt/bitnami/keycloak/certs/tls.key
). No defaults.The Bitnami Keycloak Docker image supports configuring a truststore for HTTP/TLS connection with Keycloak SPIs.
KEYCLOAK_SPI_TRUSTSTORE_FILE
: Path to the Keycloak SPI truststore file (e.g. /opt/bitnami/keycloak/certs-spi/truststore.jks
). No defaults.KEYCLOAK_SPI_TRUSTSTORE_PASSWORD
: Password for decrypting the SPI truststore file. No defaults.KEYCLOAK_SPI_TRUSTSTORE_FILE_HOSTNAME_VERIFICATION_POLICY
: Hostname verification policy for SPI connection over HTTPS/TLSIn order to add new themes to Keycloak, you can mount them to the /opt/bitnami/keycloak/themes
folder. The example below mounts a new theme.
version: '2'
services:
postgresql:
image: docker.io/bitnami/postgresql:latest
environment:
- ALLOW_EMPTY_PASSWORD=yes
- POSTGRESQL_USERNAME=bn_keycloak
- POSTGRESQL_DATABASE=bitnami_keycloak
volumes:
- 'postgresql_data:/bitnami/postgresql'
keycloak:
image: docker.io/bitnami/keycloak:latest
ports:
- "80:8080"
environment:
- KEYCLOAK_CREATE_ADMIN_USER=true
depends_on:
- postgresql
volumes:
- './mynewtheme:/opt/bitnami/keycloak/themes/mynewtheme'
volumes:
postgresql_data:
driver: local
The Bitnami Keycloak container can activate different set of statistics (database, jgroups and http) by setting the environment variable KEYCLOAK_ENABLE_STATISTICS=true
.
The Bitnami Keycloak container can activate several endpoints providing information about the health of Keycloak, by setting the environment variable KEYCLOAK_ENABLE_HEALTH_ENDPOINTS=true
.
See the official documentation for more information about these endpoints.
The image looks for configuration files in the /bitnami/keycloak/conf/
directory, this directory can be changed by setting the KEYCLOAK_MOUNTED_CONF_DIR
environment variable.
docker run --name keycloak \
-v /path/to/keycloak.conf:/bitnami/keycloak/conf/keycloak.conf \
bitnami/keycloak:latest
Or with docker-compose
keycloak:
image: bitnami/keycloak:latest
volumes:
- /path/to/keycloak.conf:/bitnami/keycloak/conf/keycloak.conf:ro
After that, your changes will be taken into account in the server's behaviour.
KEYCLOAK_ENABLE_TLS
was renamed as KEYCLOAK_ENABLE_HTTPS
.KEYCLOAK_TLS_KEYSTORE_FILE
was renamed as KEYCLOAK_TLS_KEY_STORE_FILE
.KEYCLOAK_TLS_TRUSTSTORE_FILE
was renamed as KEYCLOAK_TLS_TRUST_STORE_FILE
.KEYCLOAK_TLS_KEYSTORE_PASSWORD
was renamed as KEYCLOAK_TLS_KEY_STORE_PASSWORD
.KEYCLOAK_TLS_TRUSTSTORE_PASSWORD
was renamed as KEYCLOAK_TLS_TRUST_STORE_PASSWORD
.Keycloak 17 is powered by Quarkus and to deploy it in production mode it is necessary to set up TLS.
To do this you need to set KEYCLOAK_PRODUCTION
to true and configure TLS
docker-compose.yaml
Please be aware this file has not undergone internal testing. Consequently, we advise its use exclusively for development or testing purposes. For production-ready deployments, we highly recommend utilizing its associated Bitnami Helm chart.
If you detect any issue in the docker-compose.yaml
file, feel free to report it or contribute with a fix by following our Contributing Guidelines.
We'd love for you to contribute to this container. You can request new features by creating an issue or submitting a pull request with your contribution.
If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to fill the issue template.
Copyright © 2025 Broadcom. The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.