Bahmni Docker

Refer this Wiki Page for Running Bahmni on Docker for detailed instructions.

Running Bahmni LITE or STANDARD using docker compose:

1. Navigate to the relevant subfolder for your desired configuration. For example: cd bahmni-lite.
2. Execute the script: ./run-bahmni.sh. This script provides various options such as start, stop, view logs, pull updates, reset, etc.
3. Before executing the above commands, ensure that your .env file in the sub-folder is correctly configured with the appropriate PROFILE.

Alternatively, if you wish to use docker compose commands directly, you can use the --env-file option to pass the environment variables files:

docker compose up --env-file .env

Environment Variable Configuration For Bahmni Lite

The .env and .env.dev files are used for configuring environment variables for the Bahmni Lite Docker setup.

The .env file points to the 1.0.0 image tag, which represents the stable and tested version of Bahmni Lite v1.0.0. We recommend using these images for production purposes. The .env.dev file points to the latest image version, which provides the most recent updates for development and testing purposes.

• By default run-bahmni.sh script runs with the .env, that uses the 1.0.0 images

run-bahmni.sh

• Instead if you wish to use the latest images, run the run-bahmni.sh script with the argument .env.dev

run-bahmni.sh .env.dev

• Additionally, you have the flexibility to create your own environment variable configuration. To do this, create a custom a .env file (eg: .env.local) and run the run-bahmni.sh script with the .env.local argument:

run-bahmni.sh .env.local

Please choose the appropriate environment variables file based on your requirements and make sure the respective .env or .env-dev file is properly configured before running the commands.

For detailed instructions and further information, please refer to the Wiki Page mentioned above.

Bahmni-lite local deployement

[[Bahmni Lite]] is a light-weight, opensource flavor of Bahmni targeted towards clinics & small hospitals, which don’t need a heavy-weight HIMS, but are looking for an easy-to-use EMR & Billing software. See Release Notes.

Please have a look into [[Bahmni Lite]] page and related link

Currently Bahmni-lite dockerized version is available and that's also used for development as well.

Runing Bahmni-lite

Bahmni-lite on codespace

If you are just starting, or want to just explore, you can start with gitHub Codespaces Please watch this half an hour video to run Bahmni Lite in gitHub Codespaces https://www.youtube.com/watch?v=ufbf7YWcrgY&t=1202s

Running Bahmni-lite on local system

Steps:

1. Please check if you have docker with docker compose on your system with docker compose version >= 2.12.0 docker compose version # from command prompt

You can check docker compose version by running docker compose version Only above two things are needed to run Bahmni-lite locally, basically the bahmni-docker repository contains .env file which contains the dependent docker images and the docker-compose.yml which contains needed instruction to pull the images and run it.

2. Please clone bahmni-docker from https://github.com/Bahmni/bahmni-docker

git clone https://github.com/Bahmni/bahmni-docker.git

cd bahmni-docker/bahmni-lite

We are using tag 1.0.0-lite So cd into bahmni-docker folder and checkout the tag or if you want to try out on current master then you can skip checking out tag

git checkout 1.0.0-lite

Edit the .env file, and make the following changes to set bahmni-lite profile

1. Change COMPOSE_PROFILES=bahmni-lite (or run with default which is emr)
2. (Optional) Change TZ to your desired timezone (or run with the default which is UTC).
3. (Optional) For remote server (if not running on localhost) for crater: # write the IP address or domain name in the following properties (instead of localhost): CRATER_APP_URL, CRATER_SANCTUM_STATEFUL_DOMAINS and CRATER_SESSION_DOMAIN
4. Pull latest images docker compose pull
5. Now start docker (detached mode) docker compose up -d Or from bahmni-docker/bahmni-lite directory issue the command ./run-bahmni.sh and follow the instruction provided

./run_bahmni.sh

you can start bahmni app by opening localhost in browser, please not that openMRS takes some minutes to get initialized , so till it's initialized front page can open but it would not proceed as underlying database etc is not being initialised

[!info]

• Bahmni UI (Username: superman Password: Admin123) : https://localhost/bahmni/home/index.html
• OpenMRS Admin UI (Username: superman Password: Admin123) : https://localhost/openmrs
• Crater Billing (Username: [email protected] Password: Crater123): https://localhost:444/
• Metabase Analytics (Username: [email protected] Password: Admin@123): https://localhost/metabase/

Getting Started Quickly with Bahmni on Docker

https://bahmni.atlassian.net/wiki/spaces/BAH/pages/3117744129/Getting+Started+Quickly+with+Bahmni+on+Docker#Running-Bahmni-Lite

Updating/customising Bahmni-lite

It seems (based on current exploration) we have to use this docker way also to modifying/updating code/configuration etc. Idea is to clone the needed repo, here as example below two repos we are using fo white-labelling and other customisation

In bahmni documents they have mentioned to provide local config volume path to bahmni-docker .env value, for example if we want to make changes in clinic-config and locally wants to see, for that we need to follow below step

working with clinic-config volume

1. Please clone clinic-config repo https://github.com/Bahmni/clinic-config
   1. git clone https://github.com/Bahmni/clinic-config.git
   2. cd clinic-config
2. If we are using tag 1.0.0-lite for bahmni-docker then here also we can checkout 1.0.0 tag
   1. git checkout 1.0.0
3. Now we need to update bahmni-docker/bahmni-lite/.env and docker-compose.yml to take this local clinic-config settings instead of from docker image downloaded
   1. Update the CONFIG_VOLUME varaible in bahmni-docker/bahmni-lite/.env CONFIG_VOLUME=/home/horaira/workspace/indiclinic/bahmnicommitcomp/experimentalbranch/clinic-config for me i have provided actual path where clinic-config is present
   2. Now we need to comment bahmni-config service in bahmni-docker/bahmni-lite/docker-compose.yml ![[Pasted image 20240219172904.png]]

![[Pasted image 20240219172928.png]]

After thes we can start either using command docker-compose up -d or by invoking ./run_bahmni.sh

[!info] Once it's running , i see that , if you are making any changes , such as in whiteLable.json, it immediately reflects after refresh, but i think some some contents are being used only at the time of initialization in that case the dependent services needs to be restarted, so that it should reflect.

Working with openmrs-module-bahmniapps

openmrs-module-bahmniapps also has to be done in same way as clinic-config , but here at it's java module we need to build after making changes

[!info] openmrs-module-bahmniapps repository contains most of the frontend code for the Bahmni EMR. It is written in AngularJS with only the Form viewer part utilising React.

1. This repository contains most of the frontend code for the Bahmni EMR. It is written in AngularJS with only the Form viewer part utilising React.
2. See the sub-folder: ui/app/ to understand which all modules of the EMR UI are contained in this codebase.
3. Regarding the decision of migrating away from AngularJS and instead use React, please read this blog writeup: Bahmni EMR - 1 M lines of code
4. This code needs help in migrating to React. If you are interested in helping, please ping the Bahmni team on Slack (#community channel).
5. All Epics, Stories, Bugs, etc are tracked in JIRA: Volunteer Board.
6. To Run Bahmni locally you should use Docker option of Bahmni or Vagrant option. Docker is recommended.

Here also we should use 1.0.0 tag and follow similar steps as we did for clinic-config https://github.com/Bahmni/openmrs-module-bahmniapps

Reference wiki for below instructions https://bahmni.atlassian.net/wiki/spaces/BAH/pages/3117449349/Bahmni-Web+Configurations+docker

git clone https://github.com/Bahmni/openmrs-module-bahmniapps.git

cd openmrs-module-bahmniapps

git checkout 1.0.0

We need to intall build dependencies, i found it little bit compilcated as it's using some older version of ruby and for me somehow ubuntu 22.04 was not supporting it.

One time installation:

These steps need to performed ONLY the FIRST TIME you set up this code.

1. Install node/npm (node version: 10.11.0). Preferably use nvm, so that you have control over which project uses which version of node. See:
   • how to install Node using nvm.
   • how to install NodeJS on mac.
2. Install Yarn: npm install -g yarn
3. Install Grunt: npm install -g grunt-cli
4. Install Compass:
   • Compass compiles SASS/SCSS into CSS.
   • Requires ruby (It's recommended to install ruby also using rvm. See install rvm with ruby).
   • Ruby version: 2.6.6
   • Once ruby is installed, you can install compass using: gem install compass

Build commands

NOTE: Run these commands from within the ui sub-folder.

1. yarn install
2. yarn ci (will internally trigger grunt)
3. If build is successful, the dist folder has the set of files to be deployed in Apache (or in Vagrant).

Docker (Hot Deploy)

1. If you are using Bahmni Docker, then you can hot deploy your app by following these steps: Bahmni Web Configurations Docker (Wiki)

Configuration page

Bahmni wiki has detailed document for configurations, below is the link https://bahmni.atlassian.net/wiki/spaces/BAH/pages/34013647/Configuration+101

[!info] the Configuration 101 is set of confgurations done on bahmni-standard as well as bahmni-lite, as bahmni-lite is subset of bahmni-standard so there may be chances that a particular configuration doesn't apply to it as it might be not using that particular module or in bahmn-lite it might have been implemented in other way

![[Pasted image 20240219181041.png]]