You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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>
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
5
4
---
6
5
7
6
# Getting started
8
7
9
8
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.
11
10
12
-
::: tip INFORMATION
11
+
::: info
13
12
14
13
All installers are available at the releases page on GitHub, see [GitHub Releases](https://github.com/OpenIntegrationEngine/engine/releases)
15
14
@@ -29,7 +28,7 @@ The Open Integration Engine requires Java 17+ to work.
29
28
30
29
### Database requirements
31
30
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.
33
32
34
33
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:
35
34
@@ -49,45 +48,41 @@ You can download the latest version of Open Integration Engine for your platform
49
48
::: info
50
49
Add Screenshots for windows Installation
51
50
52
-
Wizard screenshots are similar to Mac OS part
51
+
Wizard screenshots are similar to macOS part
53
52
:::
54
53
55
-
### Mac OS
56
-
57
-

54
+
### macOS
58
55
59
-
Double-click to launch the Open Integration Engine Installer
56
+
Locate the downloaded .dmg file and double-click the file to mount it.
Click `Next` on the initial Setup screen to move to the License Screen.
63
+

66
64
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`.
69
66
70
-

67
+

71
68
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.
73
70
74
-

71
+

75
72
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.
77
74
78
75
::: 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.
80
77
:::
81
78
82
-
And click on `Next` to start the installation.
83
-
84
-

79
+

85
80
86
-
You can display the progress of the installation with this screen
81
+

During the first launch, the server initializes the database. If the server is launched correctly, you should see the following lines:
99
94
100
-
```shell
95
+
```log
101
96
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.
102
97
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.
103
98
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.
113
108
114
109
To verify if the OIE server is available, open your web browser and enter the URL previously noted.
115
110
116
-
After confirmed to accept selfsigned certificate, you will see this page
111
+
After accepting the self-signed certificate in your browser, you will see this page:
117
112
118
-

113
+

119
114
120
-
Copy the Administrator Launcher URL
115
+
Copy the Administrator Launcher URL.
121
116
122
117
### Ballista
123
118
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.
125
120
126
121
### MCAL
127
122
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.
129
124
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.
If you use a new instance, the default credentials are:
149
143
150
144
* login: **admin**
151
145
* password: **admin**
152
146
:::
153
147
154
-
After entering your credentials, click on `Login` button.
148
+
Enter your credentials and click `Login` when the login screen appears.
149
+
150
+

151
+
152
+
Upon successful login, a brief loading screen will display.
155
153
156
-

154
+

157
155
158
156
After some time, you will see the OIE dashboard.
159
157
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.
161
159
162
-

160
+

163
161
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)
165
163
166
164
And click on `Finish`
167
165
168
-

166
+

169
167
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