Skip to main content
Skip table of contents

Installation process

MariaDB is used as the database below.

Create Database

Linux

  1. In the console, change to the directory <Install-path>\<database>\bin .
    For MariaDB as the database, it is the directory <Install-path>\mariadb\bin

  2. Execute the command mysql.exe -u "username" -p

    BASH
    mysql -u root -p -h localhost
  3. Once the connection is established, create the required database (in the MariaDB shell)

    BASH
    create database ece2;
  4. Enter and execute the following commands with the corresponding variables for %mariadb-db-name%,%mariadb-wildfly-user%, %mariadb-wildfly-pw% and %host% .

    XML
    GRANT ALL PRIVILEGES ON ece2.* TO %mariadb-wildfly-user%@'localhost' IDENTIFIED BY '%mariadb-wildfly-pw%';
    GRANT ALL PRIVILEGES ON ece2.* TO %mariadb-wildfly-user%@'127.0.0.1' IDENTIFIED BY '%mariadb-wildfly-pw%';
    GRANT ALL PRIVILEGES ON ece2.* TO %mariadb-wildfly-user%@'::1' IDENTIFIED BY '%mariadb-wildfly-pw%';
    GRANT ALL PRIVILEGES ON ece2.* TO %mariadb-wildfly-user%@'%host%' IDENTIFIED BY '%mariadb-wildfly-pw%';
    FLUSH PRIVILEGES;
  5. Exit MySQL Shell

  6. Install JDBC driver

  7. Restart WildFly service

Prepare RE Cockpit Environment

Linux

To prepare and structure the RE Cockpit environment, directories must be created in the shell.

BASH
cd /opt
sudo mkdir re-environment
cd re-environment

Install WildFly

Starting with RE 3.0.0, the RE Cockpit now requires WildFly 35 with Java 21 (LTS) instead of WildFly 18.0.1.

For new installations of RE 3.0.x, this means:

  • Use a WildFly 35 installation (instead of WildFly 18.0.1).

  • Configure Java 21 as the runtime for WildFly 35.

  • Apply the WildFly configuration steps described in this document (Datasources, JDBC drivers, Security Domain "ECE", Logging) to the WildFly 35 instance.

For upgrades from 2.x to 3.0.x, it is recommended:

  • to set up a new WildFly 35 instance in parallel,

  • to transfer the required configuration (Datasource, JMS, Security Domain, Logging),

  • to use the appropriate 3.0.x installer for WildFly 35 + Java 21 (see details ReleaseEngine 3.0.0 and ECE2 Installer).

The installation steps described below remain valid but must be applied to the new WildFly version.

These changes must be considered for both new installations and upgrades from 2.x to 3.0.x.

Linux

Linux

  1. Download WildFly

    BASH
    cd ~/Downloads
    wget http://download.jboss.org/wildfly/18.0.1.Final/wildfly-18.0.1.Final.zip
    sudo mv ~/Downloads/wildfly-18.0.1.Final.zip /opt/re-environment/
    cd /opt/re-environment
  2. Extract contents into the directory /opt/re-environment

  3. Edit standalone-full.xml so that it can access WildFly.

    • Find the IP address 127.0.0.1 and replace it with the server's IP address

      wildfly-18.0.1.Final/standalone/configuration/standalone.xml

      XML
      <wsdl-host>${jboss.bind.address:127.0.0.1}</wsdl>
      ...
      <interface name="management">
          <inet-address value="${jboss.bind.address.management:127.0.0.1}"/>
      </interface>
      <interface name="public">
          <inet-address value="${joss.bind.address:127.0.0.1}"/>
      </interface>
      <interface name="insecure">
          <inet-address value="${joss.bind.address.unsecure:127.0.0.1}"/>
      </interface>
Windows

Windows

  1. Download WildFly

  2. Extract contents

  3. Create a new folder "WildFly" in the installation directory

  4. Copy WildFly into the installation directory

  5. Copy module.xml to the directory <Install-path>\WildFly\modules\system\layers\base\com\mysql\main

  6. Copy standalone.xml to the directory <Install-path>\WildFly\standalone\configuration

Configure WildFly

Linux

Linux

  1. Start WildFly in the foreground

  2. Create WildFly administrator

    • Open console as administrator

    • Navigate to the directory <Install-path>/WildFly/bin

    • Execute add-user.sh

    • Answer questions as follows:

  3. Open and configure the firewall to allow access to WildFly

    BASH
    sudo systemctl enable firewalld
    sudo systemctl start firewalld
    sudo firewall-cmd --zone=public --add-port=8080/tcp --permanent
    sudo firewall-cmd --zone=public --add-port=9990/tcp --permanent
    sudo firewall-cmd --reload
  4. Run WildFly as a service

    CODE
    cd /opt/re-environment
    sudo cp ./wildfly-18.0.1.Final/docs/contrib/scripts/init.d/wildfly-init-redhat.sh  /etc/init.d/wildfly
    sudo cp ./wildfly-18.0.1.Final/docs/contrib/scripts/init.d/wildfly.conf /etc/default
  5. Create WildFly user and specify as owner

CODE
sudo useradd wildfly
sudo chown wildfly:wildfly -R /opt/re-environment/wildfly-18.0.1.Final
  1. Create link in /opt-directory

CODE
sudo ln -s /opt/re-environment/wildfly-18.0.1.Final /opt/wildfly
  1. Edit configuration. Find the JBOSS_CONFIG line and change it as follows:

    /etc/default/wildfly.conf

    XML
    ## Location of JDK
    JAVA_HOME="/usr/java/jdk-9.0.4"
    
    ## Location of WildFly
    JBOSS_HOME="/opt/re-environment/wildfly-18.0.1.Final"
    
    ## The username who should own the process.
    JBOSS_USER=wildfly
    
    ## The mode WildFly should start, standalone or domain
    JBOSS_MODE=standalone
    
    ## Configuration for standalone mode
    JBOSS_CONFIG=standalone-full.xml
    
    ## Configuration for domain mode
    # JBOSS_DOMAIN_CONFIG=domain.xml
    # JBOSS_HOST_CONFIG=host-master.xml
    
    ## The amount of time to wait for startup
    # STARTUP_WAIT=60
    
    ## The amount of time to wait for shutdown
    # SHUTDOWN_WAIT=60
    
    ## Location to keep the console log
    JBOSS_CONSOLE_LOG="/var/log/wildfly/console.log"
    
    ## Additionals args to include in startup
    # JBOSS_OPTS="--admin-only -b 127.0.0.1"
  2. Activate service-control

    BASH
    sudo systemctl enable wildfly
  3. Copy the standalone.xml to the directory <Install-path>/WildFly/standalone/configuration

    CODE
    cd /opt/re-environment/wildfly-18.0.1.Final/standalone/configuration
    sudo cp standalone.xml standalone.xml.original
    sudo cp standalone-full.xml standalone.xml
  4. WildFly stoppen und Konsole, in der es im Vordergrund gelaufen ist, schließen.

  5. WildFly im Hintergrund starten

    BASH
    sudo systemctl start wildfly
  6. Stop WildFly

  7. Download and install the mySQL connector

CODE
sudo cd /opt
sudo wget https://dev.mysql.com/get/Downloads/Connector-J/mysql-connector-java-8.0.17.tar.gz
sudo tar -xvzf mysql-connector-java-8.0.17.tar.gz
  1. Create the directory <Install-path>/WildFly/modules/system/layers/base/com/mysql/main and copy the JDBC-driver into the directory.

    BASH
    sudo mkdir -p /opt/wildfly/modules/system/layers/base/com/mysql/main
    sudo cp mysql-connector-java-8.0.17/mysql-connector-java-8.0.17.jar /opt/wildfly/modules/system/layers/base/com/mysql/main
  2. Create module.xml in the directory <Install-path>/WildFly/modules/system/layers/base/com/mysql/main with the following content:

    wildfly/modules/system/layers/base/com/mysql/main/module.xml

    XML
    <module xmlns="urn:jboss:module:1.3" name="com.mysql">
        <resources>
            <resource-root path="mysql-connector-java-8.0.17.jar"/>
        </resources>
    
        <dependencies>
            <module name="javax.api"/>
            <module name="javax.transaction.api"/>
        </dependencies>
    </module>
  3. Edit standalone.xml

    • Insert the system properties between </extensions> and <management> .

      standalone.xml

      XML
      <system-properties>
          <property name="resteasy.preferJacksonOverJsonB" value="true"/>
      </system-properties>
    • Insert JAAS under <security-realms>.

      standalone.xml

      XML
      <security-realm name="ECEApplicationRealm">
          <authentication>
              <jaas name="ECE"/>
          </authentication>
      </security-realm>
    • Insert the log level under <subsystem xmlns="urn:jboss-domain:logging:5.0">.

      standalone.xml

      XML
      <logger category="com.innoface.ece">
          <level name="TRACE"/>
      </logger>
       
      <!-- enable SQL Logging -->
      <logger category="org.hibernate.SQL">
          <level name="DEBUG"/>
      </logger>
       
      <!-- enable logging of BIND parameters -->
      <logger category="org.hibernate.type.descriptor.sql">
          <level name="TRACE"/>
      </logger>
    • Insert the JDBC datasource under <datasources>.

      standalone.xml

      XML
      <datasource jta="true" jndi-name="java:jboss/datasources/ECE" pool-name="ECESqlDS" enabled="true" use-java-context="true" use-ccm="true">
          <connection-url>jdbc:mysql://localhost:3306/ece2?useSSL=false&amp;serverTimezone=Europe/Berlin</connection-url>
          <driver>mysql-connector-java-8.0.17.jar</driver>
          <pool>
              <min-pool-size>10</min-pool-size>
              <max-pool-size>100</max-pool-size>
              <prefill>true</prefill>
              <use-strict-min>false</use-strict-min>
              <flush-strategy>FailingConnectionOnly</flush-strategy>
          </pool>
          <security>
              <user-name>root</user-name>
              <password>dbmaster</password>
          </security>
      </datasource>
    • Insert the JDBC driver under <drivers>.

      standalone.xml

      XML
      <driver name="mysql-connector-java-8.0.17.jar" module="com.mysql">
          <driver-class>com.mysql.cj.jdbc.Driver</driver-class>
          <xa-datasource-class>com.mysql.cj.jdbc.MysqlXADataSource</xa-datasource-class>
      </driver>
    • Insert the JMS topic queue under <jms-queue name="DLQ" entries="java:/jms/queue/DLQ"/>.

      standalone.xml

      XML
      <jms-topic name="topic/ecedaemon" entries="java:jboss/exported/jms/topic/innoface/ecedaemon"/>
    • Insert the security domain under <security-domains>.

      standalone.xml

      XML
      <security-domain name="ECE">
          <authentication>
              <login-module code="com.innoface.ece.wildfly.ECELoginModule" flag="required">
                  <module-option name="password-stacking" value="useFirstPass"/>
              </login-module>
          </authentication>
      </security-domain>
Windows

Windows

  1. Edit the standalone.xml

    • Replace jdbc-version-template at two locations with the jdbc version, e.g., mysql-connector-bin.jar

      <Install-path>\WildFly\standalone\configuration\standalone.xml

      XML
      jdbc:mysql://localhost:template-db-port/ece2</connection-url>
                          <driver>jdbc-version-template</driver>
                          <pool>
                              <min-pool-size>10</min-pool-size>
                              <max-pool-size>100</max-pool-size>
                              <prefill>true</prefill>
                              <use-strict-min>false</use-strict-min>
                              <flush-strategy>FailingConnectionOnly</flush-strategy>

      <Install-path>\WildFly\standalone\configuration\standalone.xml

      XML
      <drivers>
          <driver name="jdbc-version-template" module="com.mysql">
              <xa-datasource-class>com.mysql.jdbc.jdbc2.optional.MysqlXADataSource</xa-datasource-class>
          </driver>
          <driver name="h2" module="com.h2database.h2">
              <xa-datasource-class>org.h2.jdbcx.JdbcDataSource</xa-datasource-class>
          </driver>
      </drivers>
    • Replace template-db-user with the mariadb-wildfly-user, e.g., root

      <Install-path>\WildFly\standalone\configuration\standalone.xml

      XML
      FailingConnectionOnly</flush-strategy>
                          </pool>
                          <security>
                              <user-name>template-db-user</user-name>
                              <password>template-db-password</password>
      
      
    • Replace template-db-password with the mariadb-wildfly-user password

      <Install-path>\WildFly\standalone\configuration\standalone.xml

      XML
      FailingConnectionOnly</flush-strategy>
                          </pool>
                          <security>
                              <user-name>template-db-user</user-name>
                              <password>template-db-password</password>
                          </security>
      
      
    • Replace wildfly-template-port with the WildFly port, usually 8080

      <Install-path>\WildFly\standalone\configuration\standalone.xml

      XML
      interface="public" port-offset="${jboss.socket.binding.port-offset:0}">
              <socket-binding name="ajp" port="${jboss.ajp.port:8009}"/>
              <socket-binding name="http" port="${jboss.http.port:wildfly-template-port}"/>
              <socket-binding name="https" port="${jboss.https.port:8443}"/>
    • Replace template-db-port with the database port, e.g., 3306

      <Install-path>\WildFly\standalone\configuration\standalone.xml

      XML
      jdbc:mysql://localhost:template-db-port/ece2</connection-url>
                          <driver>jdbc-version-template</driver>
                          <pool>
                              <min-pool-size>10</min-pool-size>
                              <max-pool-size>100</max-pool-size>
                              <prefill>true</prefill>
                              <use-strict-min>false</use-strict-min>
                              <flush-strategy>
  2. Edit module.xml

    • Replace jdbc-version-template with the JDBC version, e.g., mysql-connector-bin.jar

      <Install-path>\WildFly\modules\system\layers\base\com\h2database\h2\main\module.xml

      XML
      <module xmlns="urn:jboss:module:1.3" name="com.mysql">
          <resources>
              <resource-root path="jdbc-version-template"/>
         </resources>
         <dependencies>
  3. Edit add-user.bat in the directory <Install-path>\WildFly\bin and replace template_path with the directory of JAVA_HOME-SED.

    <Install-path>\WildFly\bin\add-user.bat

    XML
    set JAVA_HOME=template_path
    rem -------------------------------------------------------------------------
  4. Edit standalone.bat in the directory <Install-path>\WildFly\bin and replace template_path with the directory of JAVA_HOME-SED.

    <Install-path>\WildFly\bin\standalone.bat

    XML
    set JAVA_HOME=template_path
    rem -------------------------------------------------------------------------
  5. Edit standalone.conf.bat in the directory <Install-path>\WildFly\bin and replace template_path with the directory of JAVA_HOME-SED.

    <Install-path>\WildFly\bin\standalone.conf.bat

    XML
    rem set "JAVA_HOME=C:\opt\jdk1.6.0_23"
    set JAVA_HOME=template_path
  6. Create a WildFly administrator

    • Open console as administrator

    • Navigate to directory <Install-path>\WildFly\bin

    • Run add-user.bat

    • Answer questions as follows:

  7. Set up WildFly as a service

    1. Copy the folder service from directory <Install-path>\WildFly\docs\contrib\scripts to directory <Install-path>\WildFly\bin

    2. In the admin console, navigate to directory <Install-path>\bin\service

    3. Enter the command below with the corresponding variables for %wildfly-servicename%, %wildfly-ipaddr% and %wildfly-managementport%:

      <Install-path>\bin\service

      BASH
      service.bat install /startup /name=%wildfly-servicename% /display=%wildfly-servicename% /controller=%wildfly-ipaddr%:%wildfly-managementport% /config standalone.xml
  8. Create database

    1. In the console, change to the directory <Install-path>\<database>\bin .

    2. For MariaDB as the database, it is the directory <Install-path>\mariadb\bin, run the command mysql.exe -u "username" -p

Note

Here, the username and password of the database must be used.

c. Enter and execute the following commands with the corresponding variables for %mariadb-db-name%,%mariadb-wildfly-user%, %mariadb-wildfly-pw% and %host% .

XML
CREATE DATABASE %mariadb-db-name%;
GRANT ALL PRIVILEGES ON ece2.* TO %mariadb-wildfly-user%@'localhost' IDENTIFIED BY '%mariadb-wildfly-pw%';
GRANT ALL PRIVILEGES ON ece2.* TO %mariadb-wildfly-user%@'127.0.0.1' IDENTIFIED BY '%mariadb-wildfly-pw%';
GRANT ALL PRIVILEGES ON ece2.* TO %mariadb-wildfly-user%@'::1' IDENTIFIED BY '%mariadb-wildfly-pw%';
GRANT ALL PRIVILEGES ON ece2.* TO %mariadb-wildfly-user%@'%host%' IDENTIFIED BY '%mariadb-WildFly-pw%';
FLUSH PRIVILEGES;

d. Exit mysql.exe

Install RE-Cockpit

Linux

Linux

  1. ece.ear must be copied to the directory <Install-path>/WildFly/standalone/deployments.

  2. Start the WildFly service

  3. ece.ear will deploy automatically; this should be visible in the directory.

  4. The RE Cockpit can be opened in the web browser at: http://%hostname%:8080/ece-web-client/

Windows

Windows

  1. ece.ear must be copied into the directory <Install-path>\WildFly\standalone\deployments.

  2. Start the IF_WildFly service

  3. ece.ear deploys itself automatically; this should be visible in the directory.

  4. The RE-Cockpit can be opened in a web browser at: http://%hostname%:8080/ece-web-client/.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.