Skip to content

Commit 88b1dd5

Browse files
tibisabautibisabau
committed
Add Installation next steps Readme popup
1 parent 7c85593 commit 88b1dd5

File tree

2 files changed

+269
-0
lines changed

2 files changed

+269
-0
lines changed

‎tools/install4j/oie-installer-config.install4j‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -437,6 +437,19 @@ return true;
437437
</formComponents>
438438
</screen>
439439
<screen id="20" beanClass="com.install4j.runtime.beans.screens.FinishedScreen" styleId="7" rollbackBarrierExitCode="0" finishScreen="true">
440+
<actions>
441+
<action id="169" beanClass="com.install4j.runtime.beans.actions.desktop.ShowFileAction" rollbackBarrierExitCode="0" errorMessage="">
442+
<serializedBean>
443+
<property name="description" type="string">Show post-installation next steps</property>
444+
<property name="file">
445+
<object class="com.install4j.api.beans.ExternalFile">
446+
<string>${compiler:installer:mediaRoot}/tools/install4j/post-install-next-steps.html</string>
447+
</object>
448+
</property>
449+
</serializedBean>
450+
<condition>!context.isConsole()</condition>
451+
</action>
452+
</actions>
440453
<formComponents>
441454
<formComponent id="21" beanClass="com.install4j.runtime.beans.formcomponents.MultilineLabelComponent" insetBottom="10">
442455
<serializedBean>

‎tools/install4j/post-install-next-steps.html‎

Lines changed: 256 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,256 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="UTF-8">
5+
<style>
6+
body {
7+
font-family: Arial, sans-serif;
8+
line-height: 1.6;
9+
margin: 2em;
10+
background-color: white;
11+
color: black;
12+
max-width: 800px;
13+
}
14+
h1 {
15+
color: #2c5aa0;
16+
border-bottom: 2px solid #2c5aa0;
17+
padding-bottom: 10px;
18+
}
19+
h2 {
20+
color: #2c5aa0;
21+
margin-top: 30px;
22+
}
23+
h3 {
24+
color: #333;
25+
margin-top: 20px;
26+
}
27+
.platform-section {
28+
background-color: #f5f5f5;
29+
padding: 15px;
30+
margin: 15px 0;
31+
border-radius: 5px;
32+
border-left: 4px solid #2c5aa0;
33+
}
34+
code {
35+
background-color: #e8e8e8;
36+
padding: 2px 6px;
37+
border-radius: 3px;
38+
font-family: 'Courier New', monospace;
39+
}
40+
.important {
41+
background-color: #fff3cd;
42+
padding: 12px;
43+
border-left: 4px solid #ffc107;
44+
margin: 15px 0;
45+
}
46+
.success {
47+
background-color: #d4edda;
48+
padding: 12px;
49+
border-left: 4px solid #28a745;
50+
margin: 15px 0;
51+
}
52+
ul {
53+
margin: 10px 0;
54+
padding-left: 25px;
55+
}
56+
li {
57+
margin: 8px 0;
58+
}
59+
a {
60+
color: #2c5aa0;
61+
text-decoration: none;
62+
}
63+
a:hover {
64+
text-decoration: underline;
65+
}
66+
.command {
67+
background-color: #2d2d2d;
68+
color: #f8f8f2;
69+
padding: 10px;
70+
border-radius: 3px;
71+
font-family: 'Courier New', monospace;
72+
margin: 10px 0;
73+
overflow-x: auto;
74+
}
75+
</style>
76+
</head>
77+
<body>
78+
<h1>🎉 Installation Complete - Next Steps</h1>
79+
80+
<div class="success">
81+
<strong>Congratulations!</strong> Open Integration Engine has been successfully installed on your system.
82+
</div>
83+
84+
<h2>📋 What's Next?</h2>
85+
86+
<h3>Step 1: Start the Server</h3>
87+
88+
<p>Depending on your operating system, follow these instructions to start the Open Integration Engine server:</p>
89+
90+
<div class="platform-section">
91+
<h3>🪟 Windows</h3>
92+
<p><strong>Option A: Using the Service (Recommended)</strong></p>
93+
<ul>
94+
<li>The OIE service is installed and configured to start automatically</li>
95+
<li>After installation completes, the service will start automatically</li>
96+
<li>To manually manage the service:
97+
<ul>
98+
<li>Open Services (<code>services.msc</code>) or use the Server Manager</li>
99+
<li>Find "Open Integration Engine Service"</li>
100+
<li>Right-click and select "Start", "Stop", or "Restart"</li>
101+
</ul>
102+
</li>
103+
</ul>
104+
105+
<p><strong>Option B: Using PowerShell/Command Line</strong></p>
106+
<div class="command">sc start oieservice</div>
107+
<p>Or navigate to the installation directory and run:</p>
108+
<div class="command">.\oieserver.ps1</div>
109+
</div>
110+
111+
<div class="platform-section">
112+
<h3>🍎 macOS</h3>
113+
<p><strong>Using the Service (Recommended)</strong></p>
114+
<ul>
115+
<li>The OIE service is installed and configured to start automatically</li>
116+
<li><strong>Important:</strong> A system reboot is required for the service to start automatically</li>
117+
<li>Alternatively, you can start the server manually from the installation directory:</li>
118+
</ul>
119+
<div class="command">./oieserver</div>
120+
</div>
121+
122+
<div class="platform-section">
123+
<h3>🐧 Linux</h3>
124+
<p><strong>Option A: Using systemd (Recommended)</strong></p>
125+
<ul>
126+
<li>The OIE service is installed and configured to start automatically</li>
127+
<li>To manually manage the service:</li>
128+
</ul>
129+
<div class="command">sudo systemctl start oieservice<br>sudo systemctl status oieservice</div>
130+
131+
<p><strong>Option B: Manual Start</strong></p>
132+
<p>Navigate to the installation directory and run:</p>
133+
<div class="command">./oieserver</div>
134+
</div>
135+
136+
<h3>Step 2: Access the Administrator Console</h3>
137+
138+
<p>Once the server is running, you can access the Administrator Console:</p>
139+
140+
<ul>
141+
<li><strong>Web Browser:</strong> Navigate to <a href="http://localhost:8080">http://localhost:8080</a></li>
142+
<li>Click the <strong>"Launch Administrator"</strong> button</li>
143+
<li>This will download and launch the administrator client application</li>
144+
</ul>
145+
146+
<div class="platform-section">
147+
<h3>🖥️ Desktop Launcher (Windows)</h3>
148+
<p>On Windows, you can also launch the Administrator directly from:</p>
149+
<ul>
150+
<li>Start Menu → Open Integration Engine → OIE Manager</li>
151+
<li>Or run <code>oiemanager.exe</code> from the installation directory</li>
152+
</ul>
153+
</div>
154+
155+
<div class="important">
156+
<strong>⚠️ Default Credentials:</strong><br>
157+
Username: <code>admin</code><br>
158+
Password: <code>admin</code><br>
159+
<br>
160+
<strong>Please change these credentials immediately after your first login for security purposes!</strong>
161+
</div>
162+
163+
<h3>Step 3: Verify Installation</h3>
164+
165+
<p>To confirm the server is running properly:</p>
166+
<ol>
167+
<li>Check that the server is listening on ports 8080 (HTTP) and 8443 (HTTPS)</li>
168+
<li>Review the logs in the <code>logs</code> directory for any errors</li>
169+
<li>Log in to the Administrator Console and verify you can access the Dashboard</li>
170+
</ol>
171+
172+
<h2>📁 Important Directories</h2>
173+
174+
<table style="width: 100%; border-collapse: collapse; margin: 15px 0;">
175+
<tr style="background-color: #f5f5f5;">
176+
<td style="padding: 10px; border: 1px solid #ddd;"><strong>Directory</strong></td>
177+
<td style="padding: 10px; border: 1px solid #ddd;"><strong>Purpose</strong></td>
178+
</tr>
179+
<tr>
180+
<td style="padding: 10px; border: 1px solid #ddd;"><code>conf/</code></td>
181+
<td style="padding: 10px; border: 1px solid #ddd;">Configuration files including <code>mirth.properties</code></td>
182+
</tr>
183+
<tr>
184+
<td style="padding: 10px; border: 1px solid #ddd;"><code>logs/</code></td>
185+
<td style="padding: 10px; border: 1px solid #ddd;">Server log files</td>
186+
</tr>
187+
<tr>
188+
<td style="padding: 10px; border: 1px solid #ddd;"><code>appdata/</code></td>
189+
<td style="padding: 10px; border: 1px solid #ddd;">Application data and embedded database</td>
190+
</tr>
191+
<tr>
192+
<td style="padding: 10px; border: 1px solid #ddd;"><code>extensions/</code></td>
193+
<td style="padding: 10px; border: 1px solid #ddd;">Installed plugins and connectors</td>
194+
</tr>
195+
<tr>
196+
<td style="padding: 10px; border: 1px solid #ddd;"><code>custom-lib/</code></td>
197+
<td style="padding: 10px; border: 1px solid #ddd;">Custom user libraries for channel scripts</td>
198+
</tr>
199+
</table>
200+
201+
<h2>🔧 Configuration</h2>
202+
203+
<p>Key configuration settings can be found in <code>conf/mirth.properties</code>:</p>
204+
<ul>
205+
<li><strong>Ports:</strong> Default HTTP (8080) and HTTPS (8443)</li>
206+
<li><strong>Database:</strong> Embedded Derby by default</li>
207+
<li><strong>Application data path:</strong> Configurable via <code>dir.appdata</code></li>
208+
</ul>
209+
210+
<div class="important">
211+
<strong>Note:</strong> If you need to change configuration settings, stop the server first, edit the configuration files, and then restart the server.
212+
</div>
213+
214+
<h2>📚 Additional Resources</h2>
215+
216+
<ul>
217+
<li><strong>Website:</strong> <a href="https://openintegrationengine.org">https://openintegrationengine.org</a></li>
218+
<li><strong>Documentation:</strong> <a href="https://github.com/OpenIntegrationEngine/engine">https://github.com/OpenIntegrationEngine/engine</a></li>
219+
<li><strong>Discord Community:</strong> <a href="https://discord.gg/azdehW2Zrx">Join our Discord</a></li>
220+
<li><strong>GitHub Releases:</strong> <a href="https://github.com/OpenIntegrationEngine/engine/releases">Latest Releases</a></li>
221+
<li><strong>Docker Images:</strong> <a href="https://hub.docker.com/u/openintegrationengine">Docker Hub</a></li>
222+
</ul>
223+
224+
<h2>❓ Troubleshooting</h2>
225+
226+
<h3>Server Won't Start?</h3>
227+
<ul>
228+
<li>Check the logs in the <code>logs/</code> directory for error messages</li>
229+
<li>Ensure ports 8080 and 8443 are not already in use by another application</li>
230+
<li>Verify that Java 17 or higher is properly installed and accessible</li>
231+
<li>Check file permissions on the installation directory</li>
232+
</ul>
233+
234+
<h3>Can't Access Administrator Console?</h3>
235+
<ul>
236+
<li>Verify the server is running by checking the service status or logs</li>
237+
<li>Ensure your firewall isn't blocking ports 8080 or 8443</li>
238+
<li>Try accessing via IP address instead of localhost</li>
239+
<li>Clear your browser cache and try again</li>
240+
</ul>
241+
242+
<h3>Need Help?</h3>
243+
<ul>
244+
<li>Join our <a href="https://discord.gg/azdehW2Zrx">Discord community</a> for real-time support</li>
245+
<li>Check the <a href="https://github.com/OpenIntegrationEngine/engine/issues">GitHub Issues</a> for known problems</li>
246+
<li>Review the complete documentation in the <code>docs/</code> directory</li>
247+
</ul>
248+
249+
<hr style="margin: 30px 0; border: none; border-top: 1px solid #ccc;">
250+
251+
<p style="text-align: center; color: #666; font-size: 0.9em;">
252+
Thank you for choosing Open Integration Engine!<br>
253+
<a href="https://openintegrationengine.org">https://openintegrationengine.org</a>
254+
</p>
255+
</body>
256+
</html>

0 commit comments

Comments
 (0)