libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases Packages Activity Actions

Fix docs around --config-file option (#27129)

Browse source 
Closes #22540

Signed-off-by: Václav Muzikář <vmuzikar@redhat.com>
This commit is contained in:
Václav Muzikář 2024-02-19 15:13:09 +01:00 committed by GitHub
parent 6b3fa8b7a7
commit fb49c21f90
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/guides/server/configuration.adoc
View file

@ -9,12 +9,11 @@ summary="Understand how to configure and start {project_name}">
This {section} explains the configuration methods for {project_name} and how to start and apply the preferred configuration. It includes configuration guidelines for optimizing {project_name} for faster startup and low memory footprint.
== Configuring sources for {project_name}
{project_name} loads the configuration from five sources, which are listed here in order of application.
{project_name} loads the configuration from four sources, which are listed here in order of application.
. Command-line parameters
. Environment variables
. Options defined in a user-created configuration file.
. Options defined in the `conf/keycloak.conf` file.
. Options defined in the `conf/keycloak.conf` file, or in a user-created configuration file.
. Sensitive options defined in a user-created Java KeyStore file.
When an option is set in more than one source, the one that comes first in the list determines the value for that option. For example, the value for an option set by a command-line parameter has a higher priority than an environment variable for the same option.
@ -42,7 +41,7 @@ The following example shows how the `db-url` value is set in four configuration
Based on the priority of application, the value that is used at startup is `cliValue`, because the command line is the highest priority.
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.
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. 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. Note that these formats apply to spi options as well.
@ -108,6 +107,8 @@ You can also specify an explicit configuration file location using the `[-cf|--c
<@kc.start rootParameters="--config-file=/path/to/myconfig.conf"/>
Setting that option makes {project_name} read configuration from the specified file instead of `conf/keycloak.conf`.
=== Setting sensitive options using a Java KeyStore file
Thanks to Keystore Configuration Source you can directly load properties from a Java KeyStore using the `[--config-keystore]` and `[--config-keystore-password]` options.