Allow for direct use of the software.

[florisvangeel]

Introduction:n:
Thank you for maintaining the ESDL standard and creating this piece of software that allows energy consultants and enthusiasts to model their neighborhoods or business parks with energy aware objects for real time simulations of different energy scenarios.

Problem statement:
Currently one needs to be able to build docker-compose as well as Keycloak in order to get this software up and running.
There is an old version of Keycloak 11.0.3 (dated May 2021) that does not install.

Solution:
Fortunately i do, thus you'll get a MR to the corrected code.

Summary of Changes in Merge Request
PostgreSQL Initialization:

• Appended a database provisioning step for Keycloak to the initialization script, loading keycloak.postgres.sql into the keycloak database.
• Keycloak Configuration: Upgraded Keycloak image from version 11.0.3 to 20.0.3.
• Replaced deprecated environment variables with the new Keycloak 20+ KC_ prefixed syntax.
• Mounted a custom configuration file (keycloak.conf) into the container at the appropriate location.
• Added Docker extra_hosts mapping to resolve host.docker.internal inside the container.

Docker Compose:

• Updates: Injected proper environment variables for PostgreSQL services related to Keycloak and others.
• Corrected volume mount paths for the custom configuration.
• Set the container startup command to start-dev with relaxed hostname checks for development mode.

Keycloak Provisioning:

• Set the database JDBC URL to point to the host bridge IP, enabling database connectivity from Keycloak.
• Ensured PostgreSQL accepts external connections from Docker-linked containers.
• Realm import was tested and confirmed working after resolving a session timeout during initial login.

Additional Fixes

• Verified the container receives the expected configuration.
• Removed restart: always to aid debugging during development.
• Confirmed internal container DNS resolution using getent hosts.

Kind regards
Floris

[ewoudwerkman]

Hi Floris,

Thanks for your efforts, indeed the keycloak version in the main docker-compose is very old. We did however modernize things in the individual directories, (e.g. look at the BaseInfrastructure/docker-compose.yaml, with keycloak 25.0) but never had the time to integrate it into the main docker-compose.yaml, due to some outstanding issues.

E.g. some issues remain with newer keycloak:

• upgrading keycloak to 25+ is not working for existing deployments, because the database schema changed too much. To move to 25+, you first need to upgrade to 21.x and then to 25.x seems to work (see also issues raised at keycloak development)
  (I see you use the LTS release)
• no nonce in access and refresh tokens anymore => update keycloak.js clients or add nonce back with a mapper (see keycloak upgrade guide)
• resource_access not in id token -> add it with mapper or use access token
• logout flow is different (needs id token)

Consequently, also some of the tools that use keycloak are affected and have to be fixed, before we can do a mayor update. This is in progress. E.g. newer ESDL MapEditor images are based on Authlib for OpenIDConnect, but we've seen that deployments on localhost have issues with the wrong redirect_uri.

So, thanks for your PR! We'll add it to our planned changes after we're done fixing the outstanding issues with the clients.

Kind regards,
Ewoud

BTW: we are very interested in how you use our tools and for what use cases. Recently, we've organized a ESDL community day to exchange ideas on the tools we develop and plans we have for the future. If you like to join or want more information, please reach out.

[florisvangeel]

Yes i was in Tuesdays (17-June 2025) webinar with Enexis, TNO and Zenmo, didn't know about ESDL before.
My intent is to model Leenderstrijp community area and use that for real time simulations.

So can i assume if i downgrade Keycloak to 21.x i can still use the software to model my neighborhood?

[ewoudwerkman]

If you can login into the MapEditor, your fine. My recommendation is to stick with your LTS release for now.

I don't know by heart which changes of the list above where in which version (it's in the keycloak upgrade guide). The lower the version of keycloak, the better I think ;-). As docker Hub still uses the older MapEditor images without Authlib, the redirect issue is not a problem.