diff --git a/docs/guides/src/main/server/caching.adoc b/docs/guides/src/main/server/caching.adoc index 285eb6589e..1f91ebe11b 100644 --- a/docs/guides/src/main/server/caching.adoc +++ b/docs/guides/src/main/server/caching.adoc @@ -99,6 +99,8 @@ To specify your own cache configuration file, enter this command: <@kc.build parameters="--cache-config-file=my-cache-file.xml"/> +The configuration file is relative to the `conf/` directory. + == Transport stacks Transport stacks ensure that distributed cache nodes in a cluster communicate in a reliable fashion. Keycloak supports a wide range of transport stacks: diff --git a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/ClusteringPropertyMappers.java b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/ClusteringPropertyMappers.java index 534957bd24..2681cb0c1d 100644 --- a/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/ClusteringPropertyMappers.java +++ b/quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/mappers/ClusteringPropertyMappers.java @@ -34,7 +34,8 @@ final class ClusteringPropertyMappers { builder().from("cache-config-file") .mapFrom("cache") .to("kc.spi-connections-infinispan-quarkus-config-file") - .description("Defines the file from which cache configuration should be loaded from.") + .description("Defines the file from which cache configuration should be loaded from. " + + "The configuration file is relative to the 'conf/' directory.") .transformer(new BiFunction() { @Override public String apply(String value, ConfigSourceInterceptorContext context) { diff --git a/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testBuildHelp.unix.approved.txt b/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testBuildHelp.unix.approved.txt index 6c252ca2d5..7036d546fa 100644 --- a/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testBuildHelp.unix.approved.txt +++ b/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testBuildHelp.unix.approved.txt @@ -29,7 +29,8 @@ Cluster: disables clustering and is intended for development and testing purposes. Default: ispn. --cache-config-file - Defines the file from which cache configuration should be loaded from. + Defines the file from which cache configuration should be loaded from. The + configuration file is relative to the 'conf/' directory. --cache-stack Define the default stack to use for cluster communication and node discovery. This option only takes effect if 'cache' is set to 'ispn'. Default: udp. diff --git a/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testBuildHelp.windows.approved.txt b/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testBuildHelp.windows.approved.txt index 1c05a8f8b1..8a00931c9e 100644 --- a/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testBuildHelp.windows.approved.txt +++ b/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testBuildHelp.windows.approved.txt @@ -29,7 +29,8 @@ Cluster: disables clustering and is intended for development and testing purposes. Default: ispn. --cache-config-file - Defines the file from which cache configuration should be loaded from. + Defines the file from which cache configuration should be loaded from. The + configuration file is relative to the 'conf/' directory. --cache-stack Define the default stack to use for cluster communication and node discovery. This option only takes effect if 'cache' is set to 'ispn'. Default: udp. @@ -104,4 +105,4 @@ running this command every time you change a configuration: $ kc.bat start --auto-build -By doing that you have an additional overhead when the server is starting. \ No newline at end of file +By doing that you have an additional overhead when the server is starting. diff --git a/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testStartDevHelpAll.unix.approved.txt b/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testStartDevHelpAll.unix.approved.txt index 8382acc111..7aa90b4984 100644 --- a/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testStartDevHelpAll.unix.approved.txt +++ b/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testStartDevHelpAll.unix.approved.txt @@ -21,7 +21,8 @@ Cluster: disables clustering and is intended for development and testing purposes. Default: ispn. --cache-config-file - Defines the file from which cache configuration should be loaded from. + Defines the file from which cache configuration should be loaded from. The + configuration file is relative to the 'conf/' directory. --cache-stack Define the default stack to use for cluster communication and node discovery. This option only takes effect if 'cache' is set to 'ispn'. Default: udp. diff --git a/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testStartDevHelpAll.windows.approved.txt b/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testStartDevHelpAll.windows.approved.txt index 9233d8a65c..e8d0709269 100644 --- a/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testStartDevHelpAll.windows.approved.txt +++ b/quarkus/tests/integration/src/test/resources/org/keycloak/it/cli/approvals/cli/help/HelpCommandTest.testStartDevHelpAll.windows.approved.txt @@ -21,7 +21,8 @@ Cluster: disables clustering and is intended for development and testing purposes. Default: ispn. --cache-config-file - Defines the file from which cache configuration should be loaded from. + Defines the file from which cache configuration should be loaded from. The + configuration file is relative to the 'conf/' directory. --cache-stack Define the default stack to use for cluster communication and node discovery. This option only takes effect if 'cache' is set to 'ispn'. Default: udp.