...
RECOMMENDATIONS:
|
Comprehensive Production Environment and Troubleshooting Checklist Guide
This guide is designed to assist you in ensuring a smooth setup of your production environment and addressing common issues that may arise during the process of installing and using the Joget DX Platform. By following these checklists and instructions, you can enhance the stability, security, and performance of your system.
Production Environment: Pre-Installation Prerequisite Checklist
For production environments, prepare the following infrastructure prerequisites before the actual Joget DX installation. General instructions are available in the Server Clustering Guide, 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 i.e. Java 11 or Java 17. |
| Application Server | Install a supported Java EE application server e.g. Apache Tomcat 9. |
| Application Server Service Startup Configuration | Configure the application server to startup automatically e.g. Installing Apache Tomcat as a Windows Service. Ensure that 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:
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 there are sufficient read and write permissions for the application server OS user. For clustering, this directory must be shared between all servers e.g. using NFS or SMB. |
| Load Balancer / Reverse Proxy Configuration | Configure the load balancer or reverse proxy to forward requests to the application server e.g. 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. Highly recommended to configure HTTPS 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 e.g. Configure Apache Tomcat Session Replication. |
| LDAP / Active Directory Connectivity | If applicable, ensure that network connectivity is established to the LDAP or Active Directory server. |
Production Environment: Joget DX Platform Installation Checklist
Ensure that all the prerequisites 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, e.g. for Apache Tomcat the WAR is deployed in the apache-tomcat/webapps directory. The WAR files can be obtained from Downloads or from 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 Setting Up Database. |
Joget DX License Activation | Activate the license following Activate Joget DX License. |
Production Environment: Post-Installation Checklist
Once Joget DX has been installed, perform these post-installation steps. Actual steps depend on the products used
| 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 e.g. Backup, Restore, and Disaster Recovery. |
Monitoring Configuration | Configure monitoring tools to monitor the uptime, resource usage, and performance of the environment. |
Security Hardening | Perform the desired security hardening for all infrastructure components. |
Troubleshooting: Common Issues Checklist
A list of common issues that may arise during Joget DX Platform deployment or operation
| Item | Description |
|---|---|
| Database Credentials | Ensure that the database authentication credentials are correct and that it 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 that the shared file storage has full read and write permissions for the application server OS user. |
Port Conflicts | Ensure that there are no other services 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 that 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 that there is sufficient memory 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.
| View file | ||||
|---|---|---|---|---|
|
Related Articles
| English |
|---|
Please refer to Advanced Installation Guide for extra installation options. |
...