From ebccfd3a842a382934edbf06955e68e4525464c3 Mon Sep 17 00:00:00 2001 From: Dominik Guhr Date: Tue, 26 Jul 2022 17:04:01 +0200 Subject: [PATCH] changes for optimized documentation Closes #1631 --- upgrading/topics/keycloak/changes-19_0_0.adoc | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/upgrading/topics/keycloak/changes-19_0_0.adoc b/upgrading/topics/keycloak/changes-19_0_0.adoc index 8c7ee90a7d..91e8701e1f 100644 --- a/upgrading/topics/keycloak/changes-19_0_0.adoc +++ b/upgrading/topics/keycloak/changes-19_0_0.adoc @@ -1,3 +1,25 @@ += Changes to the server configuration and startup + +Before this release, you would use the `--auto-build` when running the `start` command to tell the server to conditionally run +a `build` if any build option has changed prior to starting the server. + +In this release, the `--auto-build` flag is *deprecated* and you no longer need to use it to indicate that you want to set build options when +starting the server. Instead, the server is always going to run a `build` by default prior to starting the server if any build option has changed. +The new behavior improves the overall experience when configuring and starting the server by making it optional, although highly recommended, +to run a `build` command beforehand in order to achieve the best startup time and memory footprint. + +Now, in order to achieve the best startup time and memory footprint, set the `--optimized` option to disable the new default behavior. +The `--optimized` flag tells the server that checking for and running a `build` directly as part of the startup is not needed: + +``` +kc.sh start --optimized +``` + +If you are already using a custom image to set build options and run an optimized Keycloak container, make sure you set the `--optimized` option when invoking the +`start` command. + +For more details, please take a look at the https://www.keycloak.org/server/configuration[Configuration Guide] and the https://www.keycloak.org/server/containers[Containers Guide]. + = Changes affecting developers {project_name} undergoes large refactoring, which impacts existing code.