Migration

Migrating to Quarkus distribution
Migrate to the new Quarkus distribution from the legacy WildFly distribution

Getting started

Docker
Get started with Keycloak on Docker
Kubernetes
Get started with Keycloak on Kubernetes
OpenJDK
Get started with Keycloak on bare metal
OpenShift
Get started with Keycloak on OpenShift
Podman
Get started with Keycloak on Podman

Server

Using Kubernetes secrets
Learn how to use Kubernetes/OpenShift secrets in Keycloak
All configuration
Complete list of all build options and configuration for Keycloak
All provider configuration
Complete list of all the available provider configuration options
Configuring Keycloak
Understand how to configure and start Keycloak
Configuring Keycloak for production
Learn how to make Keycloak ready for production.
Configuring TLS
Learn how to configure Keycloak's https certificates for ingoing and outgoing requests as well as mTLS.
Configuring distributed caches
Understand how to configure the caching layer
Configuring logging
Learn how to configure Logging
Configuring outgoing HTTP requests
How to configure the client used for outgoing HTTP requests.
Configuring providers
Understand how to configure providers
Configuring the database
An overview about how to configure relational databases
Configuring the hostname
Learn how to configure the frontend and backchannel endpoints exposed by Keycloak.
Configuring trusted certificates for outgoing requests
How to configure the Keycloak Truststore to communicate with external services through TLS.
Enabling Keycloak Health checks
Learn how to enable and use Keycloak health checks
Enabling Keycloak Metrics
Learn how to enable and expose metrics from the server
Enabling and disabling features
Understand how to configure Keycloak to use optional features
FIPS 140-2 support
How to configure Keycloak server for FIPS compliance
Importing and Exporting Realms
An overview about how to import and export realms
Running Keycloak in a container
Learn how to run Keycloak from a container image
Using a reverse proxy
Learn how to configure Keycloak together with a reverse proxy, api gateway, or load balancer.

Operator

Keycloak Operator Installation
How to install the Keycloak Operator on Kubernetes and OpenShift
Basic Keycloak deployment
How to install Keycloak using the Operator on Kubernetes or OpenShift
Keycloak Realm Import
How to perform an automated Keycloak Realm Import using the operator
Advanced configuration
How to tune advanced aspects of the Keycloak CR
Using custom Keycloak images
How to customize and optimize the Keycloak Container

Securing applications

Apache APISIX external
Integrate Keycloak for Authentication with Apache APISIX
KrakenD external
Secure APIs with an API Gateway
Quarkus external
Using OpenID Connect and Keycloak to secure your Quarkus applications
WildFly external
Secure WildFly Applications with Keycloak