Versions Compared

Key

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

Video tutorial

Widget Connector
overlayyoutube
_templatecom/atlassian/confluence/extra/widgetconnector/templates/youtube.vm
width400px
urlhttps://www.youtube.com/watch?v=e0nhczKMHhw&feature=youtu.be
height300px

https://youtu.be/e0nhczKMHhw

Excerpt

This guide is valid for the installation of the full modular new 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 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 On the same level as openimis-dist_dkr directory, there should be a conf directory (this that is used for storing instance-specific configuration that will be reused if the docker containers are restarted)

  • if 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_EULA to Y)

  • build

    :

    • Build and start the docker compose: docker-compose up -d(or for Microsoft

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

  • 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

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

3. 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

4. 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`