5.8. 相关选项

db 🛠

数据库供应商。

在 production 模式中，dev-file 的默认值已弃用，您应该明确指定 db。

CLI: -- db
Env: KC_DB

dev-file (default), dev-mem,mariadb,mssql,mysql,oracle,postgres,tidb

db-password

数据库用户的密码。

CLI: --db-password
Env: KC_DB_PASSWORD

db-url

完整的数据库 JDBC URL。

如果没有提供，则会根据所选数据库供应商设置默认 URL。例如，如果使用 postgres，默认的 JDBC URL 为 jdbc:postgresql://localhost/keycloak。

CLI: --db-url
Env: KC_DB_URL

db-username

数据库用户的用户名。

CLI: --db-username
Env: KC_DB_USERNAME

功能

启用一个或多个功能的集合。

CLI: -- features
Env: 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[:v 1] , client-secret-rotation[:v 1] , client-types[:v 1] , clusterless[:v 1] , db-tidb[:v 1] , declarative-ui[:v 1] , device-flow[:v 1] , docker[:v 1] , dpop[:v 1] , dynamic-scopes[: v1] , fips[: v1] , hostname[: v2] , impersonation[: v1] , instagram-broker[: v1] , ipa-tuura-federation[: v1] , kerberos[: v1] , log-mdc[: v1] , login[:v 2,v 1] , logout-all-sessions[:v 1] , multi-site[:v1] , oid4vc-vci[:v1] , opentelemetry[:v 1] , organization[:v 1] , par[:v 1] , passkeys-conditional-ui-authenticator[:v 1] , passkeys [: v1] , persistent-user-sessions [: v 1], preview , quick-theme [: v1] , recovery-codes [: v1] , resource-lifecycle [: v1] , rolling-updates[: v1, v2] , scripts [:v 1] , 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]

hostname

服务器所公开的地址。

可以是完整的 URL，也可以是主机名。当只提供主机名时，会从请求解析端口和上下文路径。

CLI: -- hostname
Env: KC_HOSTNAME

仅在启用 hostname:v2 功能时才可用

https-key-store-file

保存证书信息的密钥存储，而不是指定单独的文件。

CLI: --https-key-store-file
Env: KC_HTTPS_KEY_STORE_FILE

https-key-store-password

密钥存储文件的密码。

CLI: --https-key-store-password
Env: KC_HTTPS_KEY_STORE_PASSWORD

密码 （默认）

health-enabled 🛠

如果服务器应该公开健康检查端点。

如果启用，健康检查位于 /health、 /health /ready 和 /health/live 端点上。

CLI: --health-enabled
Env: KC_HEALTH_ENABLED

true,false （默认）

metrics-enabled 🛠

如果服务器应该公开指标。

如果启用，则指标位于 /metrics 端点。

CLI: --metrics-enabled
Env: KC_METRICS_ENABLED

true,false （默认）