|
| 1 | +# Getting started |
| 2 | + |
| 3 | +To quickly start with Open Integration Engine, also called OIE in this documentation, |
| 4 | +You can use the different installers available on Windows, Mac OS and Linux platforms. |
| 5 | + |
| 6 | +::: tip INFORMATION |
| 7 | + |
| 8 | +All installers are available at the release page on github, see [Github Release](https://github.com/OpenIntegrationEngine/engine/releases) |
| 9 | + |
| 10 | +The installers are available in 2 flavors: |
| 11 | + |
| 12 | +* With Java Runtime Environment (JRE) |
| 13 | +* Without JRE |
| 14 | +::: |
| 15 | + |
| 16 | + |
| 17 | +## System requirements |
| 18 | + |
| 19 | +The OIE Server operates as a completely self-contained application and does not depend on any external application server. |
| 20 | + |
| 21 | +### Java requirements |
| 22 | + |
| 23 | +The Open Integration Engine require Java 17+ to work |
| 24 | + |
| 25 | +::: warning |
| 26 | +OIE can work with older versions of Java, but this is not recommended, |
| 27 | +as some extensions may require version 17 to function correctly. |
| 28 | +::: |
| 29 | + |
| 30 | +### Database requirements |
| 31 | + |
| 32 | +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. |
| 33 | + |
| 34 | +However, during a production deployment, it is recommended to use one of the following database engines: |
| 35 | + |
| 36 | +* PostgreSQL and above |
| 37 | +* MySQL 8.0 and above |
| 38 | +* MariaDB 10.11 and above |
| 39 | +* Oracle 18c and above |
| 40 | +* SQL Server 2019 and above |
| 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 | + |
| 48 | +### Windows |
| 49 | + |
| 50 | +::: info |
| 51 | +Add Screenshots for windows Installation |
| 52 | +::: |
| 53 | + |
| 54 | +### Mac OS |
| 55 | + |
| 56 | + |
| 57 | + |
| 58 | +Double-click to launch the Open Integration Engine Installer |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | +The welcome screen just resume the information, just click on `Next` |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | +This screen display the license, to continue you must accept this licence by check `I accept the agrement` |
| 67 | +and after click on `Next` |
| 68 | + |
| 69 | + |
| 70 | + |
| 71 | +Read this screen informations and click on `Next`to continue. |
| 72 | + |
| 73 | + |
| 74 | + |
| 75 | +You can choose another folder if you do not want to install as global package. |
| 76 | + |
| 77 | +::: warning |
| 78 | +If you let the default application folder, to launch the oie server, you need to use `sudo`command. |
| 79 | +::: |
| 80 | + |
| 81 | +And click on `Next` to start the installation. |
| 82 | + |
| 83 | + |
| 84 | + |
| 85 | + |
| 86 | +You can display the progress of the installation with this screen |
| 87 | + |
| 88 | + |
| 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 | +The first time, the server create the default database, if server is launch correctly, you need to display these 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 | +### Linux |
| 113 | + |
| 114 | + |
| 115 | +## First launch |
| 116 | + |
| 117 | +To verify if the OIE server is availble, open your web browser and enter the URL previously noted. |
| 118 | + |
| 119 | +After confirmed to accept self signed certificate, you will see this page |
| 120 | + |
| 121 | + |
| 122 | + |
| 123 | +Copy the Administator Launcher URL |
| 124 | + |
| 125 | +### Ballista |
| 126 | + |
| 127 | +### MCAL |
| 128 | + |
| 129 | +The original Mirth Connect Administrator Launcher works with OIE, you can use it. |
| 130 | + |
| 131 | +Go to the Mac Os Launcher and search Mirth, you will see this icon. |
| 132 | + |
| 133 | + |
| 134 | + |
| 135 | +If it's the first launch, the left panel with connections is empty |
| 136 | + |
| 137 | + |
| 138 | + |
| 139 | +To work better with OIE, choose `Bundled Java 17` |
| 140 | + |
| 141 | +And just click on `Launch`at the top right screen. |
| 142 | + |
| 143 | +You should see a progress bar that will load the files necessary to launch the Open Integration Engine client. |
| 144 | + |
| 145 | + |
| 146 | + |
| 147 | +::: warning |
| 148 | + |
| 149 | +If you use a new instance, the defaults credentials are: |
| 150 | + |
| 151 | +* login: **admin** |
| 152 | +* password: **admin** |
| 153 | +::: |
| 154 | + |
| 155 | +After enter credential, click on `Login` Button |
| 156 | + |
| 157 | + |
| 158 | + |
| 159 | +After some time, you will see the OIE dashboard. |
| 160 | + |
| 161 | +Now it ask to change the default password |
| 162 | + |
| 163 | + |
| 164 | + |
| 165 | +Fill the information, and don't forget to set the `New Password` ( 2 times) |
| 166 | + |
| 167 | +And click on `Finish` |
| 168 | + |
| 169 | + |
| 170 | + |
| 171 | +It's finished, now you can start to use OIE server, |
0 commit comments