🚀 Installation Instructions

This guide explains how to install and configure the Kommons extensions in your Keycloak server.

No need to clone or build anything — each release includes a prebuilt, ready-to-use JAR.

📥 1. Download the JAR

Visit the Releases page and download the JAR that matches your Keycloak version.

📌 Example: If you use Keycloak 26.2.5, download kommons-26.x.x.jar.

Copy the downloaded JAR into your Keycloak installation:

cp kommons-26.x.x.jar $KEYCLOAK_HOME/providers/

Restart your Keycloak server:

$KEYCLOAK_HOME/bin/kc.sh restart

✅ This works with modern, Quarkus-based Keycloak distributions (version 17 and up).

For Docker-based setups, mount or copy the JAR to:

/opt/keycloak/providers

You may want to check out this example: 👉 docker-compose.yml

This extension uses a simple versioning scheme aligned with Keycloak:

If you’re using Keycloak version X.y.z, use extension version X.b.c.

Each X.b.c release of the extension is compiled and tested against Keycloak X.y.z.

Keycloak’s SPIs are generally stable, so minor version mismatches (e.g., 24.0.0 vs 24.0.2) are usually fine.
Check the compatibility test matrix for current tested versions.
Or simply try it — it often works across patch versions.

No backports: Only the latest extension version for each Keycloak major version is supported.
If you’re using an older Keycloak version:
- ✅ Recommended: Upgrade your Keycloak instance
- 🛠️ Alternative: Fork the repository and build your own version

If you’re using Red Hat Single Sign-On (RH-SSO), check the equivalent Keycloak version using this mapping: 👉 Red Hat to Keycloak version mapping

Use the corresponding extension version following the same rules above.