Creating a Windows Installer for Your OEM Build

Introduction

In this article, we will explain how to create a Windows installer for your OEM build. For this installer, we will be using the Nullsoft Scriptable Install System (NSIS), which is also used in Joget.

How does it work?

Prerequisites

Before proceeding with this step, make sure you have completed building Joget Community Edition from the source code and finished customizing your OEM build. After that, you can package them into a Windows installer bundle.

Setting Up Environment

1. Download and install the latest NSIS package from the official website.
2. Choose the latest release and install it. 
3. Once the installation is done, launch NSIS and you will see the NSIS menu.
   

Preparing the NSI Script

The NSI script is like a recipe. It tells NSIS what files to include and how to build the installer. In this section, you will learn how to prepare NSI scripts.

1. This script is for Joget Community Edition. A sample script can be found in this path:
   

   \jw-community-8.0-SNAPSHOT\wflow-install\src\main\resources\setup.nsi.

   You can use any text editor to edit the file.
2. Copy the setup.nsi from:
   

    \jw-community-8.0-SNAPSHOT\wflow-install\src\main\resources\

3. Copy the jwdb-sample.sql from:
   

    \jw-community-8.0-SNAPSHOT\wflow-install\src\main\resources\data

4. Paste both files into your existing Joget installation folder, for example:
   

   C:\Joget-DX8-Enterprise

Adding Custom plugins into the Bundle

If you have any custom plugins that you want to include in the bundle, copy the .jar files into the existing Joget installation folder:

\Joget-DX8-Enterprise\wflow\app_plugins

Building The Bundle

After preparing the NSI script and placing the required files in your Joget installation folder, the next step is to build the installer. This process will use the NSIS application to compile the script and generate the Windows installer (setup.exe) for your OEM build.

1. Open the NSIS application and click Compile NSI scripts under Compiler.
   
2. Find Load Script and locate the .nsi script you prepared earlier.
3. The NSIS will automatically compile the script. Once done, you can click Test Installer to run the installer directly.
   

Expected Outcome

After the .nsi file is successfully compiled, you can find the created .exe file in your chosen destination folder.