Installation

Setting up a robust development and production environment is crucial for the seamless deployment and operation of the Joget DX Platform. From initial infrastructure prerequisites to post-installation configurations and troubleshooting, this guide ensures stability, security, and optimal performance throughout your Joget DX journey.

Development environment installation

To install on a local developer machine, development environment, or QA test environment, download and install the pre-packaged local machine installers from Downloads or Enterprise Support. OS-specific instructions are available at Installing Joget DX8.

These installers come bundled with several infrastructure components for convenience and easy installation but are unsuitable for staging or production environments.

Other deployment options, including container deployments and public cloud marketplace images, are available at Get Started - Other Deployments.

Production environment checklist guide

This section is designed to assist you in ensuring a smooth setup of your production environment and addressing common issues that may arise while installing and using the Joget DX Platform. These checklists and instructions can enhance your system's stability, security, and performance.

Prerequisite checklist

Prepare the following infrastructure prerequisites for production environments before the Joget DX installation:

General instructions are available in the Server Clustering, but actual steps depend on the product used.

Item	Description
Operating System	Prepare a supported Windows or Linux OS environment.
Java	Install a supported Java LTS version, Java 11 or Java 17.
Application Server	Install a supported Java EE application server, Apache Tomcat 9.
Application Server Service Startup Configuration	Install Apache Tomcat as a Windows service to configure the application server to start automatically. Ensure the service user has full read and write permissions to the file storage.
Database Server	Install a supported RDBMS server and obtain the database connection credentials for Java JDBC: JDBC URL JDBC Username JDBC Password Ensure that the database user has full permission to create tables in the database.
File Storage	Prepare file storage for the Joget “/wflow” directory to store configuration and runtime files. Ensure sufficient read and write permissions exist for the application server OS user, and this directory must be shared between all servers using either NFS or SMB for clustering.
Load Balancer / Reverse Proxy Configuration	Configure the load balancer or reverse proxy to forward requests to the application server, such as NGINX as Reverse Proxy or Apache HTTPD as Reverse Proxy.
DNS Configuration	Configure the DNS to map domain names to the load balancer or reverse proxy.
HTTPS Configuration	Configure HTTPS for secure traffic. It is highly recommended that HTTPS be configured at the load balancer or reverse proxy instead of the app server.
Application Server Session Replication	For clustering, configure session replication in the application servers. For example, configure Apache Tomcat Session Replication.
LDAP / Active Directory Connectivity	Ensure network connectivity is established to the LDAP or Active Directory server if applicable.

Platform installation checklist

Ensure that all the prerequisites in the following table have been completed before beginning:

Item	Description
Joget DX WAR Deployment	Deploy the Joget DX WAR file to the application servers. Actual steps depend on the specific application server. For example, Apache Tomcat deploys the WAR in the "/apache-tomcat/webapps" directory. The WAR files can be obtained from Downloads or Enterprise Support.
Joget DX Java VM Configuration	Ensure that the Java VM configuration is configured according to Deployment and Configuration, with particular attention to the "/wflow.home" directory path and the Java VM memory settings.
Joget DX Datasource Configuration	Connect to the database server following Set Up a Database.
Joget DX License Activation	Activate the license following Set up Your Joget DX 8 Enterprise License.

Post-Installation checklist

Once Joget DX has been installed, perform these post-installation steps:

Item	Description
LDAP / Active Directory Configuration	If applicable, configure integration to LDAP or Active Directory following LDAP Directory Manager or Sync LDAP Directory Manager.
Backup Configuration	Configure backup procedures to backup the database and file storage on a scheduled basis. For more information, see Backup, Restore, and Disaster Recovery.
Monitoring Configuration	Configure monitoring tools to monitor the environment's uptime, resource usage, and performance.
Security Hardening	Perform the desired security hardening for all infrastructure components.

Common issues checklist

The following table lists common issues that may arise during Joget DX Platform deployment or operation:

Item	Description
Database Credentials	Ensure the database authentication credentials are correct and can be accessed from the application server.
Database Permissions	Ensure that the database user has full permission to create tables in the database.
Directory File Permissions	Ensure the shared file storage has full read and write permissions for the application server OS user.
Port Conflicts	Ensure no other services are already running on ports for the different infrastructure components.
Network Restrictions	Ensure that there are no network restrictions preventing connections between the different servers.
Disk I/O and Network Latency	Ensure there are no network latency or disk I/O issues, especially for the shared file storage and connectivity to the database server.
Load Balancer or Reverse Proxy Configuration	Ensure that the load balancer or reverse proxy is forwarding requests to the application server transparently without unnecessarily changing the request body or headers.
Java VM Configuration	Ensure sufficient memory is allocated to the Java VM according to planned usage.

Download checklist

For your convenience, you can download a PDF version of this guide that includes all four checklists mentioned above. Simply click the link below to access the PDF document and have it handy for reference whenever you need it.

Created by Marcos Last modified by Aadrian on Dec 13, 2024

Tags:

Previous System Requirements NextNative Mobile App