Build tools

Software requirements

To run a Genesis application, including on your local machine, the following software must be installed:

Software	Access Information
JDK 17	Windows (.msi) Other Platforms
Node.js	Windows (.msi) Other Platforms
LMDB (Mac Only)	Installation Guide
Genesis Server Framework (GSF)	Artifact Access
Genesis Web Framework (Foundation)	Artifact Access
Gradle	Bundled with your Genesis application project (unless downloading a new Create project with "Exclude Gradle Wrapper JAR" selected)

LMDB installation guide (MacOS)

When running a Genesis application on MacOS, you must install and configure LMDB. The following steps can be followed:

1. Install lmdb for mac : homebrew installation instructions
2. Add liblmdb.dylib to your Java Extensions:

mkdir -p ~/Library/Java/Extensions
cp /opt/homebrew/opt/lmdb/lib/liblmdb.dylib ~/Library/Java/Extensions/

Gradle deploy plugin

The Genesis Application Platform provides a Gradle plugin that makes it easy to perform all the installation tasks that are necessary to deploy your own Genesis project on your local workstation, from your IDE.

The plugin is designed to work on workstations running Linux, or on WSL.

Enabling the deployment plugin to your project

Simply set genesisDeploy.enabled = true in your application's server/settings.gradle.kts file.

  plugins {
    genesisDeploy.enabled = true
  }

Target deployments

There are several possible configurations for your deployment. For each one, you need to set up your gradle.properties file in a specific way:

• Windows Subsystem for Linux (WSL)
• a local Linux host
• a remote Linux host (via SSL)

General set-up

Make sure you have a gradle.properties file inside a .gradle folder in your user directory; this file must contain your Genesis Artifactory credentials in clear (unencrypted) text:

genesisArtifactoryUser=<your-artifactory-user>
genesisArtifactoryPassword=<your-artifactory-password>

note

This requires credentials for accessing Genesis Artifactory. If you have not been provided with the credentials, please contact your administrator, or contact us. It's not possible to complete the training without this access, because you won't be able to download the Genesis platform components and build your project.

WSL

If your development workstation is a Windows machine, then you can use WSL to have Genesis set-up locally.

To configure this, open gradle.properties from the server/jvm folder and add the following entries:

genesis-home=<path-to-genesis-home-on-wsl>
wsl-distro=<name-of-the-wsl-distro>
wsl-user=<wsl-username>

Entry	Description
genesis-home	This is a mandatory property that is a path to genesis distribution on the WSL distribution. Example: /home/alpha/run
wsl-distro	This is a mandatory property that is the name of the WSL distribution. Example: CentOS7
wsl-user	This is an optional property. If omitted, the default WSL user will be used. Example: alpha

Sample configuration:

genesis-home=/home/alpha/run
wsl-distro=CentOS7
wsl-user=alpha

Local Linux host

This is the easiest set-up, and applies if your development workstation is on a Linux machine.

To configure this, open gradle.properties from the server/jvm folder and add the following entry:

genesis-home=<path-to-local-genesis-home>

The set-up task will create the folder (if it doesn't exist) and set up the Genesis platform there.

Remote Linux host (via SSH)

This configuration is usable when using a remote host for the Genesis environment. Currently, only Linux hosts are supported.

To configure this, open gradle.properties from the server/jvm folder and add the following entries:

genesis-home=<path-to-remote-host-genesis-home>
ssh-username=<remote-host-username>
ssh-password=<remote-host-password>
ssh-host=<remote-host>
ssh-port=<remote-host-ssh-port>

All the properties above are mandatory.

Sample configuration:

genesis-home=/home/user1/genesis560
ssh-username=user1
ssh-password=<password-for-user1>
ssh-host=user1-remotehost
ssh-port=22

Plugin tasks

The Genesis deploy plugin comes with several tasks. They are grouped under genesisdeploy and genesissetup.

Genesis set-up tasks

These tasks deploy each external distribution, as well as site-specific configuration.

Task	Description
createGenesisHome	This task creates the genesis home.
install-genesis-distribution.zip	This task copies and unzips the Genesis distribution specified as a dependency.
install-auth-distribution.zip	This task copies and unzips the auth distribution specified as a dependency.
install-<project-name>-site-specific-1.0.0-SNAPSHOT-bin.zip-distribution.zip	This task copies and unzips the <project-name>-site-specific distribution specified as a dependency.
loadInitialData	This task executes install-<project-name>-site-specific-1.0.0-SNAPSHOT-bin.zip-distribution.zip and then calls all the SendIt-<file>.csv tasks.
setupEnvironment	This task executes createGenesisHome then install-genesis-distribution and then configures the installed distribution.
SendIt-<file>.csv	This task executes the script command SendIt with the parameters -t <file-name (in Uppercase)> and -f <file-location>.

Genesis deploy tasks

These tasks enable the deployment of the full project: single jars for each project module or just configuration files.

Below, note that <project-name> must be replaced with the actual project name. For example, if the project you work on is called alpha, you would call it deploy-genesisproduct-alpha.zip

Task	Description
deploy-genesisproduct-<project-name>.zip	This task deploys the current project to the Genesis environment specified for genesis-home.`
deploy-<project-name>-eventhandler.jar	This task deploys the Event Handler jar to the Genesis environment specified for genesis-home.
deploy-<project-name>-messages.jar	This task deploys the messages jar to the Genesis environment specified for genesis-home.
deployConfig	This task deploys the config to the Genesis environment specified for genesis-home.
deployDictionary	This task deploys the dictionary to the Genesis environment specified for genesis-home.
deployScripts	This task deploys the scripts to the Genesis environment specified for genesis-home.

Note, this will take the last built distribution; it does not run a project build as part of the task... so do that first.