Bahmni Using Docker

The following step-by-step guide helps you in installing Bahmni using Docker. Docker is an open platform for developers and system admins to build, ship, and run distributed applications. Following instructions are mainly targeted for Mac OS X and Linux users. But they should work with any operating system that supports Docker.  

Installing Docker

Installing Docker Compose

Installing Bahmni

For the first time, it takes around 15-25 minutes depending on your internet speed.  Please note that it is just for the first time.  Subsequently it will be much faster. If this script fails (in rare cases) to download the images from dockerhub-bahmni, you can manually download the required images based on the required images and rerun "sh bahmni install".

The Bahmni installation comes up with its own MySQL and PostgreSQL database backup.  You will have a fully functional bahmni up and running.

Please note that you will need to do this installation step only once. Subsequently, you can just start and stop bahmni.

Validating your installation

• On Mac OS X / Windows

• On Linux

Starting and Stopping Bahmni

Once the installation is complete, the Bahmni will be started

we can start and stop Bahmni using the following commands:

If you think that you want to re-install everything from scratch, you can run the following command and clean up your setup.  This will remove all the changes that you have done to your database.  You can follow the step to Install Bahmni for installing a fresh instance.

Configuring Bahmni For Development

1. Create a folder at the location ~/bahmni-code

2. Checkout the following projects of bahmni

   1. default-config - https://github.com/Bhamni/default-config.git

   2. openmrs-distro-bahmni - https://github.com/Bhamni/openmrs-distro-bahmni

   3. openmrs-module-bahmniapps - https://github.com/Bhamni/openmrs-module-bahmniapps

3. Build the projects.  

   1. Building openmrs-distro-bahmni - Its a maven project. Run the following command.  It generates the .omod files required for bahmni

   2. Building openmrs-module-bahmniapps. Go inside 

   3. Building bahmni-core omod. Build you changes locally and copy them into docker container, as specified below. ( Optional : Only required if writing code on core.)

1. The docker-compose.yml file available in each profile has a way of linking the Source folders on your laptop to that of the containers.  So, lets say you modify some javascript files in your openmrs-module-bahmniapps then, it gets reflected when you refresh the browser.

Restoring Database ( Optional : Required only when a particular database like JSS, QA is required)

1. For restoring any new MySQL database, place the sql dump file (extracted one - not tar.gz) in ~/bahmni-code/mysql folder.

2. In the docker-compose.yml, add the environment variable STARTUP_SQL.  When the mysql docker container sees this environment variable, it restores the file available at that path.  You will need to restart the docker container for it to pick up the latest database.

    

Tips & Tricks

1. Add the following alias in your .bashrc or .zshrc files.  These provides some smaller alias(es) to frequently used docker commands:

2. The command "docker ps" (or alias dps) will give a list of docker processes running.  The important information is the container id associated with each docker container.

3. The command "docker logs -f <containerid>" will list the docker logs.  This is very useful for debugging (especially the Web Container which has OpenMRS and OpenELIS)

• The command "docker exec -it <containerid> /bin/bash", will take you inside the container.  Think of it like SSHing into the box. You can browse through the folders using this command.

   

  Upgrading docker in Mac