ディレクトリ構造

インストールルート配下のディレクトリの目的を理解する

インストール場所

zipファイルからインストールする場合、デフォルトではkeycloak-26.2.0というインストールルートディレクトリが作成され、これはファイルシステム上の任意の場所に作成できます。

/opt/keycloakは、コンテナ内でKeycloakを実行するDockerPodmanKubernetesOpenShiftを含む、Keycloakのすべてのコンテナ化された使用法において、サーバーのルートインストール場所です。

ドキュメントの残りの部分では、相対パスはインストールルートからの相対パスとして理解されます。たとえば、conf/file.xml<install root>/conf/file.xmlを意味します。

ディレクトリ構造

Keycloakのインストールルートには、多数のフォルダが存在します。

  • bin/ - kc.sh|batkcadm.sh|batkcreg.sh|batを含む、サーバーのすべてのシェルスクリプトが含まれています

    • client/ - 内部的に使用されます

  • conf/ - keycloak.confを含む、構成ファイルに使用されるディレクトリ - Keycloakの設定を参照してください。構成ファイルを指定するための多くのオプションは、このディレクトリからの相対パスを想定しています。

  • data/ - トランザクションログなど、サーバーがランタイム情報を保存するためのディレクトリ

    • logs/ - ファイルロギングのデフォルトディレクトリ - ロギングの設定を参照してください

  • lib/ - 内部的に使用されます

  • providers/ - ユーザーが提供する依存関係のディレクトリ - サーバーを拡張するためのプロバイダーの設定、およびJDBCドライバーを追加する例についてはデータベースの設定を参照してください。

  • themes/ - 管理コンソールのカスタマイズのためのディレクトリ - テーマの開発を参照してください

このページでは