Skip to main content

Deploy the WAR file

Deploy the iGrafx platform from the WAR file onto your own Java application server. iGrafx instructions augment your operating system's and application server's own deployment documentation — they don't replace it, and you'll adjust them for your environment, IT policies, and application server.

If you have no standardized application server or special requirements, start with the pre-deployed iGrafx platform on Windows instead — you can move to a different machine, operating system, or application server later.

Prerequisites​

  • A Java application server compatible with the platform's required JRE.
  • A local folder on the application server host for the base directory. If the application server runs as a dedicated user, give that user read/write access to the folder. Keep the folder intact across platform and application-server updates — ideally on a different physical location from the installation folder, per your IT policy.

Steps​

1. Set the startup parameters​

Add these to your application server (adjust the values for your environment; these are the minimal or most common options):

  • Base directory — -Digrafx.basedirectory=PathToBaseDirectory. Some environments prefer absolute paths, others relative.
  • JVM memory — -Xms### and -Xmx###. See Server sizing recommendations. The right values depend on your use case; don't assign less than 2 GB for the maximum heap.
  • Logging (optional) — logging is configured in the application's administration area and writes to /log in the base directory, plus your server's own log files. To use custom logging, put a log4j2.xml file in the base directory and set -Dlog4j.configurationFile=/PathToBaseDirectory/log4j2.xml.

2. Add the required mail libraries​

Download javax.mail-1.6.2.jar and activation-1.1.1.jar and place them in the tomcat/lib folder:

3. Deploy the WAR​

Place the WAR file in your application server's deployment folder and deploy into the root context. In most application servers this means renaming the file to ROOT.war or extracting it into a ROOT folder.

4. Complete the setup​

Back up your databases, and back up the base directory once the application is configured — its data is small and rarely changes, but you'll want it to restore on another machine. Then continue with the post-deployment steps.