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.

Note: Graphical installer is available through the following installation files: .exe, .sh, .dmg .

Access the Mirth® Connect Download Central page using the link Success Community.
Choose the file with label Installer and download it.
The Mirth® Connect installer downloads.
Double-click the downloaded file ( .exe, .sh, .dmg), then open the Mirth® Connect Installer.
On the setup wizard, select Next >.

Note: For upgrades, the default installation option is Yes, update the existing installation. If you would like to install Mirth® Connect to another location, select No, install into a different directory", then select the new location. Hover your cursor over the green question mark to view the current installation directory.
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
Select the options that appear on the Completing the Mirth Connect Setup Wizard window as necessary, then select Finish.

Depending on the options you selected in the setup wizard, the Mirth® Connect Server Manager, the README file, or both appear.
On the License Agreement window, read the license agreement, select I accept the agreement, then select Next >.
On the Before You Begin window, do one of the following:
- For a new installation, select Next.
- 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.
On the Select Destination Directory window, select Browse..., find and select the folder where you would like to install Mirth® Connect, then select Next >.

Note: If you are upgrading a previously installed version of Mirth® Connect, this window is skipped and the application is installed in the existing location.
On the Enter License Key window, enter the license key, if available, then select Next .
Note:
- Starting with version 4.6.0, a valid license key is required to run Mirth® Connect.
- For upgrade, the existing value from mirth.properties displays as the default value.
- If no license key is provided, then click Next>, the wizard skips the Commercial Extensions window and continue to the Select Components window. Mirth® Connect does not start after installation until valid license key is provided
- If valid license key is provided, then click Next>, the wizard continues to the Commercial Extensions window to allow downloading the available extensions based on the license key.
- If invalid license key is provided, then click Next>, this page provides user with reason why key is invalid. User can replace the invalid key or has to check "Continue with invalid License Key" to click Next>.
Important: Possible Invalid key reasons:
- No policy found for given license key
- License is expired
- No activations remaining
- Failed to activate fingerprint
- 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.
  Note: Mirth® Connect will not start after installation until valid license key is provided.
- 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>.
The Mirth Connect 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>.
On the Select Components window, select the Mirth® Connect components you would like to install, then select Next >.

Note: The Mirth® Connect Server component is unavailable because it is not an option. You can select Mirth® Connect Server Manager, Mirth® Connect CLI, or Mirth® Connect Administrator Launcher.
On the Select Extensions window, select Browse..., find and select the extensions you would like to install, then select Next >.
On the Select Start Menu Folder window, select Next >.
On the Select Network Ports window, enter the Web Start and Administrator port values as needed, then select Next >.

Note: For upgrades, the existing values from mirth.properties appear as the default.
On the Password Requirements window, set your password parameters, then select Next >.

Note: For upgrades, the existing values from mirth.properties appear as the default.
On the Select Data Paths window, set the server-settings paths for Application Data and Logs, then select Next >.
On the Install Service window, select Next >.

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

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.

Note: Graphical installer is available through the following installation files: .exe, .sh, .dmg .

Access the Mirth® Connect Download Central page using the link Success Community.
Choose the file with label Installer and download it.
The Mirth® Connect installer downloads.
Double-click the downloaded file ( .exe, .sh, .dmg), then open the Mirth® Connect Installer.
On the setup wizard, select Next >.

Note: For upgrades, the default installation option is Yes, update the existing installation. If you would like to install Mirth® Connect to another location, select No, install into a different directory", then select the new location. Hover your cursor over the green question mark to view the current installation directory.
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
Select the options that appear on the Completing the Mirth Connect Setup Wizard window as necessary, then select Finish.

Depending on the options you selected in the setup wizard, the Mirth® Connect Server Manager, the README file, or both appear.
On the License Agreement window, read the license agreement, select I accept the agreement, then select Next >.
On the Before You Begin window, do one of the following:
- For a new installation, select Next.
- 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.
On the Select Destination Directory window, select Browse..., find and select the folder where you would like to install Mirth® Connect, then select Next >.

Note: If you are upgrading a previously installed version of Mirth® Connect, this window is skipped and the application is installed in the existing location.
On the Enter License Key window, enter the license key, if available, then select Next .
Note:
- Starting with version 4.6.0, a valid license key is required to run Mirth® Connect.
- For upgrade, the existing value from mirth.properties displays as the default value.
- If no license key is provided, then click Next>, the wizard skips the Commercial Extensions window and continue to the Select Components window. Mirth® Connect does not start after installation until valid license key is provided
- If valid license key is provided, then click Next>, the wizard continues to the Commercial Extensions window to allow downloading the available extensions based on the license key.
- If invalid license key is provided, then click Next>, this page provides user with reason why key is invalid. User can replace the invalid key or has to check "Continue with invalid License Key" to click Next>.
Important: Possible Invalid key reasons:
- No policy found for given license key
- License is expired
- No activations remaining
- Failed to activate fingerprint
- 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.
  Note: Mirth® Connect will not start after installation until valid license key is provided.
- 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>.
The Mirth Connect 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>.
On the Select Components window, select the Mirth® Connect components you would like to install, then select Next >.

Note: The Mirth® Connect Server component is unavailable because it is not an option. You can select Mirth® Connect Server Manager, Mirth® Connect CLI, or Mirth® Connect Administrator Launcher.
On the Select Extensions window, select Browse..., find and select the extensions you would like to install, then select Next >.
On the Select Start Menu Folder window, select Next >.
On the Select Network Ports window, enter the Web Start and Administrator port values as needed, then select Next >.

Note: For upgrades, the existing values from mirth.properties appear as the default.
On the Password Requirements window, set your password parameters, then select Next >.

Note: For upgrades, the existing values from mirth.properties appear as the default.
On the Select Data Paths window, set the server-settings paths for Application Data and Logs, then select Next >.
On the Install Service window, select Next >.

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

Install Mirth® Connect Using the Mirth Connect Installer

Recommendations

Using Docker Images

The Mirth® Connect Server Manager

Mirth® Connect Administrator Overview

Install Mirth® Connect Using the Command-Line Installer

Getting Started with Mirth® Connect

Install Mirth® Connect Using the Quiet Mode

Install Mirth® Connect Using the Mirth Connect Installer

Using Docker Images

The Mirth® Connect Server Manager

Mirth® Connect Administrator Overview

Install Mirth® Connect Using the Command-Line Installer

Getting Started with Mirth® Connect

Install Mirth® Connect Using the Quiet Mode