Skip to content

Upgrading

Jump to bottom
jdo edited this page Sep 10, 2024 · 22 revisions

Before you upgrade

Before upgrading, we highly recommend that you backup both your Mirth Connect Server Configuration and your Mirth Connect database.

  1. Backup server configuration: Before proceeding, it's important that you backup your existing server configuration. This can be done through the Mirth Connect Administrator under Settings. The server configuration includes channels, code templates, alerts, and global scripts. User accounts and stored messages will not be backed up.
  2. Backup database: If you are using the embedded Derby database, create a backup of the $MIRTH_HOME/mirthdb. If you are using an external database (ex. PostgreSQL, MySQL), create a backup of your database using your preferred database administration tool (ex. pgAdmin, MySQL Administrator).

Changes to some custom configuration files may need to be manually copied over after the upgrade. If you've made changes to any of the following files, copy them to a location outside of your existing $MIRTH_HOME directory before running the new Mirth Connect installer. Once Mirth Connect is upgraded, you will need to update the newly installed files with your custom changes.

  1. Custom database drivers: If you have added custom database drivers they will be preserved in custom-lib during the upgrade. However, you will need to back up your additions to $MIRTH_HOME/conf/dbdrivers.xml
  2. Java JVM parameters: If you have added any Java JVM parameters or changed any of the default heap size settings, create a backup of any $MIRTH_HOME/*.vmoptions files
  3. Logger settings: If you have made any changes to your logger settings, create a backup of $MIRTH_HOME/conf/log4j.properties
  4. CLI configuration: If you have made any changes to the CLI configuration file, create a backup of $MIRTH_HOME/conf/mirth-cli-config.properties

NOTE: Custom extensions may not work after the upgrade and you may see errors in the log. You will need to install an updated extension that is compatible with the new version of Mirth Connect.

$MIRTH_HOME refers to the Mirth Connect installation directory.

Upgrading

  1. Make sure that you have exited and stopped the Mirth Connect Administrator, Server Manager, and Server/Service before proceeding.
  2. Run and complete the new Mirth Connect installer, choosing the update option using the same installation directory.

After the upgrade

  1. Java JVM parameters: Restore the changes in your backed up *.vmoptions files to the corresponding *.vmoptions files in $MIRTH_HOME.
  2. Logger settings: Set any properties you changed in your backed up $MIRTH_HOME/conf/log4j.properties manually.
  3. CLI configuration: Restore the changes in your backed up $MIRTH_HOME/conf/mirth-cli-config.properties file.
  4. Start/Restart the server
  5. Custom extensions: Install new versions of any custom extensions

Version-specific upgrade instructions

If you are upgrading to one of the versions listed below, please click to see version-specific upgrade instructions. If you are upgrading through multiple versions, be sure to review all version upgrade instructions that you are upgrading through:

Clone this wiki locally