Skip to content

Installation

saragilcas edited this page Mar 19, 2025 · 7 revisions

Installation

MetaData Sync is installed using the built-in App Manager looking for the app "MetaData Synchronization" and clicking on "install". You can also download it from the DHIS2 Hub App.

grafik

Also, the latest release of the application can be found in the releases repository section in zip format. In that GitHub repository you will find all the releases of MetaData Sync.

Once the installation is finished you will be able to access MD Sync app from your applications menu that you can find in the search bar.

Installation/Untitled%201.png

Installing updates

To install an update of the application, please visit the "App Management" app on your DHIS2 instance and click "update". Alternatively, you can upload the updated file from the releases page on GitHub.

Installation/Untitled%202.png

You can check if the application you have installed on your instance is updated by comparing the version number, which is incremental following a major, minor and patch versioning. For example, 2.0.1 is newer than 2.0.0 and 2.1.0 is newer than 2.0.1.

Database upgrades

After updating the application, in some cases it is necessary to upgrade its internal database before being able to use the update. That upgrade procedure is called "migrations" inside the application and will appear before starting the application as a dialog only when these database upgrades are needed.

Installation/Untitled%203.png

Before the update, a backup of the database will be created as a safeguard. Do not close the web browser while the update is in progress.

The migrations should only last a few minutes, but it depends on the complexity of the task and the amount of data you have created inside MD Sync. Once finished you will be allowed to continue using the application.

Installation/Untitled%204.png

Since the migration process is quite delicate, we recommend the user that has updated the application to enter the application and make sure there are no pending migrations. This way any other user that visits MD Sync won't be prompted with these pages.

Clone this wiki locally