Application Data Directory

Mirth® Connect by NextGen Healthcare User Guide

Configuration Directory

This directory contains the main configuration files Mirth® Connect needs in order to start up correctly. Modifying the configuration requires a restart of Mirth® Connect. The following files are found here: dbdrivers.xml File log4j2.properties File log4j2-cli.properties File mirth.properties File mirth-cli-config.properties File dbdrivers.xml File log4j2.properties File The log4j2.properties file specifies where to write log files to and how verbose the logs should be. log4j2-cli.properties File The log4j2-cli.properties files is the same as the log4j2.properties file, except that it is specific to the Command Line Interface. mirth.properties File is the main configuration file that tells Mirth® Connect where to store application data, what web server ports to listen on, and which database to connect to. mirth-cli-config.properties File Parent topic: Installation Directory

Mirth® Connect by NextGen Healthcare User Guide

temp

This stores all temporary files created by the Mirth® Connect server. Note that usually the name of this file is "temp" and it resides inside of appdata, but the name and location can be modified from mirth.properties File. Parent topic: Application Data Directory

Mirth® Connect by NextGen Healthcare User Guide

keystore.jks

This is a critical file that stores your server's local certificate keypair (for the web server and API), and also the secret key used for encrypting message data, exports, and anything else. Note that usually the name of this file is "keystore.jks" and it resides inside of appdata, but the keystore name and location can be modified from mirth.properties File. Warning: If you plan on making any changes to this file, BACK IT UP first! If you lose this file, any data (messages, exports, etc.) encrypted with it will be lost forever! Changing The Server Certificate When Mirth® Connect starts up for the first time, it will automatically create a new self-signed certificate, which it will use for web server and secure API access. After installing Mirth® Connect, you should replace this with an appropriate company certificate signed by a Certificate Authority (CA). Use the following steps to install a new certificate: BACK UP your current keystore.jks file. Have your new keypair ready to impo

Mirth® Connect by NextGen Healthcare User Guide

Before You Upgrade

Before upgrading, NextGen Healthcare highly recommends that you backup both your Mirth® Connect Server Configuration and your Mirth® Connect database using the following steps. Note: mirth_home directory. Backup server configuration: Before proceeding, it is important that you backup your existing server configuration. This can be done through the Mirth Connect Administrator (Settings>Server Tab>Server Tasks – Backup Config). The server configuration includes channels, code templates, alerts, and global scripts. User accounts and stored messages will not be backed up. Backup database: If you use the embedded Derby database, create a backup of the "mirth_home/appdata/mirthdb" folder. Note that appdata is the database folder as defined in the "mirth_home/conf/mirth.properties" file. For additional information, see mirth.properties File. If you use an external database (for example, PostgreSQL, MySQL), create a backup of your database using your preferred database administration tool (for

Mirth® Connect by NextGen Healthcare User Guide

Installation Directory

In general, the principle of least privilege should be followed, and only Administrators should have access to the installation directory that Mirth® Connect is installed into. If installed on a dedicated machine, that machine should only be accessible to said administrators. If installed on a shared machine, it should be done in such a way that the Connect installation directory is only accessible by administrators. Notes on specific folders inside the installation directory: appdata: The Application Data Directory stores configuration and temporary files used by Mirth® Connect during runtime. Take note of: configuration.properties: By default this file is used to store the current state of the Configuration Map. However in mirth properties you can choose to store the configuration map in the database, or you can select a different file location. For example if you have a separate network storage location specifically for secure files, you could choose to store the configuration map f

Mirth® Connect by NextGen Healthcare User Guide

Other Files and Folders

The various files and folders present in the installation directory are used to contain application configuration files and other executables. Other files and folders present in the Installation Directory include the following: cli-lib: Libraries used by the Command Line Interface. These should not be changed. client-lib: Libraries used by the Mirth Connect Administrator. These should not be changed. custom-lib: Custom libraries can be dropped in this folder, to be used by the default library resource. docs: Contains license information for Mirth® Connect and all third-party libraries. Also contains the Javadoc documentation used by User API. extensions: Extension libraries used by the Server, Administrator, and CLI. These should not be changed. logs: This is the default location that server logs will be written into. This can be changed from the log4j2.properties file. manager-lib: Libraries used by the Server Manager. These should not be changed. mccommand(.exe): The entrypoint scrip

Application Data Directory

Recommendations

Configuration Directory

temp

keystore.jks

Before You Upgrade

Installation Directory

Other Files and Folders

Configuration Directory

temp

keystore.jks

Before You Upgrade

Installation Directory

Other Files and Folders