6.2. Keycloak Dev Services 配置

配置属性

类型

default

quarkus.keycloak.devservices.enabled

用于启用（默认）或禁用 Dev 服务的标志。启用后，Keycloak 的 Dev Services 会在 Dev 或 Test 模式中自动配置并启动 Keycloak，以及 Docker 运行时。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_ENABLED

布尔值

true

quarkus.keycloak.devservices.image-name

Dev Services 供应商的容器镜像名称。默认为基于 Quarkus 的 Keycloak 镜像。对于基于 WildFly 的发布，请使用 quay.io/keycloak/keycloak:19.0.3-legacy 等镜像。Keycloak Quarkus 和 WildFly 镜像会以不同的方式初始化。用于 Keycloak 的 dev Services 将假定它是一个 Keycloak Quarkus 镜像，除非镜像版本以 -legacy 结尾。使用 quarkus.keycloak.devservices.keycloak-x-image 覆盖。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_IMAGE_NAME

string

quay.io/keycloak/keycloak:26.1.3

quarkus.keycloak.devservices.keycloak-x-image

指明是否使用 Keycloak-X 镜像。默认情况下，镜像由镜像名称中的 keycloak-x 标识。对于自定义镜像，使用 quarkus.keycloak.devservices.keycloak-x-image 覆盖。如果默认检查正常工作，则不需要设置此属性。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_KEYCLOAK_X_IMAGE

布尔值

quarkus.keycloak.devservices.shared

确定 Keycloak 容器是否已共享。共享时，Quarkus 使用基于标签的服务发现来查找和重复使用正在运行的 Keycloak 容器，因此没有启动第二个容器。否则，如果没有找到匹配的容器，则会启动一个新容器。服务发现使用 quarkus-dev-service-label 标签，其值由 service-name 属性设置。容器共享仅以 dev 模式提供。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_SHARED

布尔值

true

quarkus.keycloak.devservices.service-name

quarkus-dev-service-keycloak 标签的值，用于标识 Keycloak 容器。用于共享模式，以查找具有此标签的现有容器。如果没有找到，则使用此标签初始化一个新容器。仅适用于 dev 模式。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_SERVICE_NAME

string

quarkus

quarkus.keycloak.devservices.realm-path

以逗号分隔的到 Keycloak 域文件的类或文件系统路径列表。此列表用于初始化 Keycloak。此列表中的第一个值用于初始化默认租户连接属性。

要了解更多有关 Keycloak 域文件的信息，请参阅 导入和导出 Keycloak Realms 文档。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_REALM_PATH

字符串列表

quarkus.keycloak.devservices.resource-aliases."alias-name"

用于初始化 Keycloak 的额外类或文件系统资源的别名。每个映射条目代表别名和类或文件系统资源路径之间的映射。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_ALIASES__ALIAS_NAME_

Map<String,String>

quarkus.keycloak.devservices.resource-mappings."resource-name"

用于初始化 Keycloak 的其他类或文件系统资源。每个映射条目代表类或文件系统资源路径别名和 Keycloak 容器位置之间的映射。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_RESOURCE_MAPPINGS_RESOURCE_NAME_

Map<String,String>

quarkus.keycloak.devservices.java-opts

传递给 keycloak JVM 的 JAVA_OPTS

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_JAVA_OPTS

string

quarkus.keycloak.devservices.show-logs

显示带有 "Keycloak:" 前缀的 Keycloak 日志消息。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_SHOW_LOGS

布尔值

false

quarkus.keycloak.devservices.start-command

Keycloak start 命令。使用此属性试验 Keycloak 启动选项，请参阅 https://www.keycloak.org/server/all-config。请注意，在载入旧的 Keycloak WildFly 镜像时会忽略它。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_START_COMMAND

string

quarkus.keycloak.devservices.features

Keycloak 功能。使用此属性启用一个或多个实验性 Keycloak 功能。请注意，如果您还必须自定义 Keycloak start-command （），您可以使用 a- features 选项作为 start 命令序列的一部分，而不是配置此属性。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_FEATURES

字符串列表

quarkus.keycloak.devservices.realm-name

Keycloak 域的名称。如果 realm-path 属性指向的域，则此属性用于创建域。在本例中，默认值为 quarkus。建议始终设置此属性，以便 Keycloak 的 Dev Services 可以识别域名称，而无需解析域文件。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_REALM_NAME

string

quarkus.keycloak.devservices.create-realm

指定是否在 realm-path 上找不到域文件时创建 Keycloak 域。如果要使用 Keycloak 管理控制台或 io.quarkus.test.common.QuarkusTestResourceLifecycleManager 提供的 Keycloak Admin API 创建域，则设置为 false。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_REALM

布尔值

true

quarkus.keycloak.devservices.create-client

指定是否使用 secret secret 创建默认客户端 id quarkus-app，并在 create-realm 属性设为 true 时注册它们。对于 OIDC 扩展配置属性 quarkus.oidc.client.id 和 quarkus.oidc.credentials.secret。对于 OIDC 客户端扩展配置属性 quarkus.oidc-client.client.id 和 quarkus.oidc-client.credentials.secret。如果必须使用 Keycloak 管理控制台或由 io.quarkus.test.common.QuarkusTestResourceLifecycleManager 提供的 Keycloak Admin API 创建客户端，则设置为 false。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_CREATE_CLIENT

布尔值

true

quarkus.keycloak.devservices.start-with-disabled-tenant

指定是否启动容器，即使禁用了默认的 OIDC 租户。在多租户 OIDC 设置中可能需要将此属性设置为 true，特别是在动态创建 OIDC 租户时。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_START_WITH_DISABLED_TENANT

布尔值

false

quarkus.keycloak.devservices.users."users"

Keycloak 用户名与密码映射。如果为空，则创建默认用户 alice 和 bob，其名称用作密码。当 realm-path 没有找到 realm 文件时，这个映射用于用户创建。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_USERS_USERS_

Map<String,String>

quarkus.keycloak.devservices.roles."role-name"

Keycloak 用户的角色映射。如果为空，则分配默认角色： alice 接收 admin 和 用户角色，而其他用户则收到 用户角色。当 realm-path 没有找到 realm 文件时，此映射用于创建角色。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_ROLES_ROLE_NAME_

Map<String,List<String>>

quarkus.keycloak.devservices.port

要侦听的 dev 服务的具体端口。

如果没有指定，则会选择一个随机端口。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_PORT

int

quarkus.keycloak.devservices.container-env."environment-variable-name"

要传递给容器的环境变量。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_ENV__ENVIRONMENT_VARIABLE_NAME_

Map<String,String>

quarkus.keycloak.devservices.container-memory-limit

Keycloak 容器的内存限值

如果没有指定，1250MiB 是默认的内存限值。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_CONTAINER_MEMORY_LIMIT

MemorySize 

1250M

quarkus.keycloak.devservices.web-client-timeout

WebClient 超时。使用此属性配置 OIDC dev service admin 客户端在使用的 HTTP 客户端在获取 admin 令牌并创建域时等待来自 OpenId Connect Provider 的响应的时长。

环境变量： QUARKUS_KEYCLOAK_DEVSERVICES_WEB_CLIENT_TIMEOUT

duration 

4S