External-Mirrors/keycloak
2
0
Fork 0
mirror of https://github.com/keycloak/keycloak.git synced 2026-01-10 15:32:05 -03:30
Code Issues Packages Projects Releases Wiki Activity

Updated documentation to handle the conf folder on upgrades

Browse Source 
Closes #40046

Signed-off-by: Alexander Schwartz <aschwart@redhat.com>
This commit is contained in:
Alexander Schwartz 2025-06-04 14:52:37 +02:00 committed by GitHub
parent aaa6a5d1b2
commit 0709878d2a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/documentation/upgrading/topics/changes/changes-26_2_6.adoc Normal file
View File

@ -0,0 +1,18 @@
////
== Breaking changes
Breaking changes are identified as requiring changes from existing users to their configurations.
////
== Notable changes
Notable changes where an internal behavior changed to prevent common misconfigurations, fix bugs or simplify running {project_name}.
=== Upgrade procedure changed for the distribution
If you are upgrading {project_name} by downloading the distribution, the upgrade procedure has been changed. Previously it recommended copying over the contents from the `conf/` folder from the old to the new installation.
The new procedure recommends to re-apply any changes to `cache-ispn.xml` or a custom cache configuration based on the file included in the new version.
This prevents accidentally downgrading functionality, for example, by using an old `cache-ispn.xml` file from a previous version.

4
docs/documentation/upgrading/topics/changes/changes.adoc
View File

@ -1,6 +1,10 @@
[[migration-changes]]
== Migration Changes
=== Migrating to 26.2.6
include::changes-26_2_6.adoc[leveloffset=2]
=== Migrating to 26.2.0
include::changes-26_2_0.adoc[leveloffset=2]

6
docs/documentation/upgrading/topics/download.adoc
View File

@ -11,4 +11,8 @@ from the {project_name} website.
+
After extracting this file, you should have a directory that is named `{archivebasename}-{project_version}`.
. Move this directory to the desired location.
. Copy `conf/`, `providers/` and `themes/` from the previous installation to the new installation.
. Copy `providers/` and `themes/` from the previous installation to the new installation.
. Copy all files except `cache-ispn.xml` from `conf/` from the previous installation to the new installation.
. If you modified `cache-ispn.xml` or created a custom cache configuration file:
.. Re-apply your changes based on the `cache-ispn.xml` file shipped with the new installation, and place them in the new installation.
.. Review the latest {project_name} configuration options for cache sizes and transport stacks if they can be used instead of your modifications as they provide better documentation, additional validations and functionality, and a simpler upgrade experience.