README.md

EIMIS Keycloak

This repo is meant to build and publish a customized version of Keycloak. An ID provider used to connect to a Matrix network through Synapse server and Element app.

The docker image is published to Docker Hub. The version will be : v[KC_VERSION]-[EIMIS_INCREMENTAL_NUMBER]

Included SPIs projects are present in sub directories:

• keycloak-2fa-email-authenticator which is a fork of mesutpiskin/keycloak-2fa-email-authenticator
• eimis-theme : a custom theme for emails including OTP mail template

Try it out locally

add the following to your /etc/hosts file:

127.0.0.1       matrix.local
127.0.0.1       idp.local

docker compose up -d

Tip

If started with docker compose watch, keycloak image will be rebuilt restarted everytime a change is detected in SPIs folders

You can then access:

• Keycloak at http://localhost:8080
  • login with admin/admin
  • You can then go to eimis-realm and create a user
• Element at http://localhost:1983
  • Click on EIMIS Connect and login with the user you created in Keycloak
• Mailhog at http://localhost:8025
  • You should see a e-mail sent with a code
  • Paste it in the login screen
• Synapse at http://localhost:8008

So far Keycloak version is set in the Dockerfile and in SPIs dependencies and they should match.

Caution

The dev / test environment is pre-configured with secrets and certificats that should obviously not be used in production.