⚠️Limitations

Some pages still have the default theme. Why?

This project only support out of the box the most common user facing pages of Keycloak but not all of them. You might find out that a page that you need to customize is not yet provided as a react component by Keycloakify.

Here are the login pages currently implemented vs all the existing pages.

Here are the acount pages currently implemented vs all the existing pages. You can preview the pages looks in the Storybook. (Well of course the pages that are not yet implemented will not apprear here.)

If the page you are looking for is implemented you can import it in you project with this command:

npx -p keycloakify download-builtin-keycloak-theme

Video demo (Before copying the page in your project try to see if you can't acheive the desired look by customizing the Template.tsx) Otherwise, keep reading.

I have established that a page that I need isn't supported out of the box by Keycloakify, now what?

I submit a PR to Keycloakify

💟pageContributing

I do it only for my project

Keycloakify also enables you to declare custom ftl pages.

Check out how my-extra-page-1.ftl and my-extra-page-2.ftl where added to the starter project.

Main takeaways are:

• (TS only) You must declare theses page in the type argument of the getter function for the kcContext in order to have the correct typings. example

• (TS only) If you use Keycloak plugins that defines non standard .ftl values (Like for example this plugin that define authorizedMailDomains in register.ftl) you should declare theses value to get the type. example

• You should provide sample data for all the non standard value if you want to be able to debug the page outside of keycloak. example

process.env.PUBLIC_URL not supported.

The environement variable process.env.PUBLIC_URL can't be directly used in a Keycloakify project but there is a workaround. See:

#import-assets-from-the-public-directory

In Vite import.meta.env.BASE_URL is supported!

Self hosted fonts

Importing self hosted font does not work out of the box like it would in a regular React project. See workaround:

#selft-hosted-fonts

Other workarounds

• You can circumvent the problem by avoiding hosting your font yourself using Google Fonts, Font Awesome or any other font provider.

• You can self host your font somewhere, you will need to enable Access-Control-Allow-Origin on the server serving your fonts.

Admin Console Theme not supported

If you are missing this feature open an issue about it.

Wellcome page not customizable

The following page isn't customizable yet.

It's however planned to enable this. Follow the progress in this issue.

Field Names can't be runtime generated

Keycloakify analyze your code to see what field name are used. As a result your field names should be hard coded in your code (If you are using user profile you don't have to worry about it).

// OK ✅
messagesPerField.exists("foo-bar")

// Not OK 🛑
const bar= "bar";
messagesPerField.exists(`foo-${bar}`);

Cloud IAM - Keycloak Identity and Access Management as a Service

Feeling overwhelmed? Check out our exclusive sponsor's Cloud-IAM consulting services to simplify your experience.