mirror/keycloak
1
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-05-07 15:41:29 -05:00
Code Issues Packages Projects Releases Wiki Activity

Clarify upgrading language

Browse Source 
Closes #38956

Signed-off-by: AndyMunro <amunro@redhat.com>
Signed-off-by: Alexander Schwartz <alexander.schwartz@gmx.net>
Co-authored-by: Alexander Schwartz <alexander.schwartz@gmx.net>
This commit is contained in:
andymunro
2025-04-16 16:32:03 -04:00
committed by GitHub
parent bbbd0ff986
commit 17e3bad7b2
2 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/documentation/upgrading/topics/migrate_db.adoc
+6 -2
View File
@@ -5,6 +5,11 @@
{project_name} can automatically migrate the database schema, or you can choose to do it manually. By default the
database is automatically migrated when you start the new installation for the first time.
[NOTE]
====
Before you migrate the database, shut down all {project_name} nodes running the old version of {project_name}.
====
=== Automatic relational database migration
To perform an automatic migration, start the server connected to the desired database. If the database schema has changed for the new server version, the migration starts automatically unless the database has too many records.
@@ -28,8 +33,7 @@ default `connections-jpa` provider:
kc.[sh|bat] start --spi-connections-jpa-quarkus-migration-strategy=manual
----
When you start the server with this configuration, the server checks if the database needs to be migrated.
The required changes are written to the `bin/keycloak-database-update.sql` SQL file that you can review and manually run against the database.
When you start the server with this configuration, the server checks if the database needs to be migrated. If migration is needed, the required changes are written to the `bin/keycloak-database-update.sql` SQL file. You can review and manually run these commands against the database.
To change the path and name of the exported SQL file, set the `migration-export` property for the
default `connections-jpa` provider:
docs/documentation/upgrading/topics/migrate_themes.adoc
+1 -3
View File
@@ -14,9 +14,7 @@ If you created custom themes, those themes must be migrated to the new server. A
=== Migrating templates
If you customized any template, review the new version to decide about updating your customized template. If you made minor changes, you could compare the updated template to your customized template. However, if you made many changes, consider comparing the new template to your customized template. This comparison will show you what changes you need to make.
You can use a diff tool to compare the templates. The following screenshot compares the `info.ftl` template from the Login theme and an example custom theme:
If you customized any template, compare it to the new version of that template. This comparison shows you what changes you need to apply to your customized template. You can use a diff tool to compare the templates. The following screenshot compares the `info.ftl` template from the Login theme and an example custom theme:
.Updated version of a Login theme template versus a custom Login theme template
image:images/theme-migration-meld-info-1.png[Updated version of a Login theme template versus a custom Login theme template]