This is the documentation for v9, checkout the latest version
Keycloakify
v9
  • Keycloakify
  • Release Notes & Upgrade Instructions
  • FAQ
v9
  • 👨‍💻Quick start
  • 📥Importing your theme in Keycloak
  • 🔩Keycloakify in my App
  • 🖼️Importing assets and fonts
  • 📧Email customization
  • ✒️Terms and conditions
  • ✅Realtime input validation and custom registration fields
  • ⚠️Limitations
  • 🔧Environment Variables
  • 🌎i18n: msg(...)
  • 📖Build options
  • 💂Email domain acceptlist
  • 🛑Keycloak error in log
  • 🌉Passing values from the App to the theme
  • 💟Contributing
  • 🤔How it works
  • ⬆️Migration guides
    • ⬆️CRA -> Vite
    • ⬆️v8 -> v9
    • ⬆️v7 -> v8
    • ⬆️v6 -> v7
    • ⬆️v6.x -> v6.12
    • ⬆️v5 -> v6
Powered by GitBook
On this page

Was this helpful?

Quick start

NextImporting your theme in Keycloak

Last updated 2 days ago

Was this helpful?

The best way to get started with Keycloakify is to study and play around with the starter project.

The README of the starter repo is the tutorial! It details everything there is to know and there is a lot of comments in the code to help you figure things out.

Alternatively, one of the main contributors of the project wrote a tutorial on his blog article. Check it out!

This video from The UI Dawg is great to give you an overview of how Keycloakify operates but don't treat it as a tutorial! The authoritative source is and this documentation website!

👨‍💻
the readme of the starter project
GitHub - codegouvfr/keycloakify-starter: 🔑 starter and demo project for KeycloakifyGitHub
Introduction video + blog post
Logo