Because the legacy openIMIS version is working only on Windows, the following refers to a Docker installation on Windows 10 or Windows Server 2016 (or newer).
Install Docker Desktop
In order to install the modular openIMIS using Docker, you first need to install Docker Desktop. Please download and install the Docker platform from the Docker Desktop website. Make sure to use Windows container (Docker image operating system "windows" cannot be used on this platform).
Download openIMIS Docker script
Download and unzip the release from Github openimis-dist_dkr repository into a new folder.
The first startup is special since it will create the necessary docker images and containers to run openIMIS. To build necessary, docker images, docker-compose relies on local docker files. In order to build these images, you need to clone, next to
openimis-dist_dkr/ the following Github repository:
Or clone the 5 folders with git:
git clone https://github.com/openimis/openimis-dist_dkr.git
git clone https://github.com/openimis/openimis-db_dkr.git
git clone https://github.com/openimis/openimis-be_py.git
git clone https://github.com/openimis/openimis-fe_js.git
git clone https://github.com/openimis/openimis-gateway_dkr.git
DB_SQL_SCRIPT=<URL pointing to the SQL script>
ACCEPT_EULA=<must put Y but it means you accept Microsoft EULA for the MSSQL database container>
DB_NAME=<your database name, imis if you use the demo docker 'db' service>
DB_USER=<your database user, sa if you use the demo docker 'db' service >
DB_PASSWORD=<your database password, generate one if you use the demo docker 'db' service>
NEW_OPENIMIS_HOST=<(sub)domain under which the (new) openIMIS will be served (e.g. openimis.domaine) >
on the same level as
openimis-dist_dkr directory, create a new
conf directory (this 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 (not for production!):
choose the SQL script to create/restore the database in
DB_SQL_SCRIPT. Reference models are provided in the database installation tutorial. Example:
accept the Microsoft EULA for the MSSQL database container (set the value of
build and start the database docker image:
docker-compose up db
create the openIMIS database into the container:
create the database user
build and start the gateway, frontend and backend docker image:
docker-compose up (note: at each start, openIMIS will apply the necessary database migrations to update the database scheme)
If connecting to a brand new database, register your openIMIS superuser:
list running containers and spot the backend:
docker container ls (the gateway should be named
connect to the gateway:
docker exec -it <CONTAINER ID> /bin/bash (bash and not sh this time)
you should be in /openimis-be/openIMIS directory, if not, just
register your openIMIS superuser:
python manage.py createsuperuser (and follow instructions)
Updating the certificates of the frontend is required for production usage
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).