Why

The goal of this distribution is to enable the effortless initiation of an OpenMRS Distro with Single Sign-On (SSO) and DataFilter activated through a single command line (utilizing Docker).

ICRC Customization

This distribution is a customized version of https://github.com/openmrs/openmrs-distro-referenceapplication to:

• integrate Oauth2 Module: openmrs-module-oauth2login
• integrate DataFilter Module: openmrs-module-datafilter
• Generate default users and populate the database with patient data.

Components

• database is used to create a MariaDB Docker Image with an "initial" OpenMRS Dump.
• frontend activate oauth2 login in the frontend
• backend create an OpenMRS distribution incorporating OAuth2, DataFilter modules, and a custom module for generating default users and patients.
• keycloak start and configure automatically Keycloak

How to build and start

1. Copy the file .env.default to .env
2. Edit .env and provide default username, password
3. Start dockers with: docker compose up -d --build
4. Go to http://localhost:8080
5. You should be redirected to Keycloak.
6. Sign in using a user selected from the provided list keycloak/users.csv and the password defined in .env

To login you can use the username (before @). For instance to log as [email protected], you can use doctor.many in sso login page.

Maven configuration and GitHub token

https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry#authenticating-to-github-packages

To access to packages deployed on GitHub (https://github.com/icrc/openmrs-module-fhir2extension), you must have a GitHub account and provide a PAT. Any GitHub account is working, You should configure your settings.xmlfile by adding:

<server>
    <id>openmrs-module-fhir2extension</id>
    <username>#{GITHUB_USERNAME}#</username>
    <password>#{GITHUB_TOKEN}#</password>
</server>

GITHUB_TOKEN is a personal access token (classic) with at least read:packages scope to install packages associated with other private repositories (which GITHUB_TOKEN can't access).

To access to GitHub repositories a token is required. The file settings-template.xml can be used as a template to edit your file settings.xml Developers have to edit their file settings.xml to add valid token taken from a GitHub account.

How to use images:

A default docker-compose file is available here: https://github.com/icrc/openmrs-android-fhir/docker-compose.yml

A .env is always required to define passwords and sso admin username.