feat: add getting started page #6
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kryskool
force-pushed
the
add-getting-started
branch
from
a9a8e11 to
a7d2041
Compare
There was a problem hiding this comment.
Pull request overview
This pull request adds a comprehensive getting started guide for the Open Integration Engine (OIE), including documentation on installation, system requirements, and first launch configuration. The guide focuses primarily on Mac OS installation with placeholders for Windows and Linux.
Changes:
- Added new getting started documentation page at
docs/engine/getting_started.md - Added two PNG image files for login steps
- Updated navigation configuration to include the new getting started page
Reviewed changes
Copilot reviewed 2 out of 17 changed files in this pull request and generated 15 comments.
| File | Description |
|---|---|
| docs/engine/getting_started.md | New comprehensive getting started guide with installation and setup instructions |
| docs/engine/images/gs_oie_login_step_1.png | Screenshot image for OIE login step 1 |
| docs/engine/images/gs_oie_login_step_2.png | Screenshot image for OIE login step 2 |
| .vitepress/config.mts | Added getting started link to documentation navigation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Christophe Chauvet <christophe.chauvet@gmail.com>
Signed-off-by: Christophe Chauvet <christophe.chauvet@gmail.com>
kryskool
force-pushed
the
add-getting-started
branch
from
0c07901 to
886872a
Compare
kryskool
force-pushed
the
add-getting-started
branch
from
4029df0 to
886872a
Compare
tonygermano
requested changes
Jan 17, 2026
Member
tonygermano
left a comment
tonygermano
left a comment
There was a problem hiding this comment.
Some minor edit suggestions.
| @@ -0,0 +1,173 @@ | |||
| # Getting started | |||
|
|
|||
| To quickly start with Open Integration Engine, also called OIE in this documentation, | |||
Member
There was a problem hiding this comment.
Suggested change
| To quickly start with Open Integration Engine, also called OIE in this documentation, | |
| To quickly start with Open Integration Engine™, also called OIE™ in this documentation, |
|
|
||
| ::: 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.
Suggested change
| All installers are available at the release page on GitHub, see [GitHub Release](https://github.com/OpenIntegrationEngine/engine/releases) | |
| All installers are available at the releases page on GitHub, see [GitHub Releases](https://github.com/OpenIntegrationEngine/engine/releases) |
|
|
||
| ### Java requirements | ||
|
|
||
| The Open Integration Engine requires Java 17+ to work |
Member
There was a problem hiding this comment.
Suggested change
| The Open Integration Engine requires Java 17+ to work | |
| The Open Integration Engine requires Java 17+ to work. |
Comment on lines
+25
to
+29
| ::: warning | ||
| OIE can work with older versions of Java, but this is not recommended, | ||
| as some extensions may require version 17 to function correctly. | ||
| ::: | ||
|
|
Member
There was a problem hiding this comment.
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. | |
| ::: |
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.
Suggested change
| 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. | |
| 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. |
|
|
||
| ::: warning | ||
|
|
||
| If you use a new instance, the defaults credentials are: |
Member
There was a problem hiding this comment.
Suggested change
| If you use a new instance, the defaults credentials are: | |
| If you use a new instance, the default credentials are: |
|
|
||
|  | ||
|
|
||
| It's finished, now you can start to use OIE server, No newline at end of file |
Member
There was a problem hiding this comment.
Suggested change
| It's finished, now you can start to use OIE server, | |
| It's finished. Now you can start to use your OIE server. | |
| 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.
Suggested change
| The first time, the server creates the default database. If server is launched correctly, you shoud see. the following lines: | |
| During the first launch, the server initializes the database. If the server is launched correctly, you should see the following lines: |
|
|
||
| ### Ballista | ||
|
|
||
| [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.
Suggested change
| [Ballista](https://github.com/kayyagari/ballista/releases) is the web-based administration interface for Open Integration Engine based on Tauri. | |
| [Ballista](https://github.com/kayyagari/ballista/releases) is an open-source Administrator launcher for Open Integration Engine based on Tauri. |
| Please note these URLs, as we will need them later. | ||
| ::: | ||
|
|
||
| ### Linux |
Member
There was a problem hiding this comment.
There is no content under this heading.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.