🏁Requirements

This tool will be maintained to stay compatible with every Keycloak version starting from Keycloak Version 11.

However, the default pages you will get (before you customize them) will always be the ones of Keycloak v11.0.3 and some extra pages that didn't existed back then like register-user-profile.ftl.

Supported Keycloak version

See versions Keycloakify have been tested with

• 11.0.3

• 12.0.4

• 15.0.2

• 16.1.0

• 17.0.1

• 18.0.0

• 18.0.2

• 19.0.1

• 20.0.1

Latest release isn't in the list yet? It probably works fine, we just can't confirm it yet.

Older version are likely to be supported as well.

Supported meta framworks

Only create-react-app projects (and by extension any app that builds with Webpack) are supported.

Next.js and Vite aren't supported, they could be (Next only in build static mode) but it would require extra work.

See more

This tool assumes you are bundling your app with Webpack.

It assumes there is a build/ directory at the root of your react project directory, it's usually generated after running yarn build.

The build/ directory is expected to contain an index.html file and a build/static/ directory.

Keycloakify also assumes there is a public/ directory at the root of your react project that is used to make static files available.

Concretely Keycloakify assumes that if there is a public/a/b.c/foo.txt file. This file should be available at https://localhost:<some_port>/a/b/c.foo.txt when running your app in test mode (usually by firing yarn start).

For more detailed information see this issue.

My framework isn't supported

It doesn’t mean that you can't use Keycloakify but your Keycloak theme will need to be a standalone project. Find specific instructions about how to get started here.

To share your styles between your main app and your login pages you will need to externalize your design system by making it a separate module. Checkout ts-ci, it can help with that (example with our design system).

Utility that needs to be installed

• docker must be up and running when running start_keycloak_testing_container.sh