Directory Structure

Understand the purpose of the directories under the installation root

Installation Locations

If you are installing from a zip file then by default there will be an install root directory of keycloak-26.0.1, which can be created anywhere you choose on your filesystem.

/opt/keycloak is the root install location for the server in all containerized usage shown for Keycloak including Running Keycloak in a container, Docker, Podman, {links_getting-started_getting-started-kubernetes_name}, and OpenShift.

in the rest of documentation relative paths are understood to be relative to the install root - e.g. conf/file.xml means <install root>/conf/file.xml

Directory Structure

Under the Keycloak install root there exists a number of folders:

  • bin/ - contains all the shell scripts for the server, including kc.sh|bat, kcadm.sh|bat, and kcreg.sh|bat

    • client/ - used internally

  • conf/ - directory used for configuration files, including keycloak.conf - see Configuring Keycloak. Many options for specifying a configuration file expect paths relative to this directory.

  • data/ - directory for the server to store runtime information, such as transaction logs

  • lib/ - used internally

  • providers/ - directory for user provided dependencies - see Configuring providers for extending the server and Configuring the database for an example of add a JDBC driver.

  • themes/ - directory for customizations to the Admin Console - see Developing Themes

On this page