Skip to content

Commit 3bb14ce

Browse files
authored
feat: add getting started page (#6)
Signed-off-by: Christophe Chauvet <christophe.chauvet@gmail.com>
1 parent 9583f80 commit 3bb14ce

17 files changed

+171
-0
lines changed

.vitepress/config.mts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ export default defineConfig({
4444
collapsed: false,
4545
items: [
4646
{ text: 'Overview', link: 'engine' },
47+
{ text: 'Getting started', link: 'engine/getting_started' },
4748
{ text: 'Plugin Guide', link: 'engine/plugins' },
4849
{ text: 'Contributing', link: 'engine/contributing' },
4950
]

docs/engine/getting_started.md

Lines changed: 170 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,170 @@
1+
---
2+
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
5+
---
6+
7+
# Getting started
8+
9+
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.
11+
12+
::: tip INFORMATION
13+
14+
All installers are available at the releases page on GitHub, see [GitHub Releases](https://github.com/OpenIntegrationEngine/engine/releases)
15+
16+
The installers are available in 2 flavors:
17+
18+
* With Java Runtime Environment (JRE)
19+
* Without JRE
20+
:::
21+
22+
## System requirements
23+
24+
The OIE Server operates as a completely self-contained application and does not depend on any external application server.
25+
26+
### Java requirements
27+
28+
The Open Integration Engine requires Java 17+ to work.
29+
30+
### Database requirements
31+
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.
33+
34+
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+
36+
* PostgreSQL
37+
* MySQL
38+
* MariaDB
39+
* Oracle
40+
* SQL Server
41+
42+
## Download and installation
43+
44+
You can download the latest version of Open Integration Engine for your platform at this
45+
[address](https://github.com/OpenIntegrationEngine/engine/releases/latest).
46+
47+
### Windows
48+
49+
::: info
50+
Add Screenshots for windows Installation
51+
52+
Wizard screenshots are similar to Mac OS part
53+
:::
54+
55+
### Mac OS
56+
57+
![Mac OS Installer Package](images/gs_macos_installer-package.png "Mac OS Installer Package")
58+
59+
Double-click to launch the Open Integration Engine Installer
60+
61+
![OIE Installer Welcome Screen](images/gs_macos_install_step_1.png "OIE Installer Welcome Screen")
62+
63+
The welcome screen just resumes the information, just click on `Next`
64+
65+
![OIE Installer License Screen](images/gs_macos_install_step_2.png "OIE Installer License Screen")
66+
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`
69+
70+
![](images/gs_macos_install_step_3.png)
71+
72+
Read this screen information and click on `Next`to continue.
73+
74+
![](images/gs_macos_install_step_4.png)
75+
76+
You can choose another folder if you do not want to install as global package.
77+
78+
::: warning
79+
If you let the default application folder, to launch the oie server, you need to use `sudo` command.
80+
:::
81+
82+
And click on `Next` to start the installation.
83+
84+
![](images/gs_macos_install_step_5.png)
85+
86+
You can display the progress of the installation with this screen
87+
88+
![OIE Installer Summary](images/gs_macos_install_step_6.png "OIE Installer Summary")
89+
90+
This is the final screen of the installer, just click on Finish to close the installer wizard.
91+
92+
Now, open a Terminal and start the OIE server
93+
94+
```shell
95+
sudo /Applications/OpenIntegrationEngine/oieserver
96+
```
97+
98+
During the first launch, the server initializes the database. If the server is launched correctly, you should see the following lines:
99+
100+
```shell
101+
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+
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+
INFO 2026-01-15 20:07:38.776 [Main Server Thread] com.mirth.connect.server.Mirth: Open Integration Engine contributors (c)2025.
104+
INFO 2026-01-15 20:07:38.777 [Main Server Thread] com.mirth.connect.server.Mirth: Running OpenJDK 64-Bit Server VM 17.0.15 on Mac OS X (15.7.3, aarch64), derby, with charset UTF-8.
105+
INFO 2026-01-15 20:07:38.778 [Main Server Thread] com.mirth.connect.server.Mirth: Web server running at http://192.168.1.X:8080/ and https://192.168.1.X:8443/
106+
```
107+
108+
::: tip
109+
Please note these URLs, as we will need them later.
110+
:::
111+
112+
## First launch
113+
114+
To verify if the OIE server is available, open your web browser and enter the URL previously noted.
115+
116+
After confirmed to accept self signed certificate, you will see this page
117+
118+
![OIE Server Welcome Page](images/gs_web_browser_step_1.png "OIE Server Welcome Page")
119+
120+
Copy the Administrator Launcher URL
121+
122+
### Ballista
123+
124+
[Ballista](https://github.com/kayyagari/ballista/releases) is an open-source Administrator launcher for Open Integration Engine based on Tauri.
125+
126+
### MCAL
127+
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.
129+
130+
Go to the Mac Os Launcher and search Mirth, you will see this icon.
131+
132+
![MCAL MacOS Launcher](images/gs_launcher_mcal.png "MCAL MacOS Launcher")
133+
134+
If it's the first launch, the left panel with connections is empty
135+
136+
![MCAL Connections](images/gs_mcal_step_1.png "MCAL Connections")
137+
138+
To work better with OIE, choose `Bundled Java 17`
139+
140+
And just click on `Launch` at the top right screen.
141+
142+
You should see a progress bar that will load the files necessary to launch the Open Integration Engine client.
143+
144+
![OIE Login Screen](images/gs_oie_login_step_1.png "OIE Login Screen")
145+
146+
::: warning
147+
148+
If you use a new instance, the default credentials are:
149+
150+
* login: **admin**
151+
* password: **admin**
152+
:::
153+
154+
After entering your credentials, click on `Login` button.
155+
156+
![](images/gs_oie_login_step_2.png)
157+
158+
After some time, you will see the OIE dashboard.
159+
160+
Now it asks to change the default password
161+
162+
![](images/gs_oie_credential_update_step_1.png)
163+
164+
Fill the information, and don't forget to set the `New Password` ( 2 times)
165+
166+
And click on `Finish`
167+
168+
![](images/gs_oie_dashboard.png)
169+
170+
It's finished, Now you can start to use your OIE server.
54.9 KB
Loading
76.8 KB
Loading
91.8 KB
Loading
94.2 KB
Loading
85.6 KB
Loading
74.6 KB
Loading
91.9 KB
Loading
43.9 KB
Loading

0 commit comments

Comments
 (0)