From 66e45a335e924a9b43ab8a41ae279a02f61eba0d Mon Sep 17 00:00:00 2001 From: Steven Hawkins Date: Wed, 31 Jan 2024 11:09:47 -0500 Subject: [PATCH] doc: noting the formats apply to spi options as well (#26648) closes: #26468 Signed-off-by: Steve Hawkins --- docs/guides/server/configuration-provider.adoc | 2 +- docs/guides/server/configuration.adoc | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/server/configuration-provider.adoc b/docs/guides/server/configuration-provider.adoc index e81fc2b44b..192d185b8a 100644 --- a/docs/guides/server/configuration-provider.adoc +++ b/docs/guides/server/configuration-provider.adoc @@ -40,7 +40,7 @@ spi-connections-http-client-default-connection-pool-size=10 == Setting a provider configuration option -Provider configuration options are provided when starting the server, as shown in the following example: +Provider configuration options are provided when starting the server. See all support configuration sources and formats for options in <@links.server id="configuration"/>. For example via a command line option: .Setting the `connection-pool-size` for the `default` provider of the `connections-http-client` SPI <@kc.start parameters="--spi-connections-http-client-default-connection-pool-size=10"/> diff --git a/docs/guides/server/configuration.adoc b/docs/guides/server/configuration.adoc index 95399c2a28..3f25bc5746 100644 --- a/docs/guides/server/configuration.adoc +++ b/docs/guides/server/configuration.adoc @@ -45,7 +45,7 @@ Based on the priority of application, the value that is used at startup is `cliV If `--db-url=cliValue` had not been used, the applied value would be `KC_DB_URL=envVarValue`. If the value were not applied by either the command line or an environment variable, `db-url=confFileValue` would be used. However, if this value had been set in a user defined configuration file, that value would take precedence over the `conf/keycloak.conf` file. If none of the previous values were applied, the value `kc.db-url=confFileValue` would be used due to the lowest priority among the available configuration sources. == Formats for configuration -The configuration uses a _unified-per-source_ format, which simplifies translation of a key/value pair from one configuration source to another. +The configuration uses a _unified-per-source_ format, which simplifies translation of a key/value pair from one configuration source to another. Note that these formats apply to spi options as well. Command-line parameter format:: Values for the command-line use the `--__=__` format. For some values, an `-__=__` shorthand also exists.