Keycloak-Custom

Project Template

This project is based on the custom Keycloak template. It is structured as a multi-module Maven build and contains the following top-level modules:

• config: provides the build stage configuration and the setup of Keycloak
• container: creates the custom docker image
• docker-compose: provides a sample for launching the custom docker image
• extensions: provides samples for Keycloak SPI implementations
• helm: provides a sample for installing the custom container image in Kubernetes using the Codecentric Helm Chart
• server: provides a Keycloak installation for local development & testing
• themes: provides samples for custom themes

Please see the tutorials building a custom Keycloak container image and Configuring Passkey for the details of this project.

Server admin guide: https://www.keycloak.org/docs/latest/server_admin

Installation

# set up
./mvnw clean package
# run postgres
docker compose -f ./docker-compose/postgres/docker-compose.yml up -d
# run keycloak
./server/run-keycloak.sh > debug.log

# in a different tab, set up keycloak
./server/run-keycloak-setup.sh

Then test it by going to the URL: https://www.keycloak.org/app/#url=http://localhost:8080&realm=passkey&client=passkey

Or http://localhost:8080/realms/passkey/account

Build Image

In order to use this Authorization Server in other places, building the image is necessary.

./mvnw clean install -DmultiArchBuild

Documentation

• Server Development Guide (Old)
• Server Development Guide (New)