-
Notifications
You must be signed in to change notification settings - Fork 6
feat: add getting started page #6
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.
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,173 @@ | ||||||||||||||||||||||||||||||
| # 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. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ::: tip INFORMATION | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| All installers are available at the release page on GitHub, see [GitHub Release](https://github.com/OpenIntegrationEngine/engine/releases) | ||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| The installers are available in 2 flavors: | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| * With Java Runtime Environment (JRE) | ||||||||||||||||||||||||||||||
| * Without JRE | ||||||||||||||||||||||||||||||
| ::: | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ## System requirements | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| The OIE Server operates as a completely self-contained application and does not depend on any external application server. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ### Java requirements | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| The Open Integration Engine requires Java 17+ to work | ||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ::: warning | ||||||||||||||||||||||||||||||
| OIE can work with older versions of Java, but this is not recommended, | ||||||||||||||||||||||||||||||
| as some extensions may require version 17 to function correctly. | ||||||||||||||||||||||||||||||
| ::: | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|
Comment on lines
+25
to
+29
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
We've already said above that it requires Java 17+. I don't think it's necessary to mention in the quick start guide that it's possible to run the server in an unsupported manner. |
||||||||||||||||||||||||||||||
| ### Database requirements | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| OIE comes with the Derby database by default, which allows you to store configuration and messages, for the purpose of rapid deployment, development and testing. | ||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| However, during a production deployment, it is recommended to use one of the following database engines: | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| * PostgreSQL and above | ||||||||||||||||||||||||||||||
| * MySQL 8.0 and above | ||||||||||||||||||||||||||||||
| * MariaDB 10.11 and above | ||||||||||||||||||||||||||||||
| * Oracle 18c and above | ||||||||||||||||||||||||||||||
| * SQL Server 2019 and above | ||||||||||||||||||||||||||||||
|
Comment on lines
+34
to
+40
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
I think we should avoid specifying versions in this documentation, as it can become outdated relatively quickly. |
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ## Download and installation | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| You can download the latest version of Open Integration Engine for your platform at this | ||||||||||||||||||||||||||||||
| [address](https://github.com/OpenIntegrationEngine/engine/releases/latest). | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ### Windows | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ::: info | ||||||||||||||||||||||||||||||
| Add Screenshots for windows Installation | ||||||||||||||||||||||||||||||
| ::: | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ### Mac OS | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| Double-click to launch the Open Integration Engine Installer | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| The welcome screen just resumes the information, just click on `Next` | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| This screen displays the license, to continue you must accept this license by check `I accept the agreement` | ||||||||||||||||||||||||||||||
| and after click on `Next` | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| Read this screen information and click on `Next`to continue. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| You can choose another folder if you do not want to install as global package. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ::: warning | ||||||||||||||||||||||||||||||
| If you let the default application folder, to launch the oie server, you need to use `sudo` command. | ||||||||||||||||||||||||||||||
| ::: | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| And click on `Next` to start the installation. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| You can display the progress of the installation with this screen | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| This is the final screen of the installer, just click on Finish to close the installer wizard. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| Now, open a Terminal and start the OIE server | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ```shell | ||||||||||||||||||||||||||||||
| sudo /Applications/OpenIntegrationEngine/oieserver | ||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| The first time, the server creates the default database. If server is launched correctly, you shoud see. the following lines: | ||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ```shell | ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
| 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/ | ||||||||||||||||||||||||||||||
| ``` | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ::: tip | ||||||||||||||||||||||||||||||
| Please note these URLs, as we will need them later. | ||||||||||||||||||||||||||||||
| ::: | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ### Linux | ||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There is no content under this heading. |
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ## First launch | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| 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 | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| Copy the Administrator Launcher URL | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ### Ballista | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
kryskool marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||||||||||||
| [Ballista](https://github.com/kayyagari/ballista/releases) is the web-based administration interface for Open Integration Engine based on Tauri. | ||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ### MCAL | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| The original Mirth Connect Administrator Launcher works with OIE, you can use it. | ||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| Go to the Mac Os Launcher and search Mirth, you will see this icon. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| If it's the first launch, the left panel with connections is empty | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| 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. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| ::: warning | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| If you use a new instance, the defaults credentials are: | ||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| * login: **admin** | ||||||||||||||||||||||||||||||
| * password: **admin** | ||||||||||||||||||||||||||||||
| ::: | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| After entering your credentials, click on `Login` button. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| After some time, you will see the OIE dashboard. | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| Now it asks to change the default password | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| Fill the information, and don't forget to set the `New Password` ( 2 times) | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| And click on `Finish` | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
|  | ||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||
| It's finished, now you can start to use OIE server, | ||||||||||||||||||||||||||||||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||||||||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.