Skip to content

refactor getting_started.md for better flow and accessibility #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tonygermano merged 1 commit into from
Feb 8, 2026
Merged

refactor getting_started.md for better flow and accessibility #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 44 additions & 46 deletions docs/engine/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
---
title: Open Integration Engine getting started
description: First step to install on Windows and MacOS X and proceed to the first launch
author: Christophe Chauvet
description: First step to install on Windows and macOS and proceed to the first launch
---

# Getting started

To quickly start with Open Integration Engine™️, also called OIE™️ in this documentation,
you can use the different installers available on Windows, Mac OS and Linux platforms.
you can use the different installers available on Windows, macOS, and Linux platforms.

::: tip INFORMATION
::: info

All installers are available at the releases page on GitHub, see [GitHub Releases](https://github.com/OpenIntegrationEngine/engine/releases)

Expand All @@ -29,7 +28,7 @@ The Open Integration Engine requires Java 17+ to work.

### Database requirements

OIE uses an embedded Apache with the Derby database by default, which allows you to store configuration and messages, for the purpose of rapid deployment, development and testing.
OIE uses an embedded Apache Derby database by default, which allows you to store configuration and messages, for the purpose of rapid deployment, development and testing.

For production deployments, it is recommended to use only database versions currently receiving official security and maintenance support from their respective vendors. The following database engines are supported as backends:

Expand All @@ -49,45 +48,41 @@ You can download the latest version of Open Integration Engine for your platform
::: info
Add Screenshots for windows Installation

Wizard screenshots are similar to Mac OS part
Wizard screenshots are similar to macOS part
:::

### Mac OS

![Mac OS Installer Package](images/gs_macos_installer-package.png "Mac OS Installer Package")
### macOS

Double-click to launch the Open Integration Engine Installer
Locate the downloaded .dmg file and double-click the file to mount it.

![OIE Installer Welcome Screen](images/gs_macos_install_step_1.png "OIE Installer Welcome Screen")
A window will open showing the Open Integration Engine Installer. Double-click to launch the Installer Wizard.

The welcome screen just resumes the information, just click on `Next`
![Mac Finder window with arrow indicating Open Integration Engine Installer](images/gs_macos_installer-package.png)

![OIE Installer License Screen](images/gs_macos_install_step_2.png "OIE Installer License Screen")
Click `Next` on the initial Setup screen to move to the License Screen.
![Open Integration Engine Installer Setup window displaying welcome message with Next button highlighted](images/gs_macos_install_step_1.png)

This screen displays the license, to continue you must accept this license by check `I accept the agreement`
and after click on `Next`
To continue you must accept this license by selecting `I accept the agreement` and then click on `Next`.

![](images/gs_macos_install_step_3.png)
![License Screen requesting the user read and accept the Mozilla Public License version 2.0](images/gs_macos_install_step_2.png)

Read this screen information and click on `Next`to continue.
The next screen presents information about the current release. Click on `Next` to continue.

![](images/gs_macos_install_step_4.png)
![Information screen showing details of Open Integration Engine 4.5.2 Release](images/gs_macos_install_step_3.png)

You can choose another folder if you do not want to install as global package.
Choose a destination directory for the installation and click `Next` to start the installation. You can choose another folder if you do not want to install as a global package.

::: warning
If you let the default application folder, to launch the oie server, you need to use `sudo` command.
If you use the default application folder, you will need to use the `sudo` command to launch the OIE server.
:::

And click on `Next` to start the installation.

![](images/gs_macos_install_step_5.png)
![Select Destination Directory screen showing value of /Applications/OpenIntegrationEngine](images/gs_macos_install_step_4.png)

You can display the progress of the installation with this screen
![Installation screen showing progress extracting files and a cancel button](images/gs_macos_install_step_5.png)

![OIE Installer Summary](images/gs_macos_install_step_6.png "OIE Installer Summary")
The last screen informs you that installation is complete. Click `Finish` to close the installer.

This is the final screen of the installer, just click on Finish to close the installer wizard.
![Completion screen prompting user to click Finish to exit Setup](images/gs_macos_install_step_6.png)

Now, open a Terminal and start the OIE server

Expand All @@ -97,7 +92,7 @@ sudo /Applications/OpenIntegrationEngine/oieserver

During the first launch, the server initializes the database. If the server is launched correctly, you should see the following lines:

```shell
```log
INFO 2026-01-15 20:07:38.773 [Main Server Thread] com.mirth.connect.server.Mirth: Open Integration Engine 4.5.2 (Built on July 8, 2025) server successfully started.
INFO 2026-01-15 20:07:38.776 [Main Server Thread] com.mirth.connect.server.Mirth: This product was developed by NextGen Healthcare (https://www.nextgen.com) and its contributors (c)2005-2024.
INFO 2026-01-15 20:07:38.776 [Main Server Thread] com.mirth.connect.server.Mirth: Open Integration Engine contributors (c)2025.
Expand All @@ -113,58 +108,61 @@ Please note these URLs, as we will need them later.

To verify if the OIE server is available, open your web browser and enter the URL previously noted.

After confirmed to accept self signed certificate, you will see this page
After accepting the self-signed certificate in your browser, you will see this page:

![OIE Server Welcome Page](images/gs_web_browser_step_1.png "OIE Server Welcome Page")
![Open Integration Engine Server home Page indicating the service is available with launcher target url and button to explore the Client API](images/gs_web_browser_step_1.png)

Copy the Administrator Launcher URL
Copy the Administrator Launcher URL.

### Ballista

[Ballista](https://github.com/kayyagari/ballista/releases) is an open-source Administrator launcher for Open Integration Engine based on Tauri.
[Ballista](https://github.com/kayyagari/ballista/releases) is an open-source Administrator launcher for Open Integration Engine built on Tauri.

### MCAL

The original Mirth® Connect Administrator Launcher by NextGen Healthcare works with OIE. Here is how you can use it to launch the OIE Administrator client GUI application.
The original Mirth® Connect Administrator Launcher by NextGen Healthcare (MCAL) works with OIE. Here is how you can use it to launch the OIE Administrator client GUI application.

Go to the Mac Os Launcher and search Mirth, you will see this icon.
Go to the macOS Launcher and search Mirth, you will see this icon.

![MCAL MacOS Launcher](images/gs_launcher_mcal.png "MCAL MacOS Launcher")
![Search bar populated with "mirth" with result displaying Mirth Connect Administrator Launcher icon](images/gs_launcher_mcal.png)

If it's the first launch, the left panel with connections is empty
If it's the first launch, the left panel with connections is empty.

![MCAL Connections](images/gs_mcal_step_1.png "MCAL Connections")
![MCAL application window showing "no saved connections" in left panel](images/gs_mcal_step_1.png)

To work better with OIE, choose `Bundled Java 17`

And just click on `Launch` at the top right screen.

You should see a progress bar that will load the files necessary to launch the Open Integration Engine client.

![OIE Login Screen](images/gs_oie_login_step_1.png "OIE Login Screen")

::: warning
## Logging in

::: info
If you use a new instance, the default credentials are:

* login: **admin**
* password: **admin**
:::

After entering your credentials, click on `Login` button.
Enter your credentials and click `Login` when the login screen appears.

![Open Integration Engine Login screen with server field pre-populated and blank username and password](images/gs_oie_login_step_1.png)

Upon successful login, a brief loading screen will display.

![](images/gs_oie_login_step_2.png)
![An indeterminate progress bar with the caption, Please wait: Loading Extensions](images/gs_oie_login_step_2.png)

After some time, you will see the OIE dashboard.

Now it asks to change the default password
Now it asks to change the default password if this is your first time logging in.

![](images/gs_oie_credential_update_step_1.png)
![Edit User screen requesting username, password, and optional demographic information](images/gs_oie_credential_update_step_1.png)

Fill the information, and don't forget to set the `New Password` ( 2 times)
Fill the information, and don't forget to set the `New Password` (2 times)

And click on `Finish`

![](images/gs_oie_dashboard.png)
![Application ready to use at the Dashboard screen showing no deployed channels and the server startup messages in the log section](images/gs_oie_dashboard.png)

It's finished, Now you can start to use your OIE server.
It's finished. Now you can start to use your OIE server.