Skip to content

Commit 599cd3f

Browse files
committed
docs: refactor getting_started.md for better flow and accessibility
- Standardize branding to 'macOS' across the document. - Improve narrative flow of interleaved instructions and screenshots. - Add descriptive Alt Text to all images for better accessibility. - Fix grammar and typos (e.g., "After confirmed to accept" -> "After accepting"). - Update code block syntax for logs (`log` language identifier). - Clarify steps for mounting the macOS installer and accepting the license. - Remove redundant author frontmatter (so as to not need to maintain this metadata and to encourage multiple authors, the git history should be used to determine authorship.) Signed-off-by: Tony Germano <tony@germano.name>
1 parent f0f8788 commit 599cd3f

File tree

1 file changed

+44
-46
lines changed

1 file changed

+44
-46
lines changed

docs/engine/getting_started.md

Lines changed: 44 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
---
22
title: Open Integration Engine getting started
3-
description: First step to install on Windows and MacOS X and proceed to the first launch
4-
author: Christophe Chauvet
3+
description: First step to install on Windows and macOS and proceed to the first launch
54
---
65

76
# Getting started
87

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

12-
::: tip INFORMATION
11+
::: info
1312

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

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

3029
### Database requirements
3130

32-
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.
31+
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.
3332

3433
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:
3534

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

52-
Wizard screenshots are similar to Mac OS part
51+
Wizard screenshots are similar to macOS part
5352
:::
5453

55-
### Mac OS
56-
57-
![Mac OS Installer Package](images/gs_macos_installer-package.png "Mac OS Installer Package")
54+
### macOS
5855

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

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

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

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

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

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

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

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

76-
You can choose another folder if you do not want to install as global package.
73+
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.
7774

7875
::: warning
79-
If you let the default application folder, to launch the oie server, you need to use `sudo` command.
76+
If you use the default application folder, you will need to use the `sudo` command to launch the OIE server.
8077
:::
8178

82-
And click on `Next` to start the installation.
83-
84-
![](images/gs_macos_install_step_5.png)
79+
![Select Destination Directory screen showing value of /Applications/OpenIntegrationEngine](images/gs_macos_install_step_4.png)
8580

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

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

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

9287
Now, open a Terminal and start the OIE server
9388

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

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

100-
```shell
95+
```log
10196
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.
10297
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.
10398
INFO 2026-01-15 20:07:38.776 [Main Server Thread] com.mirth.connect.server.Mirth: Open Integration Engine contributors (c)2025.
@@ -113,58 +108,61 @@ Please note these URLs, as we will need them later.
113108

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

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

118-
![OIE Server Welcome Page](images/gs_web_browser_step_1.png "OIE Server Welcome Page")
113+
![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)
119114

120-
Copy the Administrator Launcher URL
115+
Copy the Administrator Launcher URL.
121116

122117
### Ballista
123118

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

126121
### MCAL
127122

128-
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.
123+
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.
129124

130-
Go to the Mac Os Launcher and search Mirth, you will see this icon.
125+
Go to the macOS Launcher and search Mirth, you will see this icon.
131126

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

134-
If it's the first launch, the left panel with connections is empty
129+
If it's the first launch, the left panel with connections is empty.
135130

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

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

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

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

144-
![OIE Login Screen](images/gs_oie_login_step_1.png "OIE Login Screen")
145-
146-
::: warning
139+
## Logging in
147140

141+
::: info
148142
If you use a new instance, the default credentials are:
149143

150144
* login: **admin**
151145
* password: **admin**
152146
:::
153147

154-
After entering your credentials, click on `Login` button.
148+
Enter your credentials and click `Login` when the login screen appears.
149+
150+
![Open Integration Engine Login screen with server field pre-populated and blank username and password](images/gs_oie_login_step_1.png)
151+
152+
Upon successful login, a brief loading screen will display.
155153

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

158156
After some time, you will see the OIE dashboard.
159157

160-
Now it asks to change the default password
158+
Now it asks to change the default password if this is your first time logging in.
161159

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

164-
Fill the information, and don't forget to set the `New Password` ( 2 times)
162+
Fill the information, and don't forget to set the `New Password` (2 times)
165163

166164
And click on `Finish`
167165

168-
![](images/gs_oie_dashboard.png)
166+
![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)
169167

170-
It's finished, Now you can start to use your OIE server.
168+
It's finished. Now you can start to use your OIE server.

0 commit comments

Comments
 (0)