Building and Deploying OEM Edition

Now that we understand what the Joget OEM Edition is and what’s required to get started, it’s time to dive into the technical setup. By the end, we’ll have a running OEM-branded Joget instance ready for further customization.

Prerequisites

We will be using placeholders and its values throughout this article, for example:

• {yourCompany} is jogetInc
• {versionNumber} is 9.0.0
• {buildHash} is 958f479
  This specific "Git commit hash" can also be found in our official GitHub repository.
• {jogetInstallationFolder} is either Joget-DX9-Enterprise (Windows) or joget-enterprise-linux-9.0.0 (Linux/Mac)
• commands are based on the Linux terminal

Please replace {yourCompany}, {versionNumber}, {buildHash}, {jogetInstallationFolder} and commands based on specific needs.

And before we begin, make sure we have the following ready:

1. JDK 17 is installed and executable in the terminal. JDK installer is available at https://adoptium.net/temurin/releases.
2. Maven is installed. Visit https://www.baeldung.com/install-maven-on-windows-linux-mac for the installation guide.
3. The Joget instance is running at http://localhost:8080/jw. If this is not set up yet, please follow our guides using either:
   • Joget on local
   • Joget on Docker
4. Downloaded the latest OEM package archive from the Joget account, for example:
   

   jogetInc-oem-package-9.0.0-958f479.tar.gz

Once we get everything ready, let's walk through the steps to build and deploy the OEM Edition using the default blue theme OEM Package.

Setup Guide

Extract {yourCompany}-oem-package-{versionNumber}-{buildHash}.tar.gz (OEM package). Then, open the terminal and set the OEM package folder as the terminal's working directory, for example:

cd jogetInc-oem-package-9.0.0-958f479

1. Build Joget Community from Source

Download the jw-community dependencies, then install them using either install_linux.sh or install_win.bat.

Extract joget-src-{versionNumber}-{buildHash}.tar.gz from the OEM package then execute:

mvn clean install -Dmaven.test.skip=true -f ./joget-src-9.0.0-958f479/wflow-app/pom.xml

2. Add the OEM war file into Maven

Execute the command below to install the OEM licensed jw.war into the local Maven repository:

mvn install:install-file -Dfile=jw.war -DgroupId=org.joget -DartifactId=cloud-consoleweb -Dversion=9.0.0 -Dpackaging=war -DgeneratePom=true

3. Build OEM Project from Source

Extract oem-enterpriseweb-{versionNumber}-{buildHash}.tar.gz from the OEM package, then execute:

mvn clean install -Dmaven.test.skip=true -f ./oem-enterpriseweb-9.0.0-958f479/pom.xml

Heads up on potential build errors

If we see a BUILD FAILED error while building the oem-enterpriseweb project and it mentions something like:

That usually means Step 2 - Add OEM war file into Maven, wasn’t completed properly. Double-check that step and try again.

Similarly, if the error mentions:

That points to an issue with Step 1 - Build Joget Community from Source. Make sure that the build completes successfully before continuing further.

4. Deploy & Run OEM Edition

1. Shutdown the Joget instance.
2. Delete existing apache-tomcat-*/webapps/jw folder and apache-tomcat-*/webapps/jw.war file.
3. Delete existing files and folders in apache-tomcat-*/webapps/ temp/* and work/* folders.
4. Copy the newly build oem-enterpriseweb-{versionNumber}-{buildHash}/target/jw.war file into apache-tomcat-*/webapps/ folder.
5. Startup Joget.

5. Verify OEM Edition

Congratulations, we have made it!

Once Joget is up and running, verify the Joget build from Settings > System section > Version.

The Joget's version number and build hash should match the one we are using during the OEM build process.

We can now proceed with customizing our platform’s branding, UI, and bundled apps.