Skip to content

Commit 43d7dc9

Browse files
authored
Revise developer instructions for local build and run
Updated instructions for building and running OIE locally, emphasizing the Docker approach and providing additional context for users. Signed-off-by: Jon Bartels <[email protected]>
1 parent 37d46c7 commit 43d7dc9

File tree

1 file changed

+23
-14
lines changed

1 file changed

+23
-14
lines changed

DEVELOPERS.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,16 @@
11
# For developers and contributors
22

3-
You can build and run OIE locally, or using Docker. For full documentation see [docs.openintegrationengine.org](https://docs.openintegrationengine.org/engine/contributing.html).
3+
This document is for developers who want to make modifications to OIE. If you are a user who wants to run and use OIE, please review [the README](./README.md) or the full documentation see [docs.openintegrationengine.org](https://docs.openintegrationengine.org/engine/contributing.html).
44

5-
## Local Build and Run
5+
There are two ways to build and run OIE locally. The reccommended way is to use Docker. OIE can also be run with traditional build tools.
66

7-
```bash
8-
# Install dependencies manually or use https://sdkman.io/
9-
sdk env install
7+
Both are described here. We suggest the Docker approach for most use cases.
108

11-
# Build the server
12-
# NOTE: Building will delete any existing server configuration!
13-
ant -f server/mirth-build.xml -DdisableSigning=true
9+
For either approach we also strongly suggest using a launcher. The preferred launcher is [Ballista](https://github.com/kayyagari/ballista) but the Bridge Link launcher and the NextGen Mirth Connect Admin Launcher are known to work.
1410

15-
# Run the server
16-
server/setup/oieserver
17-
18-
# Connect using Ballista or another launcher at https://localhost:8443
19-
```
11+
## Local Build and Run Using Docker
2012

21-
## Or Using Docker
13+
This is the preferred approach. The Docker image in the `engine` repository is maintained with the correct JDK, build steps, and best practices.
2214

2315
```bash
2416
# Build using docker
@@ -30,3 +22,20 @@ docker run --rm -p 8443:8443 oie-dev
3022

3123
# Connect using Ballista or another launcher at https://localhost:8443
3224
```
25+
## Local Build and Run using Ant
26+
27+
This is the older, traditional approach from the now closed-source Mirth Connect project. OIE is working to modernize the build system. The Docker approach is likely to be faster and more reliable and better supported.
28+
29+
```bash
30+
# Install dependencies manually or use https://sdkman.io/
31+
sdk env install
32+
33+
# Build the server
34+
# NOTE: Building will delete any existing server configuration!
35+
ant -f server/mirth-build.xml -DdisableSigning=true
36+
37+
# Run the server
38+
server/setup/oieserver
39+
40+
# Connect using Ballista or another launcher at https://localhost:8443
41+
```

0 commit comments

Comments
 (0)