5.8. 関連するオプション

db 🛠

データベースベンダー

実稼働モードでは、dev-file のデフォルト値は非推奨であるため、代わりに db を明示的に指定する必要があります。

名前付きキー: db-kind-<datasource> 🛠

CLI: --db
環境変数: KC_DB

dev-file (デフォルト), dev-mem, mariadb, mssql, mysql, oracle, postgres, tidb

db-password

データベースユーザーアカウントのパスワード

名前付きキー: db-password-<datasource>

CLI: --db-password
環境変数: KC_DB_PASSWORD

db-url

データベースの完全な JDBC URL

指定しない場合、選択したデータベースベンダーに基づきデフォルト URL が設定されます。たとえば、postgres を使用している場合、デフォルトの JDBC URL は jdbc:postgresql://localhost/keycloak になります。

名前付きキー: db-url-full-<datasource>

CLI: --db-url
環境変数: KC_DB_URL

db-username

データベースユーザーのユーザー名

名前付きキー: db-username-<datasource>

CLI: --db-username
環境変数: KC_DB_USERNAME

features 🛠

1 つ以上の機能セットを有効にします。

CLI: --features
環境変数: KC_FEATURES

account-api[:v1], account[:v3], admin-api[:v1], admin-fine-grained-authz[:v1,v2], admin[:v2], authorization[:v1], ciba[:v1], client-auth-federated[:v1], client-policies[:v1], client-secret-rotation[:v1], client-types[:v1], clusterless[:v1], db-tidb[:v1], declarative-ui[:v1], device-flow[:v1], docker[:v1], dpop[:v1], dynamic-scopes[:v1], fips[:v1], hostname[:v2], impersonation[:v1], instagram-broker[:v1], ipa-tuura-federation[:v1], kerberos[:v1], kubernetes-service-accounts[:v1], log-mdc[:v1], login[:v2,v1], logout-all-sessions[:v1], multi-site[:v1], oid4vc-vci[:v1], opentelemetry[:v1], organization[:v1], par[:v1], passkeys-conditional-ui-authenticator[:v1], passkeys[:v1], persistent-user-sessions[:v1], preview, quick-theme[:v1], recovery-codes[:v1], rolling-updates[:v1,v2], scripts[:v1], spiffe[:v1], step-up-authentication[:v1], token-exchange-external-internal[:v2], token-exchange-standard[:v2], token-exchange[:v1], transient-users[:v1], update-email[:v1], user-event-metrics[:v1], web-authn[:v1], workflows[:v1]

hostname

サーバーが公開されているアドレス。

完全な URL またはホスト名のみを指定できます。ホスト名のみが指定されている場合、スキーム、ポート、コンテキストパスはリクエストから解決されます。

CLI: --hostname
環境変数: KC_HOSTNAME

ホスト名:v2 機能が有効な場合にのみ使用可能です。

https-key-store-file

個別のファイルを指定する代わりに、証明書情報を保持するキーストア。

CLI: --https-key-store-file
環境変数: KC_HTTPS_KEY_STORE_FILE

https-key-store-password

キーストアファイルのパスワード

CLI: --https-key-store-password
環境変数: KC_HTTPS_KEY_STORE_PASSWORD

password (デフォルト)

health-enabled 🛠

サーバーがヘルスチェックエンドポイントを公開する必要があるかどうか。

有効にすると、/health、/health/ready、および /health/live エンドポイントでヘルスチェックが利用可能になります。

CLI: --health-enabled
環境変数: KC_HEALTH_ENABLED

true、false (デフォルト)

metrics-enabled 🛠

サーバーがメトリクスを公開する必要があるかどうか。

有効にすると、/metrics エンドポイントでメトリクスを利用できるようになります。

CLI: --metrics-enabled
環境変数: KC_METRICS_ENABLED

true、false (デフォルト)