en
Guides
Server
Directory Structure
en›Guides›Server›Directory Structure

Directory Structure

Installation Locations

If you are installing from a zip file then by default there will be an install root directory of keycloak-26.6.0, 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 NQRust-IdentityDocker, Podman, Kubernetes, and OpenShift.

In the rest of the documentation, relative paths are understood to be relative to the install root - for example, conf/file.xml means <install root>/conf/file.xml

Directory Structure

Under the NQRust-Identity 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 NQRust-Identity. Many options for specifying a configuration file expect paths relative to this directory.

    • truststores/ - default path used by the truststore-paths option

  • 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 adding a JDBC driver.

  • themes/ - directory for customizations to the Admin Console

Bootstrapping and recovering an admin accountConfiguring TLS