🚀 Try it for free in the new Phase Two keycloak managed service. Go to Phase Two for more information.
Builds the base Phase Two Keycloak Docker image that is used in the self-serve clusters (both for shared and dedicated). This is based on the a Keycloak image which differs from the mainline with added support for Keycloak on CockroachDB.
This distribution contains the following extensions:
| Component | Status | Repository | Description |
|---|---|---|---|
| Admin Portal | ✅ | https://github.com/p2-inc/phasetwo-admin-portal | User self-management for their account and organizations. |
| Admin UI | ✅ | https://github.com/p2-inc/keycloak-ui | Admin UI customizations. |
| Events | ✅ | https://github.com/p2-inc/keycloak-events | All event listener implementations. |
| IdP Wizards | ✅ | https://github.com/p2-inc/idp-wizard | Identity Provider setup wizards for self-management of SSO admins and organizations. |
| Magic Link | ✅ | https://github.com/p2-inc/keycloak-magic-link | Magic Link Authentication. Created with an Authenticator or Resource. |
| Organizations | ✅ | https://github.com/p2-inc/keycloak-orgs | Organizations multi-tenant entities, resources and APIs. |
| Themes | ✅ | https://github.com/p2-inc/keycloak-themes | Login and email theme customizations via Realm attributes without deploying an extension. |
| User Migration | ✅ | https://github.com/p2-inc/keycloak-user-migration | User migration storage provider and API client. |
This packages a cache-ispn-jdbc-ping.xml for setting up Infinispan/JGroups discovery via the JDBC ping protocol. To use it, set the environment variable KC_CACHE_CONFIG_FILE: cache-ispn-jdbc-ping.xml.
Because you may want to use a different driver class, and the url string differs from that of Keycloak, we have added 2 variables:
KC_ISPN_DB_DRIVER # default is "org.postgresql.Driver"
KC_ISPN_DB_VENDOR # default is "postgresql"
Format for version is <keycloak-version>-<build-timestamp> e.g. 24.0.4.1688664025.
There will also be major/minor/patch version tags released. E.g.
2424.024.0.424.0.4.1688664025
This project uses a maven project in libs/ to fetch all of the jars that will be included in the Docker image.
# build the libs project
cd libs/
mvn package
cd ..
# build the image
docker build -t quay.io/phasetwo/phasetwo-keycloak:$VERSION -f Dockerfile .
docker push quay.io/phasetwo/phasetwo-keycloak:$VERSION
Check to see if there are updated jars:
cd libs/
mvn versions:display-dependency-updates
You can try it in ephemeral, development mode with:
docker run --name phasetwo_test --rm -p 8080:8080 \
-e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin -e KC_HTTP_RELATIVE_PATH=/auth \
quay.io/phasetwo/phasetwo-keycloak:$VERSION \
start-dev --spi-email-template-provider=freemarker-plus-mustache --spi-email-template-freemarker-plus-mustache-enabled=true --spi-theme-cache-themes=false
There are docker compose examples for Postgres and Cockroach in the examples/ directory. E.g.:
docker rmi -f phasetwo/phasetwo-keycloak-crdb:latest
docker build -t phasetwo/phasetwo-keycloak-crdb:latest -f examples/cockroach/Dockerfile .
# If you need to inspect the image contents, use:
docker run -it --rm --entrypoint /bin/bash phasetwo/phasetwo-keycloak-crdb:latest
# Run it with a single-node crdb instance and caddy as a reverse proxy
docker-compose -f examples/cockroach/crdb-keycloak.yml up
https://quay.io/repository/phasetwo/phasetwo-keycloak?tab=tags