โฌ๏ธv9 -> v10
Last updated
Last updated
Keycloakify 10 has undergone significant changes compared to previous versions. The software has been nearly rewritten from the ground up, making it a more mature and stable solution. However, this also brings several breaking changes. Moving forward, Keycloakify will be more stable, and you shouldnโt have to endure a painful migration process to support the latest Keycloak versions.
This major breaking change was necessary to lay a strong foundation for the future of the project.
Iโve recorded a video summarizing all the changes. Itโs quite detailed, so if you donโt have time to watch the entire video, you can refer to the updated documentation for a quicker overview:
When updating, I recommend starting fresh with the new starter and reapplying your custom changes.
If you only had a Keycloak theme:
Vite starter: https://github.com/keycloakify/keycloakify-starter
Webpack (Create React App) starter: https://github.com/keycloakify/keycloakify-starter-webpack
If you had Keycloakify installed in your web app: Follow this integration guide: Integrating Keycloakify in your React project.
The register-user-profile.ftl
file has been renamed to register.ftl
. The old register.ftl
, where user attributes were hardcoded, has been removed.
The update-user-profile.ftl
file has been renamed to login-update-profile.ftl
, and the old login-update-profile.ftl
has also been removed.
Donโt worryโKeycloakify still generates themes that are compatible with older Keycloak versions, including those that did not have the declarative User Profile feature.
You now have the option to choose between a Single Page Account Theme or a Multi-Page Account Theme. See documentation.
If you haven't created or customized an account theme, set accountThemeImplementation
to "none"
in your Keycloakify configuration. You can also remove the src/keycloak-theme/account
directory if it exists.
If you had an account theme, you must set accoutThemeImplementation to "Multi-Page":
The Keycloakify Component API and boilerplate have undergone several small adjustments.
One of the most notable changes is the renaming of useGetClassName
to getKcClsx
. You can view the updated implementation here: useGetClassName is now getKcClsx.
For the latest code for the new pages, refer to this repository: New Login Pages.
It's crucial that you reapply your changes to the new Template.tsx
instead of trying to modify your old Template.tsx
to compile. You can find the updated template here: New Template.tsx.