Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

First startup

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:

Code Block
git clone
git clone
git clone
git clone
git clone

From within openimis-dist_dkr/windows directory:

  • create a .env file, providing the following variables:

Code Block
 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:

      • Empty database: 

      • Demo database:

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

    • build and start the database docker image: docker-compose up db

    • create the openIMIS database into the container:

      • docker container ls and spot the line (CONTAINER ID) with openimis-db IMAGE name

      • docker exec <CONTAINER ID> /create_database.bat

    • create the database user

      • docker exec <CONTAINER ID> /create_user_db.bat

  • 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 openimis-backend)

    • 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 cd /openimis-be/openIMIS)

    • register your openIMIS superuser: python createsuperuser (and follow instructions)

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

  • 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).


From within openimis-dist_dkr/windows directory:

  • To stop all docker containers: docker-compose stop 

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