Quick start

git clone https://github.com/keycloakify/keycloakify-starter
cd keycloakify-starter
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)

npm run 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

npx keycloakify initialize-account-theme

Initializing the email theme

npx keycloakify initialize-email-theme

GitHub Actions

The starter comes with a generic GitHub Actions workflow that builds the theme and publishes the jars as GitHub releases artifacts.
To release a new version just update the package.json version and push.

To enable the workflow go to your fork of this repository on GitHub then navigate to: Settings > Actions > Workflow permissions, select Read and write permissions.

2.0 KiB Raw Permalink Blame History