This guide is valid for the installation of the full modular openIMIS version together with the REST API component.
0. Prerequisite
To install the full modular 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 a
.envfile, providing the following variables:
# database parameters DB_HOST=db DB_PORT=1433 #DB_PORT=5432 DB_PASSWORD=IMISuserP@s DB_USER=IMISuser DB_NAME=IMIS DB_ENGINE=mssql #DB_ENGINE=django.db.backends.postgresql or sql_server.pyodbc ACCEPT_EULA= <y if you accept MS EULA > # urls # url of openimis NEW_OPENIMIS_HOST=demo.openimis.org # http port for openimis GATEWAY_PORT=80 # https port for openimis GATEWAY_PORT_S=443 # github branches to use # Database DB_BRANCH=main #Gate way GW_BRANCH=main # BE assembly BE_BRANCH=main #FE assembly FE_BRANCH=main # REST API RESTAPI_BRANCH=main # branch to get the code of the restapi # build flavours # rest API flavours (used by the mobile) RESTAPI_BUILD_FLAVOR=Release # docker-compose parameters # docker compose project name PROJECT_NAME=demo # to use in case there is multiple openimis, the container have fixed IP address to avoid issue when a container is recreated: then it could change ip and the gateway woin't find it anymore (limitation of free nginx) IP_SUB=20 #one-liner json config for the BE (to override the openimis.json from the BE assembly) #OPENIMIS_BE_CONF_JSON= #one-liner json config for the FE (to override the openimis.json from the FE assembly) #OPENIMIS_FE_CONF_JSON=
on the same level as
openimis-dist_dkrdirectory, create a newconfdirectory (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!):
The default database is the demo instance, to set-up an empty instance please setup the database manual from the script attached to each release sql-files.zip in the asset section
accept the Microsoft EULA for the MSSQL database container (set the value of
ACCEPT_EULAtoY)build and start the docker compose:
docker-compose up -d
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_dkrdirectory or create a ticket.To add a new backend user, you must edit the
/conf/.htpasswdin the gateway container (scripts will be written later).
stop/start
From within openimis-dist_dkr/windows directory:
To stop all docker containers:
docker-compose stopTo (re-)start all docker containers:
docker-compose start