neondatabase / keycloak-plugins

Keycloak SPI plugins for neon console

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Keycloak Plugins

Custom Java plugins for Keycloak:

Documentation on how to create Keycloak plugins can be found in the Keycloak SPIs

Build

Ensure you have the Maven build command mvn installed. An IDE such as Intellij

may provide this for you automatically

Run the following command:

mvn install

The output JAR can be found in the generated target directory

Install

To use these plugins, copy the output JAR into the opt/keycloak/providers directory of your Keycloak installation

If using a docker file, it is recommended to download the JAR directly from the latest release of this repository from GitHub within a multistage build like so:

FROM alpine AS neon-plugins

RUN wget https://github.com/neondatabase/keycloak-plugins/releases/download/<VERSION>/neon-plugins.jar

...

COPY --from=neon-plugins /neon-plugins.jar /opt/keycloak/providers/

replacing the <VERSION> as appropriate

Release

Updated versions of these plugins should be shared via GitHub Releases

you must include the compiled JAR file in the release artifacts, as dependent projects are expected to download this directly from GitHub as part of their build pipeline

About

Keycloak SPI plugins for neon console


Languages

Language:Java 99.1%Language:Shell 0.9%