所有配置

Keycloak 的所有建置選項和配置的完整列表

快取

值

cache

定義高可用性的快取機制。

預設情況下，在生產模式中，使用 ispn 快取在多個伺服器節點之間建立叢集。預設情況下，在開發模式中，local 快取會停用叢集，並且適用於開發和測試目的。

CLI: --cache
Env: KC_CACHE

ispn (預設), local

cache-config-file

定義應從中載入快取設定的檔案。

設定檔相對於 conf/ 目錄。

CLI: --cache-config-file
Env: KC_CACHE_CONFIG_FILE

cache-embedded-authorization-max-count

授權快取可在記憶體中儲存的最大條目數。

CLI: --cache-embedded-authorization-max-count
Env: KC_CACHE_EMBEDDED_AUTHORIZATION_MAX_COUNT

cache-embedded-client-sessions-max-count

clientSessions 快取可在記憶體中儲存的最大條目數。

CLI: --cache-embedded-client-sessions-max-count
Env: KC_CACHE_EMBEDDED_CLIENT_SESSIONS_MAX_COUNT

僅在設定內嵌 Infinispan 叢集時可用

cache-embedded-keys-max-count

keys 快取可在記憶體中儲存的最大條目數。

CLI: --cache-embedded-keys-max-count
Env: KC_CACHE_EMBEDDED_KEYS_MAX_COUNT

cache-embedded-mtls-enabled

加密 Keycloak 伺服器之間的網路通訊。

CLI: --cache-embedded-mtls-enabled
Env: KC_CACHE_EMBEDDED_MTLS_ENABLED

true, false (預設)

cache-embedded-mtls-key-store-file

金鑰儲存檔案路徑。

金鑰儲存必須包含 TLS 協定要使用的憑證。 預設情況下，它會查找 conf/ 目錄下的 cache-mtls-keystore.p12。

CLI: --cache-embedded-mtls-key-store-file
Env: KC_CACHE_EMBEDDED_MTLS_KEY_STORE_FILE

cache-embedded-mtls-key-store-password

存取金鑰儲存的密碼。

CLI: --cache-embedded-mtls-key-store-password
Env: KC_CACHE_EMBEDDED_MTLS_KEY_STORE_PASSWORD

cache-embedded-mtls-trust-store-file

信任儲存檔案路徑。

它應包含受信任的憑證或簽署憑證的憑證授權單位。 預設情況下，它會查找 conf/ 目錄下的 cache-mtls-truststore.p12。

CLI: --cache-embedded-mtls-trust-store-file
Env: KC_CACHE_EMBEDDED_MTLS_TRUST_STORE_FILE

cache-embedded-mtls-trust-store-password

存取信任儲存的密碼。

CLI: --cache-embedded-mtls-trust-store-password
Env: KC_CACHE_EMBEDDED_MTLS_TRUST_STORE_PASSWORD

cache-embedded-offline-client-sessions-max-count

offlineClientSessions 快取可在記憶體中儲存的最大條目數。

CLI: --cache-embedded-offline-client-sessions-max-count
Env: KC_CACHE_EMBEDDED_OFFLINE_CLIENT_SESSIONS_MAX_COUNT

僅在設定內嵌 Infinispan 叢集時可用

cache-embedded-offline-sessions-max-count

offlineSessions 快取可在記憶體中儲存的最大條目數。

CLI: --cache-embedded-offline-sessions-max-count
Env: KC_CACHE_EMBEDDED_OFFLINE_SESSIONS_MAX_COUNT

僅在設定內嵌 Infinispan 叢集時可用

cache-embedded-realms-max-count

realms 快取可在記憶體中儲存的最大條目數。

CLI: --cache-embedded-realms-max-count
Env: KC_CACHE_EMBEDDED_REALMS_MAX_COUNT

cache-embedded-sessions-max-count

sessions 快取可在記憶體中儲存的最大條目數。

CLI: --cache-embedded-sessions-max-count
Env: KC_CACHE_EMBEDDED_SESSIONS_MAX_COUNT

僅在設定內嵌 Infinispan 叢集時可用

cache-embedded-users-max-count

users 快取可在記憶體中儲存的最大條目數。

CLI: --cache-embedded-users-max-count
Env: KC_CACHE_EMBEDDED_USERS_MAX_COUNT

cache-metrics-histograms-enabled

啟用內嵌快取的指標的直方圖。

CLI: --cache-metrics-histograms-enabled
Env: KC_CACHE_METRICS_HISTOGRAMS_ENABLED

僅在啟用指標時可用

true, false (預設)

cache-remote-host

遠端儲存設定的遠端伺服器主機名稱。

它會取代透過 XML 檔案指定的組態的 remote-server 標籤的 host 屬性 (請參閱 cache-config-file 選項)。 如果指定了此選項，則也需要 cache-remote-username 和 cache-remote-password，並且 XML 檔案中不應存在相關的組態。

CLI: --cache-remote-host
Env: KC_CACHE_REMOTE_HOST

cache-remote-password

用於遠端儲存的遠端伺服器驗證的密碼。

它會取代透過 XML 檔案指定的組態的 digest 標籤的 password 屬性 (請參閱 cache-config-file 選項)。 如果指定了此選項，則也需要 cache-remote-username，並且 XML 檔案中不應存在相關的組態。

CLI: --cache-remote-password
Env: KC_CACHE_REMOTE_PASSWORD

僅在設定遠端主機時可用

cache-remote-port

遠端儲存設定的遠端伺服器連接埠。

它會取代透過 XML 檔案指定的組態的 remote-server 標籤的 port 屬性 (請參閱 cache-config-file 選項)。

CLI: --cache-remote-port
Env: KC_CACHE_REMOTE_PORT

僅在設定遠端主機時可用

11222 (預設)

cache-remote-tls-enabled

啟用 TLS 支援以與安全的遠端 Infinispan 伺服器通訊。

建議在生產環境中啟用。

CLI: --cache-remote-tls-enabled
Env: KC_CACHE_REMOTE_TLS_ENABLED

僅在設定遠端主機時可用

true (預設), false

cache-remote-username

用於遠端儲存的遠端伺服器驗證的使用者名稱。

它會取代透過 XML 檔案指定的組態的 digest 標籤的 username 屬性 (請參閱 cache-config-file 選項)。 如果指定了此選項，則也需要 cache-remote-password，並且 XML 檔案中不應存在相關的組態。

CLI: --cache-remote-username
Env: KC_CACHE_REMOTE_USERNAME

僅在設定遠端主機時可用

cache-stack

定義用於叢集通訊和節點探索的預設堆疊。

只有在 cache 設定為 ispn 時，此選項才會生效。預設值：udp。

CLI: --cache-stack
Env: KC_CACHE_STACK

tcp、udp、kubernetes、ec2、azure、google 或任何

設定

值

config-keystore

指定金鑰儲存組態來源的路徑。

CLI: --config-keystore
Env: KC_CONFIG_KEYSTORE

config-keystore-password

指定金鑰儲存組態來源的密碼。

CLI: --config-keystore-password
Env: KC_CONFIG_KEYSTORE_PASSWORD

config-keystore-type

指定金鑰儲存組態來源的類型。

CLI: --config-keystore-type
Env: KC_CONFIG_KEYSTORE_TYPE

PKCS12 (預設)

資料庫

值

db

資料庫廠商。

CLI: --db
Env: KC_DB

dev-file (預設), dev-mem, mariadb, mssql, mysql, oracle, postgres

db-driver

JDBC 驅動程式的完整限定類別名稱。

如果未設定，則會根據選擇的資料庫設定預設驅動程式。

CLI: --db-driver
Env: KC_DB_DRIVER

db-password

資料庫使用者的密碼。

CLI: --db-password
Env: KC_DB_PASSWORD

db-pool-initial-size

連線集區的初始大小。

CLI: --db-pool-initial-size
Env: KC_DB_POOL_INITIAL_SIZE

db-pool-max-size

連線集區的最大大小。

CLI: --db-pool-max-size
Env: KC_DB_POOL_MAX_SIZE

100 (預設)

db-pool-min-size

連線集區的最小大小。

CLI: --db-pool-min-size
Env: KC_DB_POOL_MIN_SIZE

db-schema

要使用的資料庫結構描述。

CLI: --db-schema
Env: KC_DB_SCHEMA

db-url

完整的資料庫 JDBC URL。

如果未提供，則會根據選取的資料庫廠商設定預設 URL。 例如，如果使用 postgres，預設 JDBC URL 將為 jdbc:postgresql://127.0.0.1/keycloak。

CLI: --db-url
Env: KC_DB_URL

db-url-database

設定所選廠商的預設 JDBC URL 的資料庫名稱。

如果設定了 db-url 選項，則會忽略此選項。

CLI: --db-url-database
Env: KC_DB_URL_DATABASE

db-url-host

設定所選廠商的預設 JDBC URL 的主機名稱。

如果設定了 db-url 選項，則會忽略此選項。

CLI: --db-url-host
Env: KC_DB_URL_HOST

db-url-port

設定所選廠商的預設 JDBC URL 的連接埠。

如果設定了 db-url 選項，則會忽略此選項。

CLI: --db-url-port
Env: KC_DB_URL_PORT

db-url-properties

設定所選廠商的預設 JDBC URL 的屬性。

請確保根據資料庫廠商期望的格式設定屬性，並在此屬性值的開頭附加正確的字元。 如果設定了 db-url 選項，則會忽略此選項。

CLI: --db-url-properties
Env: KC_DB_URL_PROPERTIES

db-username

資料庫使用者的使用者名稱。

CLI: --db-username
Env: KC_DB_USERNAME

交易

值

transaction-xa-enabled

如果設定為 true，將會使用 XA 資料來源。

CLI: --transaction-xa-enabled
Env: KC_TRANSACTION_XA_ENABLED

true, false (預設)

功能

值

features

啟用一組或多個功能。

CLI: --features
Env: KC_FEATURES

account-api[:v1]、account[:v3]、admin-api[:v1]、admin-fine-grained-authz[:v1]、admin[:v2]、authorization[:v1]、cache-embedded-remote-store[:v1]、ciba[:v1]、client-policies[:v1]、client-secret-rotation[:v1]、client-types[:v1]、clusterless[:v1]、declarative-ui[:v1]、device-flow[:v1]、docker[:v1]、dpop[:v1]、dynamic-scopes[:v1]、fips[:v1]、hostname[:v2]、impersonation[:v1]、kerberos[:v1]、login[:v2,v1]、multi-site[:v1]、oid4vc-vci[:v1]、opentelemetry[:v1]、organization[:v1]、par[:v1]、passkeys[:v1]、persistent-user-sessions[:v1]、preview、recovery-codes[:v1]、scripts[:v1]、step-up-authentication[:v1]、token-exchange[:v1]、transient-users[:v1]、update-email[:v1]、web-authn[:v1]

features-disabled

停用一組或多個功能。

CLI: --features-disabled
Env: KC_FEATURES_DISABLED

account, account-api, admin, admin-api, admin-fine-grained-authz, authorization, cache-embedded-remote-store, ciba, client-policies, client-secret-rotation, client-types, clusterless, declarative-ui, device-flow, docker, dpop, dynamic-scopes, fips, impersonation, kerberos, login, multi-site, oid4vc-vci, opentelemetry, organization, par, passkeys, persistent-user-sessions, preview, recovery-codes, scripts, step-up-authentication, token-exchange, transient-users, update-email, web-authn

主機名稱 v2

值

主機名稱

伺服器公開的位址。

可以是完整的 URL，或僅是主機名稱。當僅提供主機名稱時，方案、埠和上下文路徑會從請求中解析。

CLI: --hostname
Env: KC_HOSTNAME

僅當啟用 hostname:v2 功能時才可用

hostname-admin

用於存取管理控制台的位址。

如果您使用反向代理在與 hostname 選項中指定的不同位址上公開管理控制台，請使用此選項。

CLI: --hostname-admin
Env: KC_HOSTNAME_ADMIN

僅當啟用 hostname:v2 功能時才可用

hostname-backchannel-dynamic

啟用後端通道 URL 的動態解析，包括主機名稱、方案、埠和上下文路徑。

如果您的應用程式透過私有網路存取 Keycloak，請設定為 true。如果設定為 true，則 hostname 選項需要指定為完整 URL。

CLI: --hostname-backchannel-dynamic
Env: KC_HOSTNAME_BACKCHANNEL_DYNAMIC

僅當啟用 hostname:v2 功能時才可用

true, false (預設)

hostname-debug

切換主機名稱偵錯頁面，該頁面可在 /realms/master/hostname-debug 存取。

CLI: --hostname-debug
Env: KC_HOSTNAME_DEBUG

僅當啟用 hostname:v2 功能時才可用

true, false (預設)

hostname-strict

停用從請求標頭動態解析主機名稱。

除非您的反向代理覆寫 Host 標頭，否則在生產環境中應始終設定為 true。如果啟用，則需要指定 hostname 選項。

CLI: --hostname-strict
Env: KC_HOSTNAME_STRICT

僅當啟用 hostname:v2 功能時才可用

true (預設), false

HTTP(S)

值

http-enabled

啟用 HTTP 接聽器。

CLI: --http-enabled
Env: KC_HTTP_ENABLED

true, false (預設)

http-host

使用的 HTTP 主機。

CLI: --http-host
Env: KC_HTTP_HOST

0.0.0.0 (預設)

http-max-queued-requests

佇列 HTTP 請求的最大數量。

使用此選項可在超載情況下減少負載。多餘的請求將返回「503 伺服器無法使用」回應。

CLI: --http-max-queued-requests
Env: KC_HTTP_MAX_QUEUED_REQUESTS

http-metrics-histograms-enabled

啟用具有 HTTP 伺服器請求持續時間預設儲存區的直方圖。

CLI: --http-metrics-histograms-enabled
Env: KC_HTTP_METRICS_HISTOGRAMS_ENABLED

僅在啟用指標時可用

true, false (預設)

http-metrics-slos

HTTP 伺服器請求的服務水準目標。

使用此選項代替預設直方圖，或組合使用以新增其他儲存區。指定以逗號分隔的毫秒值列表。從 5 毫秒到 10 秒的儲存區範例：5,10,25,50,250,500,1000,2500,5000,10000

CLI: --http-metrics-slos
Env: KC_HTTP_METRICS_SLOS

僅在啟用指標時可用

http-pool-max-threads

最大執行緒數。

如果未指定，則會自動調整為可用處理器數量 * 4 和 50 中的較大值。例如，如果有 4 個處理器，則最大執行緒數為 50。如果有 48 個處理器，則最大執行緒數為 192。

CLI: --http-pool-max-threads
Env: KC_HTTP_POOL_MAX_THREADS

http-port

使用的 HTTP 埠。

CLI: --http-port
Env: KC_HTTP_PORT

8080 (預設)

http-relative-path

設定相對於 / 的路徑以提供資源。

路徑必須以 / 開頭。

CLI: --http-relative-path
Env: KC_HTTP_RELATIVE_PATH

/ (預設)

https-certificate-file

伺服器憑證或 PEM 格式憑證鏈的檔案路徑。

CLI: --https-certificate-file
Env: KC_HTTPS_CERTIFICATE_FILE

https-certificate-key-file

PEM 格式私密金鑰的檔案路徑。

CLI: --https-certificate-key-file
Env: KC_HTTPS_CERTIFICATE_KEY_FILE

https-certificates-reload-period

重新載入金鑰儲存、信任儲存和 https-* 選項所引用憑證檔案的間隔。

可以是 java.time.Duration 值、整數秒數，或後面跟著 [ms, h, m, s, d] 其中之一的整數。必須大於 30 秒。使用 -1 停用。

CLI: --https-certificates-reload-period
Env: KC_HTTPS_CERTIFICATES_RELOAD_PERIOD

1h (預設)

https-cipher-suites

要使用的密碼套件。

如果未提供，則會選擇合理的預設值。

CLI: --https-cipher-suites
Env: KC_HTTPS_CIPHER_SUITES

https-client-auth

設定伺服器要求/請求用戶端驗證。

CLI: --https-client-auth
Env: KC_HTTPS_CLIENT_AUTH

none (預設), request, required

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

password (預設)

https-key-store-type

金鑰儲存檔案的類型。

如果未提供，則會根據檔案副檔名自動偵測類型。如果 fips-mode 設定為 strict 且未設定值，則預設為 BCFKS。

CLI: --https-key-store-type
Env: KC_HTTPS_KEY_STORE_TYPE

https-port

使用的 HTTPS 埠。

CLI: --https-port
Env: KC_HTTPS_PORT

8443 (預設)

https-protocols

要明確啟用的協定列表。

CLI: --https-protocols
Env: KC_HTTPS_PROTOCOLS

[TLSv1.3,TLSv1.2] (預設)

https-trust-store-file

保存要信任的憑證的憑證資訊的信任儲存。

CLI: --https-trust-store-file
Env: KC_HTTPS_TRUST_STORE_FILE

https-trust-store-password

信任儲存檔案的密碼。

CLI: --https-trust-store-password
Env: KC_HTTPS_TRUST_STORE_PASSWORD

https-trust-store-type

信任儲存檔案的類型。

如果未提供，則會根據檔案副檔名自動偵測類型。如果 fips-mode 設定為 strict 且未設定值，則預設為 BCFKS。

CLI: --https-trust-store-type
Env: KC_HTTPS_TRUST_STORE_TYPE

健康狀態

值

health-enabled

伺服器是否應公開健康檢查端點。

如果啟用，健康檢查可在 /health、/health/ready 和 /health/live 端點使用。

CLI: --health-enabled
Env: KC_HEALTH_ENABLED

true, false (預設)

管理

值

http-management-port

管理介面的埠。

僅當管理介面上公開某些內容時才相關 - 請參閱指南了解詳細資訊。

CLI: --http-management-port
Env: KC_HTTP_MANAGEMENT_PORT

9000 (預設)

http-management-relative-path

設定相對於 / 的路徑，以從管理介面提供資源。

路徑必須以 / 開頭。如果未提供，則值會從 HTTP 選項繼承。僅當管理介面上公開某些內容時才相關 - 請參閱指南了解詳細資訊。

CLI: --http-management-relative-path
Env: KC_HTTP_MANAGEMENT_RELATIVE_PATH

/ (預設)

https-management-certificate-file

管理伺服器的伺服器憑證或 PEM 格式憑證鏈的檔案路徑。

如果未提供，則值會從 HTTP 選項繼承。僅當管理介面上公開某些內容時才相關 - 請參閱指南了解詳細資訊。

CLI: --https-management-certificate-file
Env: KC_HTTPS_MANAGEMENT_CERTIFICATE_FILE

https-management-certificate-key-file

管理伺服器的 PEM 格式私密金鑰的檔案路徑。

如果未提供，則值會從 HTTP 選項繼承。僅當管理介面上公開某些內容時才相關 - 請參閱指南了解詳細資訊。

CLI: --https-management-certificate-key-file
Env: KC_HTTPS_MANAGEMENT_CERTIFICATE_KEY_FILE

https-management-client-auth

設定管理介面要求/請求用戶端驗證。

如果未提供，則值會從 HTTP 選項繼承。僅當管理介面上公開某些內容時才相關 - 請參閱指南了解詳細資訊。

CLI: --https-management-client-auth
Env: KC_HTTPS_MANAGEMENT_CLIENT_AUTH

none (預設), request, required

https-management-key-store-file

保存憑證資訊的金鑰儲存，而不是為管理伺服器指定單獨的檔案。

如果未提供，則值會從 HTTP 選項繼承。僅當管理介面上公開某些內容時才相關 - 請參閱指南了解詳細資訊。

CLI: --https-management-key-store-file
Env: KC_HTTPS_MANAGEMENT_KEY_STORE_FILE

https-management-key-store-password

管理伺服器金鑰儲存檔案的密碼。

如果未提供，則值會從 HTTP 選項繼承。僅當管理介面上公開某些內容時才相關 - 請參閱指南了解詳細資訊。

CLI: --https-management-key-store-password
Env: KC_HTTPS_MANAGEMENT_KEY_STORE_PASSWORD

password (預設)

legacy-observability-interface

如果指標/健康狀態端點應在主要 HTTP 伺服器上公開（不建議）。

如果設定為 true，則會停用管理介面。

CLI: --legacy-observability-interface
Env: KC_LEGACY_OBSERVABILITY_INTERFACE

已過時。

true, false (預設)

指標

值

metrics-enabled

伺服器是否應公開指標。

如果啟用，指標可在 /metrics 端點使用。

CLI: --metrics-enabled
Env: KC_METRICS_ENABLED

true, false (預設)

Proxy

值

proxy-headers

伺服器應接受的 Proxy 標頭。

錯誤的組態可能會使伺服器暴露於安全性漏洞。優先於已過時的 proxy 選項。

CLI: --proxy-headers
Env: KC_PROXY_HEADERS

forwarded, xforwarded

proxy-protocol-enabled

伺服器是否應在使用 Proxy 時使用 HA PROXY 協定。

設定為 true 時，返回的遠端位址將是來自實際連線用戶端的位址。

CLI: --proxy-protocol-enabled
Env: KC_PROXY_PROTOCOL_ENABLED

true, false (預設)

proxy-trusted-addresses

以逗號分隔的信任 Proxy 位址列表。

如果設定，則會忽略來自其他位址的 Proxy 標頭。預設情況下，所有位址都受信任。受信任的 Proxy 位址指定為 IP 位址（IPv4 或 IPv6）或無類別網域間路由 (CIDR) 表示法。僅當設定 proxy-headers 時才可用。

CLI: --proxy-trusted-addresses
Env: KC_PROXY_TRUSTED_ADDRESSES

Vault

值

vault

啟用金鑰庫提供者。

CLI: --vault
Env: KC_VAULT

file, keystore

vault-dir

若設定此選項，則可透過讀取指定目錄內檔案的內容來取得密碼。

CLI: --vault-dir
Env: KC_VAULT_DIR

vault-file

金鑰庫檔案的路徑。

CLI: --vault-file
Env: KC_VAULT_FILE

vault-pass

金鑰庫的密碼。

CLI: --vault-pass
Env: KC_VAULT_PASS

vault-type

指定金鑰庫檔案的類型。

CLI: --vault-type
Env: KC_VAULT_TYPE

PKCS12 (預設)

記錄

值

log

啟用一個或多個以逗號分隔的日誌處理程式。

CLI: --log
Env: KC_LOG

console, file, syslog

log-console-color

啟用或停用記錄到主控台時的顏色。

CLI: --log-console-color
Env: KC_LOG_CONSOLE_COLOR

僅當主控台日誌處理程式啟用時才可用

true, false (預設)

log-console-format

非結構化主控台日誌條目的格式。

如果格式中有空格，請使用 "<format>" 來跳脫值。

CLI: --log-console-format
Env: KC_LOG_CONSOLE_FORMAT

僅當主控台日誌處理程式啟用時才可用

%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n (預設)

log-console-include-trace

在主控台日誌中包含追蹤資訊。

如果指定了 log-console-format 選項，則此選項無效。

CLI: --log-console-include-trace
Env: KC_LOG_CONSOLE_INCLUDE_TRACE

僅當主控台日誌處理程式和追蹤啟用時才可用

true (預設), false

log-console-level

設定主控台處理程式的日誌級別。

它指定在輸出中顯示的日誌的最詳細日誌級別。它會遵循 log-level 選項中指定的級別，該選項表示整個日誌系統的最大詳細程度。如需更多資訊，請查看日誌指南。

CLI: --log-console-level
Env: KC_LOG_CONSOLE_LEVEL

僅當主控台日誌處理程式啟用時才可用

off, fatal, error, warn, info, debug, trace, all (預設)

log-console-output

將日誌輸出設定為 JSON 或預設 (純文字) 非結構化日誌。

CLI: --log-console-output
Env: KC_LOG_CONSOLE_OUTPUT

僅當主控台日誌處理程式啟用時才可用

default (預設), json

log-file

設定日誌檔案的路徑和檔案名稱。

CLI: --log-file
Env: KC_LOG_FILE

僅當檔案日誌處理程式啟用時才可用

data/log/keycloak.log (預設)

log-file-format

設定檔案日誌條目的特定格式。

CLI: --log-file-format
Env: KC_LOG_FILE_FORMAT

僅當檔案日誌處理程式啟用時才可用

%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n (預設)

log-file-include-trace

在檔案日誌中包含追蹤資訊。

如果指定了 log-file-format 選項，則此選項無效。

CLI: --log-file-include-trace
Env: KC_LOG_FILE_INCLUDE_TRACE

僅當檔案日誌處理程式和追蹤啟用時才可用

true (預設), false

log-file-level

設定檔案處理程式的日誌級別。

它指定在輸出中顯示的日誌的最詳細日誌級別。它會遵循 log-level 選項中指定的級別，該選項表示整個日誌系統的最大詳細程度。如需更多資訊，請查看日誌指南。

CLI: --log-file-level
Env: KC_LOG_FILE_LEVEL

僅當檔案日誌處理程式啟用時才可用

off, fatal, error, warn, info, debug, trace, all (預設)

log-file-output

將日誌輸出設定為 JSON 或預設 (純文字) 非結構化日誌。

CLI: --log-file-output
Env: KC_LOG_FILE_OUTPUT

僅當檔案日誌處理程式啟用時才可用

default (預設), json

log-level

根類別的日誌級別，或以逗號分隔的個別類別及其級別清單。

對於根類別，您不需要指定類別。

CLI: --log-level
Env: KC_LOG_LEVEL

[info] (預設)

log-syslog-app-name

設定在 RFC5424 格式中格式化訊息時使用的應用程式名稱。

CLI: --log-syslog-app-name
Env: KC_LOG_SYSLOG_APP_NAME

僅當 Syslog 啟用時才可用

keycloak (預設)

log-syslog-endpoint

設定 Syslog 伺服器的 IP 位址和連接埠。

CLI: --log-syslog-endpoint
Env: KC_LOG_SYSLOG_ENDPOINT

僅當 Syslog 啟用時才可用

localhost:514 (預設)

log-syslog-format

設定 Syslog 條目的特定格式。

CLI: --log-syslog-format
Env: KC_LOG_SYSLOG_FORMAT

僅當 Syslog 啟用時才可用

%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n (預設)

log-syslog-include-trace

在 Syslog 中包含追蹤資訊。

如果指定了 log-syslog-format 選項，則此選項無效。

CLI: --log-syslog-include-trace
Env: KC_LOG_SYSLOG_INCLUDE_TRACE

僅當 Syslog 處理程式和追蹤啟用時才可用

true (預設), false

log-syslog-level

設定 Syslog 處理程式的日誌級別。

它指定在輸出中顯示的日誌的最詳細日誌級別。它會遵循 log-level 選項中指定的級別，該選項表示整個日誌系統的最大詳細程度。如需更多資訊，請查看日誌指南。

CLI: --log-syslog-level
Env: KC_LOG_SYSLOG_LEVEL

僅當 Syslog 啟用時才可用

off, fatal, error, warn, info, debug, trace, all (預設)

log-syslog-max-length

設定允許發送的訊息的最大長度 (以位元組為單位)。

長度包含標頭和訊息。如果未設定，當 log-syslog-type 為 rfc5424 (預設) 時，預設值為 2048；當 log-syslog-type 為 rfc3164 時，預設值為 1024。

CLI: --log-syslog-max-length
Env: KC_LOG_SYSLOG_MAX_LENGTH

僅當 Syslog 啟用時才可用

log-syslog-output

將 Syslog 輸出設定為 JSON 或預設 (純文字) 非結構化日誌。

CLI: --log-syslog-output
Env: KC_LOG_SYSLOG_OUTPUT

僅當 Syslog 啟用時才可用

default (預設), json

log-syslog-protocol

設定用於連線至 Syslog 伺服器的協定。

CLI: --log-syslog-protocol
Env: KC_LOG_SYSLOG_PROTOCOL

僅當 Syslog 啟用時才可用

tcp (預設), udp, ssl-tcp

log-syslog-type

設定用於格式化發送訊息的 Syslog 類型。

CLI: --log-syslog-type
Env: KC_LOG_SYSLOG_TYPE

僅當 Syslog 啟用時才可用

rfc5424 (預設), rfc3164

追蹤 (預覽)

值

tracing-compression

預覽：用於壓縮酬載的 OpenTelemetry 壓縮方法。

如果未設定，則會停用壓縮。

CLI: --tracing-compression
Env: KC_TRACING_COMPRESSION

僅當啟用 'opentelemetry' 功能和追蹤時才可用

gzip, none (預設)

tracing-enabled

預覽：啟用 OpenTelemetry 追蹤。

CLI: --tracing-enabled
Env: KC_TRACING_ENABLED

僅當啟用 'opentelemetry' 功能時才可用

true, false (預設)

tracing-endpoint

預覽：要連線的 OpenTelemetry 端點。

CLI: --tracing-endpoint
Env: KC_TRACING_ENDPOINT

僅當啟用 'opentelemetry' 功能和追蹤時才可用

https://127.0.0.1:4317 (預設)

tracing-jdbc-enabled

預覽：啟用 OpenTelemetry JDBC 追蹤。

CLI: --tracing-jdbc-enabled
Env: KC_TRACING_JDBC_ENABLED

僅當啟用 'opentelemetry' 功能和追蹤時才可用

true (預設), false

tracing-protocol

預覽：用於遙測資料的 OpenTelemetry 協定。

CLI: --tracing-protocol
Env: KC_TRACING_PROTOCOL

僅當啟用 'opentelemetry' 功能和追蹤時才可用

grpc (預設), http/protobuf

tracing-resource-attributes

預覽：在匯出的追蹤中呈現的 OpenTelemetry 資源屬性，用於描述遙測產生器。

值的格式為 key1=val1,key2=val2。如需更多資訊，請查看追蹤指南。

CLI: --tracing-resource-attributes
Env: KC_TRACING_RESOURCE_ATTRIBUTES

僅當啟用 'opentelemetry' 功能和追蹤時才可用

tracing-sampler-ratio

預覽：OpenTelemetry 取樣器比例。

將取樣跨度的機率。預期的雙精度值在間隔 <0,1) 中。

CLI: --tracing-sampler-ratio
Env: KC_TRACING_SAMPLER_RATIO

僅當啟用 'opentelemetry' 功能和追蹤時才可用

1.0 (預設)

tracing-sampler-type

預覽：用於追蹤的 OpenTelemetry 取樣器。

CLI: --tracing-sampler-type
Env: KC_TRACING_SAMPLER_TYPE

僅當啟用 'opentelemetry' 功能和追蹤時才可用

always_on, always_off, traceidratio (預設), parentbased_always_on, parentbased_always_off, parentbased_traceidratio

tracing-service-name

預覽：OpenTelemetry 服務名稱。

優先於 tracing-resource-attributes 屬性中定義的 service.name。

CLI: --tracing-service-name
Env: KC_TRACING_SERVICE_NAME

僅當啟用 'opentelemetry' 功能和追蹤時才可用

keycloak (預設)

信任儲存

值

tls-hostname-verifier

用於外寄 HTTPS 和 SMTP 請求的 TLS 主機名稱驗證原則。

CLI: --tls-hostname-verifier
Env: KC_TLS_HOSTNAME_VERIFIER

STRICT 和 WILDCARD 已被棄用，請改用 DEFAULT。已棄用值： WILDCARD、STRICT

ANY, WILDCARD, STRICT, DEFAULT (預設)

truststore-paths

將用作系統信任儲存的 pkcs12 (p12 或 pfx 檔案擴展名)、PEM 檔案或包含這些檔案的目錄清單。

CLI: --truststore-paths
Env: KC_TRUSTSTORE_PATHS

安全性

值

fips-mode

設定 FIPS 模式。

如果設定為 non-strict，則會啟用 FIPS，但在非核准模式下。為了完全符合 FIPS 規範，請設定 strict 以在核准模式下執行。當停用 fips 功能時，此選項預設為 disabled，這也是預設值。當啟用 fips 功能時，此選項預設為 non-strict。

CLI: --fips-mode
Env: KC_FIPS_MODE

non-strict, strict

匯出

值

dir

設定將建立包含匯出資料之檔案的目錄路徑。

CLI: --dir
Env: KC_DIR

file

設定將建立包含匯出資料之檔案的路徑。

若要匯出 500 名以上的用戶，請改為匯出到具有不同檔案的目錄。

CLI: --file
Env: KC_FILE

realm

設定要匯出的領域名稱。

如果未設定，則將匯出所有領域。

CLI: --realm
Env: KC_REALM

users

設定應如何匯出用戶。

CLI: --users
Env: KC_USERS

skip, realm_file, same_file, different_files (預設)

users-per-file

設定每個檔案的用戶數。

僅當 users 設定為 different_files 時才使用。增加此數字會導致匯出時間呈指數增長。

CLI: --users-per-file
Env: KC_USERS_PER_FILE

50 (預設)

匯入

值

dir

設定將讀取檔案的目錄路徑。

CLI: --dir
Env: KC_DIR

file

設定將讀取之檔案的路徑。

CLI: --file
Env: KC_FILE

override

設定是否應覆寫現有資料。

如果設定為 false，則將忽略資料。

CLI: --override
Env: KC_OVERRIDE

true (預設), false

啟動管理員

值

bootstrap-admin-client-id

暫時啟動管理員服務帳戶的用戶端 ID。

僅在建立主領域時使用。僅當設定了啟動管理員用戶端密碼時才可用。

CLI: --bootstrap-admin-client-id
Env: KC_BOOTSTRAP_ADMIN_CLIENT_ID

temp-admin (預設)

bootstrap-admin-client-secret

暫時啟動管理員服務帳戶的用戶端密碼。

僅在建立主領域時使用。如果可以，請為此選項使用非 CLI 組態選項。

CLI: --bootstrap-admin-client-secret
Env: KC_BOOTSTRAP_ADMIN_CLIENT_SECRET

bootstrap-admin-password

暫時啟動管理員密碼。

僅在建立主領域時使用。如果可以，請為此選項使用非 CLI 組態選項。

CLI: --bootstrap-admin-password
Env: KC_BOOTSTRAP_ADMIN_PASSWORD

bootstrap-admin-username

臨時初始管理員使用者名稱。

僅在建立主領域時使用。僅在設定初始管理員密碼時可用。

CLI: --bootstrap-admin-username
Env: KC_BOOTSTRAP_ADMIN_USERNAME

temp-admin (預設)
在此頁面上
編輯本指南