Skip to content

Manual Installation

Manually installing FusionReactor on your application servers requires you to manually place the FusionReactor the FusionReactor installation files and configure the JVM arguments for your application server.

This is ideal for scenarios where you have virtual machines or containers running in your environment, such as Hypervisor, Kubernetes, Docker or Rocket. In these environments being able to script an install of FusionReactor and automatically deploy the latest version of the application is ideal.

Installing FusionReactor manually requires some knowledge of your application server configuration and can be completed in just a few minutes.

Installing FusionReactor

Manual installation of a FusionReactor instance is a process that requires you to perform the following steps:

  1. Download the FusionReactor Installation files
  2. Create a directory structure for FusionReactor
  3. Place the FusionReactor installation into the directory structure
  4. Stop your Application Server
  5. Add additional JVM arguments to your Application Server configuration
  6. Start Your Application Server

Step 1: Download the FusionReactor Installation files

The installation of FusionReactor requires a javaagent to run the core FusionReactor product when your application starts.

There is also a debug library that can be optionally added for use of the Debugger and Event Snapshot features. We recommend you install this argument if you have a trial, ultimate or developer edition of FusionReactor so you have access to the full functionality of FusionReactor.

You can download the fusionreactor.jar file and debug libraries from the Java Agent Manual Installation tab of the FusionReactor Download Page or get the latest version of FusionReactor via URL.

Manual Install Downloads

The debug libraries is a zip file containing the libraries for all supported platforms.

Library Platform
frjvmti_x64.dll Windows
libfrjvmti_x64.so Linux
libfrjvmti_x64.dylib MacOS

Step 2: Create a directory structure for FusionReactor

To begin installing FusionReactor onto your application server, you must first create a directory structure for FusionReactor files to be stored within. This directory will contain your logs, configurations and installation files.

Note

It is important to ensure that the user running your application server can read and write to this directory. If this is not the case you may not be able to start the application server or save information such as logs or configuration to disk.

The recommended FusionReactor Directory structure is {FusionReactor root}/instance/{Instance Name}. For example:

Platform Path
Windows C:\\FusionReactor\Instance\myInstance
Linux /opt/fusionreactor/instance/myInstance
MacOS /Applications/FusionReactor/instance/myInstance

Step 3: Place the FusionReactor installation files into the directory structure

With your directory structure configured, you can now place the fusionreactor.jar and debug lib into your newly created instance directory.

To make configuring the FusionReactor instance quicker you should note down the exact path to these files for example C:\FusionReactor\Instance\myInstance\fusionreactor.jar and C:\FusionReactor\Instance\myInstance\frjvmti_x64.dll.

You only need to copy the debug library specific to your operating system.

Step 4: Stop your Application Server

JVM arguments for your Application Server are only read when the server / JRE (Java Runtime Environment) is started. For this reason we recommend that you stop your Application Server before adding or modifying your JVM arguments.

Step 5: Add additional JVM arguments to your Application Server configuration

In order to run FusionReactor, you must add JVM arguments to initialize the FusionReactor installation files.

To do this you add a Java Agent Path (-javaagent argument) pointing to the fusionreactor.jar file and the Debug native Library path (-agentpath argument) pointing to the debug library.

When entering the Java Agent path you specify the address and name that the FusionReactor instance will use.

  • The name should describe the application server FusionReactor is installed on, for example cf2018 or tomcat9.
  • The address should be the port and possible IP address of the FusionReactor instance, for example:
    • address=8088 would bind FusionReactor to the address 0.0.0.0:8088 which is bound to all IP address
    • address=127.0.0.1:8088 would bind to 127.0.0.1:8088 which is only accessible on localhost

Below are examples of adding FusionReactor to a java process that runs a jar file.

Windows Example:

java -javaagent:C:\FusionReactor\Instance\myInstance\fusionreactor.jar=name=myInstance,address=8088 -agentpath:C:\FusionReactor\Instance\myInstance\frjvmti_x64.dll -jar app.jar

Linux Example:

java -javaagent:/opt/fusionreactor/instance/myInstance/fusionreactor.jar=name=myInstance,address=8088 -agentpath:/opt/fusionreactor/instance/myInstance/libfrjvmti_x64.so -jar app.jar

MacOS Example:

java -javaagent:/Applications/FusionReactor/instance/myInstance/fusionreactor.jar=name=myInstance,address=8088 -agentpath:/Applications/FusionReactor/instance/myInstance/libfrjvmti_x64.dylib -jar app.jar

For a full list of example configurations for each supported Application Server see Examples.

Note

In order to complete the installation of FusionReactor, you will need to restart your application server if it is currently running for the changes to the JVM arguments to take effect.

Step 6: Start your Application Server

With your JVM arguments modified, when you run your Application Server FusionReactor should start within the Java process.

To confirm this, you can view your Application logs and look for the FusionReactor block as shown below:

INFO Fusionreactor: --------------------------------------------------------------------------------------
INFO Fusionreactor: FusionReactor - Copyright (C) Intergral GmbH. All Rights Reserved
INFO Fusionreactor: Revision: {version} fusionreactor.xxxxx.xxxxx
INFO Fusionreactor: Date    :  {date}
INFO Fusionreactor: Java    :  {JRE Version}
INFO Fusionreactor: OS      :  {OS Information}
INFO Fusionreactor: --------------------------------------------------------------------------------------

You will see typically see this log in your catalina.log or ColdFusion-out.log files, but depending on your logging configuration this could change.

Upgrading FusionReactor

Upgrading FusionReactor requires you to replace the FusionReactor installation files within your instance directory with the updated files. To do this follow these steps:

  1. Stop your Application Server
  2. Download the latest FusionReactor installation files
  3. Replace the FusionReactor installation files for your instance
  4. Start your Application Server

Step 1: Stop your Application Server

JVM arguments for your Application Server are only read when the server / JRE (Java Runtime Environment) is started. For this reason we recommend that you stop your Application Server before adding or modifying your JVM arguments.

Step 2: Download the latest FusionReactor installation files

The installation of FusionReactor requires a javaagent to run the core FusionReactor product when your application starts.

There is also a debug library that can be optionally added for use of the Debugger and Event Snapshot features. We recommend you install this argument if you have a trial, ultimate or developer edition of FusionReactor so you have access to the full functionality of FusionReactor.

You can download the fusionreactor.jar file and debug libraries from the Java Agent Manual Installation tab of the FusionReactor Download Page or get the latest version of FusionReactor via URL.

Manual Install Downloads

The debug libraries is a zip file containing the libraries for all supported platforms.

Library Platform
frjvmti_x64.dll Windows
libfrjvmti_x64.so Linux
libfrjvmti_x64.dylib MacOS

Step 3: Replace the FusionReactor installation files for your instance

In order to replace the installation files of FusionReactor, you will need to navigate to the instance directly of FusionReactor and replace both the fusionreactor.jar and debug lib files with the new versions you have downloaded.

If you are using the default installation path, the paths to your instance will be:

{/Common/Platform-Directory!}

Step 4: Start your Application Server

Now that the files have been replaced, you can restart your application server and the newer edition of FusionReactor should be running.

You can confirm that the new edition is running either by examining the FusionReactor block in the application server log or by navigating to the about page of the FusionReactor instance and viewing the revision. FusionReactor Block:

INFO Fusionreactor: --------------------------------------------------------------------------------------
INFO Fusionreactor: FusionReactor - Copyright (C) Intergral GmbH. All Rights Reserved
INFO Fusionreactor: Revision: {version} fusionreactor.xxxxx.xxxxx
INFO Fusionreactor: Date    :  {date}
INFO Fusionreactor: Java    :  {JRE Version}
INFO Fusionreactor: OS      :  {OS Information}
INFO Fusionreactor: --------------------------------------------------------------------------------------
Revision in the about page:

Upgrade Complete

Uninstalling FusionReactor

Uninstalling FusionReactor requires you to remove both the Java Agent Path and Debug Library Path from your JVM arguments. You can then remove the instance from the FusionReactor Directory.

To do this you can follow the steps below:

  1. Stop your Application Server
  2. Remove the JVM arguments for FusionReactor
  3. Start the Application Server
  4. Remove the FusionReactor installation files (Optional)

Step 1: Stop your Application Server

JVM arguments for your Application Server are only read when the server / JRE (Java Runtime Environment) is started. For this reason we recommend that you stop your Application Server before adding or modifying your JVM arguments.

Step 2: Remove the JVM arguments for FusionReactor

In order to install FusionReactor you add a Java Agent Path (-javaagent argument) and Debug Library Path (-agentpath) argument to your JVM arguments. You may have also added system properties for the configuration of FusionReactor (prefixed with ‘-Dfr...’).

In order to uninstall FusionReactor the following arguments must be removed:

  • -javaagent:{path}/fusionreactor.jar
  • -agentpath:{path}/{debug library}
  • Any argument beginning with ‘-Dfr’

Step 3: Start the Application Server

Now that FusionReactor has been removed the Application Server can be restarted.

Step 4: Remove the FusionReactor installation files (Optional)

Note: If you are uninstalling FusionReactor as it is not required at the time, you should skip this step to retain any log and configuration date when you reinstall FusionReactor.

When FusionReactor is not running, the instance directory can now be removed from the local file system.

If you are using the default installation path, the paths to your instance will be:

Platform Path
Windows C:\\FusionReactor\Instance\myInstance
Linux /opt/fusionreactor/instance/myInstance
MacOS /Applications/FusionReactor/instance/myInstance