keycloak-scim/docs/documentation/upgrading/topics/prep_migration.adoc

[[_prep_migration]]

== Preparing for upgrading

Perform the following steps before you upgrade the server.

.Procedure
. Shutdown {project_name}.
. Back up the old installation, such as configuration, themes, and so on.
. If XA transaction is enabled, handle any open transactions and delete the `data/transaction-logs/` transaction directory.
. Back up the database using instructions in the documentation for your relational
  database.
+
The database will no longer be compatible with the old server after you upgrade the server. If you need to revert the upgrade, first restore the old installation, and then restore the database from the backup copy.

[WARNING]
====
ifeval::[{project_product}==true]
After the upgrade of {project_name}, except for offline user sessions, user sessions are lost. Users will have to log in again.
endif::[]

ifeval::[{project_community}==true]
After the upgrade of {project_name}, only if the feature `persistent-user-sessions` is enabled, users will still be logged in with their online sessions.
If it is not enabled, users will have to log in again, except where offline user sessions are used.
endif::[]

Information about failed logins for the brute force detection and currently ongoing authentication flows is only stored in the internal caches that are cleared when {project_name} is shut down.
Users currently authenticating, changing their passwords or resetting their password will need to restart the authentication flow once {project_name} is up and running again.
====