Installing ConSol CM

Introduction

This section explains the setup of a new ConSol CM system. If you need information about a system update, please refer to the Release Notes of the respective CM version.

Please contact the ConSol CM support or your ConSol CM consultant for information about setting up ConSol CM in a cluster.

Prerequisites

• Installation of Java JDK 11 or 17 on the server
• JBoss EAP version 7.4 or Wildfly 26.1.3
  
• ConSol CM distribution, there is a specific distribution for the combination of application server and database.
  

• Installed database server, see section Setting up the database for ConSol CM

• In case of MySQL as database: MySQL connector 8.0.22

• Installed email server

A detailed list of supported operation systems, application servers, database systems, and other systems, as well as storage and CPU requirements is given in the current System Requirements.

Installing JBoss

Please perform the following steps. There might be slight differences depending on the systems or versions.

The application server should always run under a user without administrator permissions / root access to the operating system.

Windows

1. Extract the downloaded JBoss archive into a new folder.
2. Edit the file <JBOSS_HOME>\bin\standalone.conf.bat (also see standalone.conf.bat):

   • Change the Java memory options if needed:

     set "JAVA_OPTS=-Xms4g -Xmx4g -XX:MaxMetaspaceSize=512m -Djava.net.preferIPv4Stack=true"

   • Add the Java path (the path and Java version can be different on your system):

     set "JAVA_HOME=C:\Program Files\Java\jdk-11.0.17+8"

     Alternatively you can add JAVA_HOME to your operating system environment variables. In this case it is not necessary to set the line above. Refer to the Java documentation on how to do this.

   • Add JDK_SERIAL_FILTER="maxbytes=104857600;maxdepth=128;maxarray=100000;maxrefs=300000" (increase maxbytes from 10 to 100MB) or DISABLE_JDK_SERIAL_FILTER=true (disable serialization) to avoid problems with object (de)serialization which might occur in the context of data transfer to CMRF (only needed for JBoss EAP > 7.4.12).

Linux

1. Extract the downloaded JBoss archive into a new folder.
2. Edit the file <JBOSS_HOME>/bin/standalone.conf (also see standalone.conf):

   • On most Linux Systems the JAVA_HOME environment variable should already be set. If you wish to use the system standard Java version you do not need to specify the JAVA_HOME environment variable.

     If in your case the variables are not set or you wish to specify a path to a specific Java installation add the following line (the path and Java version can be different on your system):

     JAVA_HOME="/opt/java/64/jdk-11.0.17+8"

     You can use echo $JAVA_HOME to check if the variable is set correctly.

   • Adjust the JVM memory options, the -Xmx value should be at least 4G. If you want to set the options only when no JAVA_OPTS have been set yet, then use the following statement:

     ## Specify options to pass to the Java VM.#

     if [ "x$JAVA_OPTS" = "x" ]; then

     JAVA_OPTS="-Xms4g -Xmx4g -XX:MaxMetaspaceSize=512m -Djava.net.preferIPv4Stack=true"

     JAVA_OPTS="$JAVA_OPTS -Djboss.modules.system.pkgs=$JBOSS_MODULES_SYSTEM_PKGS -Djava.awt.headless=true"

     else

     echo "JAVA_OPTS already set in environment; overriding default settings with values: $JAVA_OPTS"

     fi

     If you want to overwrite existing JAVA_OPTS, do not put the JAVA_OPS= statements into the if clause

   • If the JBOSS_HOME environment variable is already set to a path other than your server path, add the following line at the top of <JBOSS_HOME>/bin/standalone.conf. Remember that <JBOSS_HOME> is the path to your JBoss installation.

     JBOSS_HOME=<JBOSS_HOME>

   • Add JDK_SERIAL_FILTER="maxbytes=104857600;maxdepth=128;maxarray=100000;maxrefs=300000" (increase maxbytes from 10 to 100MB) or DISABLE_JDK_SERIAL_FILTER=true (disable serialization) to avoid problems with object (de)serialization which might occur in the context of data transfer to CMRF (only needed for JBoss EAP > 7.4.12).

3. Change owner to a non-admin Linux user (example: consolcm) and make the files executable:

   • chown -R consolcm <JBOSS_HOME>/bin
   • chmod 755 -R <JBOSS_HOME>/bin

Installing ConSol CM

1. Extract the ConSol CM distribution dist-package-distribution-<CM_VERSION>-wildfly_jboss.zip into <JBOSS_HOME>.
2. Overwrite the 4 subfolders bin, domain, modules and standalone, i.e. confirm the overwriting of existing files.