openIMIS Installation & Development Documentation (2026-04)

openIMIS Installation & Development Documentation (2026-04)

openIMIS Installation & Development Documentation (Release 2026-04)

This page is the entry point for a self-contained documentation set covering the installation (development & production, with and without Docker) and the module development process (creating custom modules and customizing existing ones) for openIMIS Release 2026-04.

📚 Contents of this documentation set

#

Page

What it covers

#

Page

What it covers

1

Installation Guide — Development & Production Deployment

The four deployment scenarios: development with Docker, development without Docker, production with Docker (pinned 26.04 tags, HTTPS/certbot, OpenSearch, upgrades), and a production security checklist.

2

Developer Environment Setup

Preparing a workstation: PostgreSQL + openIMIS DB scripts, backend (openimis-be_py) venv setup, frontend (openimis-fe_js) yarn setup, debugging tools, common setup errors.

3

Backend Module Development (Create & Customize)

Module anatomy, create_openimis_module scaffolding (business/calculation templates), manual procedure, editing existing modules with pip install -e / install_module_locally, replacing reference modules, exception handlers.

4

Frontend Module Development (Create & Customize)

Starting from openimis-fe-template_js, yarn link workflow, peerDependencies rule, dev_tools scripts, configuration-based customization (theme, logo, menus), distribution builds.

5

Module Configuration, Translations, Testing & Publishing

openimis.json registration formats, ModuleConfiguration table, i18n (gettext.sh, extract_translations), unit tests with --keepdb, PyPI publishing, release branching, JWT/CSRF security.

6

Production Deployment without Docker (Linux + systemd + Nginx)

Native Linux install: packages, venv, .env production values, systemd service, static frontend bundle, full Nginx reverse-proxy config, certbot TLS, mobile REST API.