NextGen Knowledge Center

Install Mirth® Connect Using the Mirth Connect Installer

You can use the Mirth® Connect Installer (for Windows, Linux, and Mac OS X / macOS) to install Mirth® Connect or to upgrade a previous version of the software installed on your system.
You can download the Mirth® Connect Installer by logging on to your Success Community account and access the Mirth® Connect Download Central knowledge page. Mirth® Connect is also available via Docker images. See Using Docker Images for more information.
  1. Access the Mirth® Connect Download Central page using the link Success Community.
  2. Choose the file with label Installer and download it.
    The Mirth® Connect installer downloads.
  3. Double-click the downloaded file ( .exe, .sh, .dmg), then open the Mirth® Connect Installer.
    An image of the Installer file icon

  4. On the setup wizard, select Next >.
    An image of the Welcome screen for the Setup Wizard.

  5. Follow the wizard for installation. The steps are:
    • License Agreement
    • Before You Begin
    • Select Destination Directory (new install only)
    • Enter License Key
    • Commercial Extensions
    • Select Components
    • Select Extensions
    • Select Application Shortcut (new install only)
    • Select Network Ports
    • Password Requirements
    • Select Data Paths
    • Install Service
  6. Select the options that appear on the Completing the Mirth Connect Setup Wizard window as necessary, then select Finish.
    An image of the Setup Complete window of the Setup Wizard.

    Depending on the options you selected in the setup wizard, the Mirth® Connect Server Manager, the README file, or both appear.
    An image of the readme file.

  7. On the License Agreement window, read the license agreement, select I accept the agreement, then select Next >.
    An image of the License Agreement window of the Setup Wizard.

  8. On the Before You Begin window, do one of the following:
    • For a new installation, select Next.
      An image of the Before You Begin window of the Setup Wizard for a new installation.

    • For an upgrade, review the links for upgrading, getting started, and release notes as needed. After you have enough information for an upgrade, select I have reviewed the information, and then select Next.
      An image of the Before You Begin window of the Setup Wizard for an upgrade.

  9. On the Select Destination Directory window, select Browse..., find and select the folder where you would like to install Mirth® Connect, then select Next >.
    An image of the License Agreement window of the Setup Wizard.

  10. On the Enter License Key window, enter the license key, if available, then select Next .
    An image of the Enter License Key screen of the Setup Wizard.

    • Starting with version 4.6.0, a valid license key is required to run Mirth® Connect
    • For upgrades, the existing value from mirth.properties appears as the default.
    • If no license key is provided, select Next>, the wizard will skip the Commercial Extensions window and continue to the Select Components dialog.
    • If valid license key is provided, select Next>. The wizard continues to the Commercial Extensions window to download the available extensions based on the license key.
    • If an invalid license key is provided, when you select Next>, the window provides you with the reason the key is invalid. You can replace the invalid key or select Continue with invalid License Key and select Next>.
  11. The Commercial Extensions window lists all available extensions in order alphabetically by package (silver, enterprise, gold, platinum). For new installations, all allowed extensions are pre-selected, by default. For upgrades, previously installed extensions are selected, by default. Based on the license key, other extensions may be available for installation. Select Next>.
    Image of the Commercial Extensions window of the setup wizard

  12. On the Select Components window, select the Mirth® Connect components you would like to install, then select Next >.
    An image of the Select Components window of the Setup Wizard.

  13. On the Select Extensions window, select Browse..., find and select the extensions you would like to install, then select Next >.
    An image of the Select Extensions screen of the Setup Wizard.

  14. On the Select Start Menu Folder window, select Next >.
    An image of the Select Start Menu Folder window of the Setup Wizard.

  15. On the Select Network Ports window, enter the Web Start and Administrator port values as needed, then select Next >.
    An image of the Server Settings - Network Ports window of the Setup Wizard.

  16. On the Password Requirements window, set your password parameters, then select Next >.
    An image of the Security Settings - Password Requirements window of the Setup Wizard.

  17. On the Select Data Paths window, set the server-settings paths for Application Data and Logs, then select Next >.
    An image of the Server Settings - Paths window of the Setup Wizard.

  18. On the Install Service window, select Next >.
    An image of the Server Settings - Service window of the Setup Wizard.

    Mirth® Connect begins to install.

    After the Mirth® Connect installation completes, the Completing the Mirth Connect Setup Wizard window appears.