🚀 Keycloakify v11 starter 🚀

Quick start

git clone https://github.com/mitodl/ol-keycloakify.git
cd ol-keycloakify
yarn install # Or use an other package manager, just be sure to delete the yarn.lock if you use another package manager.

Testing the theme locally

Documentation

How to customize the theme

Documentation

Building the theme

You need to have Maven installed to build the theme (Maven >= 3.1.1, Java >= 7). The mvn command must be in the $PATH.

• On macOS: brew install maven
• On Debian/Ubuntu: sudo apt-get install maven
• On Windows: choco install openjdk and choco install maven (Or download from here)

yarn build-keycloak-theme

Note that by default Keycloakify generates multiple .jar files for different versions of Keycloak. You can customize this behavior, see documentation here.

Initializing the account theme

yarn keycloakify initialize-account-theme

Initializing the email theme

yarn keycloakify initialize-email-theme

Start in Docker

yarn keycloakify start-keycloak

GitHub Actions

The GitHub Actions CI will produce a release when the package.json version is bumped. The CI/CD pipeline at https://cicd.odl.mit.edu/teams/infrastructure/pipelines/docker-packer-pulumi-keycloak pulls the output JAR from the release assets, see https://github.com/mitodl/ol-keycloakify/releases.

The Storybook build publishes to GitHub Pages at https://mitodl.github.io/ol-keycloakify