MO1.1 Install openIMIS using Docker

This guide is valid for the installation of the new openIMIS version together with the REST API component.

Video tutorial

0. Prerequisite

To install openIMIS using Docker, you first need first to install Docker on your computer/server. Please visit website to download and install the version that matches your OS.

1. Download openIMIS Docker script

Clone the on your machine into a new folder.

2. First startup

  • Create the .env file from the .env.example and configure the environment variables according to the comments in the file. By default, PostgreSQL database is used.

  • On the same level as openimis-dist_dkr directory, there should be a conf directory that is used for storing instance-specific configuration that will be reused if the docker containers are restarted

  • If you use the demo docker 'db' service:

    • Build and start the docker compose: docker-compose up -d

    • If you prefer to use Microsoft SQL Server database: docker-compose -f docker-compose-mssql.yml up -d

      • Accept the Microsoft EULA (set the value of ACCEPT_EULA to Y, not required for PGSQL)

2. SSL certificate / https

there is a docker-compose that support let’s encrypt certificates


first export NEW_OPENIMIS_HOST ,

dry run

docker-compose run --rm --entrypoint " certbot certonly --webroot -w /var/www/certbot --staging --register-unsafely-without-email -d ${NEW_OPENIMIS_HOST} --rsa-key-size 2048 --agree-tos --force-renewal" certbot

actual setup

docker-compose run --rm --entrypoint " certbot certonly --webroot -w /var/www/certbot --register-unsafely-without-email -d ${NEW_OPENIMIS_HOST} --rsa-key-size 2048 --agree-tos --force-renewal" certbot

3. actions

From within openimis-dist_dkr/windows directory:

  • To stop all docker containers: docker-compose stop 

  • To (re-)start all docker containers: docker-compose start

  • To pull new images or images update `docker-compose pull`



Did you encounter a problem or do you have a suggestion?

Please contact our Service Desk

This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.