note

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

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

Video tutorial

https://youtu.be/e0nhczKMHhw

0. Prerequisite

To install openIMIS using Docker, you first need first to install Docker on your computer/server. Please visit https://docs.docker.com/get-docker/ website to download and install the version that matches your OS.

1. Download openIMIS Docker script

Clone the https://github.com/openimis/openimis-dist_dkr 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:

    • The default database is the demo instance. To set-up an empty instance, please setup the database manually from the script attached to https://github.com/openimis/database_ms_sqlserver/releases sql-files.zip in the asset section

    • Accept the Microsoft EULA for the MSSQL database container (set the value of ACCEPT_EULA to Y)

    • 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

  • Updating the certificates of the frontend is required for production usage openimis-gateway_dkr/certs/.

note

  • Using the docker database is not advised for production.

  • This docker-compose doesn’t use REDIS and Celery. If multi-backend is required, please check the docker-compose in the openimis-dist_dkr directory or create a ticket.

  • To add a new backend user, you must edit the /conf/.htpasswd in the gateway container (scripts will be written later).

  • Using the docker database is not advised for production.

  • This docker-compose doesn’t use REDIS and Celery. If multi-backend is required, please check the docker-compose in the openimis-dist_dkr directory or create a ticket.

  • To add a new backend user, you must edit the /conf/.htpasswd in the gateway container (scripts will be written later).

stop/start

From within openimis-dist_dkr/windows directory:

  • To stop all docker containers: docker-compose stop 

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