Skip to content

Installing and using FRAM

You can download the full installer from the FusionReactor Download page on the website or via the URLs directly.

Download URLs

The following table lists the URLs for the agent jar file, debugger native libraries and the full installers.

File URL
FusionReactor Single Jar https://intergral-dl.s3-us-west-1.amazonaws.com/FR/Latest/fusionreactor.jar
Debug Native Libraries (All Platforms) https://intergral-dl.s3-us-west-1.amazonaws.com/FR/Latest/debuglibs.zip
Debug Library for Windows https://intergral-dl.s3-us-west-1.amazonaws.com/FR/Latest/frjvmti_x64.dll
Debug Library for Linux https://intergral-dl.s3-us-west-1.amazonaws.com/FR/Latest/libfrjvmti_x64.so
Debug Library for MacOS https://intergral-dl.s3-us-west-1.amazonaws.com/FR/Latest/libfrjvmti_x64.dylib
Debug Library for Arm64 (aarch64) https://intergral-dl.s3-us-west-1.amazonaws.com/FR/Latest/libfrjvmti_aarch64.so
FusionReactor Full Installer for Windows https://intergral-dl.s3-us-west-1.amazonaws.com/FR/Latest/FusionReactor_windows-x64.exe
FusionReactor Full Installer for Linux https://intergral-dl.s3-us-west-1.amazonaws.com/FR/Latest/FusionReactor_linux-x64.sh
FusionReactor Full Installer for MacOS https://intergral-dl.s3-us-west-1.amazonaws.com/FR/Latest/FusionReactor_macos.dmg
Preconfigured No JRE (Windows) https://intergral-dl.s3-us-west-1.amazonaws.com/FR/Latest/FusionReactor_windows_nojre.zip
Preconfigured No JRE (Unix) https://intergral-dl.s3-us-west-1.amazonaws.com/FR/Latest/FusionReactor_unix_nojre.tar.gz

The Full installer or Preconfigured Installation of FusionReactor both include the FRAM (FusionReactor Administration Manager) and should only take a few minutes to set up.

The full installer includes a JRE (Java Runtime Environment) and allows you to customize your setup location, runtime user, password and port.

The preconfigured installation assumes the default configuration of the FusionReactor and requires you to have your own JRE configured on the server. You will be prompted to set a password as soon as the installer runs.

There is a preconfigured Windows zip file or Tarball preconfigured to run on both MacOS and Linux operating systems.

Video

Using the Full Installer

There is a separate installer for each support Platform.

Note

As of FusionReactor version 8.1.0 there are no 32 bit installers available. To install FusionReactor on 32 bit systems you must manually install FusionReactor.

Platform Installer Name To run
Windows FusionReactor_windows-x64.exe Run FusionReactor_windows-x64.exe as an Administrator user
Linux FusionReactor_linux-x64.sh Run FusionReactor_linux-x64.sh as root
MacOS FusionReactor_macos.dmg Run FusionReactor_macos.dmg as root

On each platform the installer must be run as an elevated used such as Administrator / Super User. If an attempt is made to run the install without an elevated user the installer will exit and a warning will appear.

Installing using the Full Installer

Running the installer for the first time, you will have the option to configure your installed FRAM (FusionReactor Administration Manager) Service. You can only have one copy of FusionReactor installed on a single server.

When running the installer, you will first see a welcome screen.

Clicking the Next button will proceed with the installation and open the License Agreement screen.

Please carefully review the license agreement before continuing, then choose the 'I accept the agreement' option (if you accept the terms and conditions) and click Next to proceed. Press Cancel if you do not accept the license agreement. This will exit the installer.

If you have accepted the license agreement, clicking next will shows the Select Destination Directory screen.

In this screen you select the directory in which FusionReactor should be installed. By default FusionReactor will be installed into:

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

Click Next to proceed to the FusionReactor Configuration screen.

The default HTTP port for FusionReactor Administrator is 8087. The installer will check if the selected port is available by attempting to open a connection to it and change the default port if it is in use. However, if you have another application using this port which is currently not running the installer will not be able to warn you.

Clicking Next opens the FusionReactor Configuration screen

Specify the password to be used by the Administrator user on FusionReactor. To validate the password you have to enter it one more time in the confirmation field. The installer will check that the password is at least five characters long and that the two values you have entered are identical.

On Linux and MacOS installations, clicking next will open a further FusionReactor Configuration screen.

In this screen you configure the user and group the FusionReactor daemon will run under. Typically you will choose the same user and group as used by the application servers on this computer into which you want to install instances of FusionReactor.

Clicking next opens the Confirm Settings screen

In the Confirm Settings screen shown you can choose if the installer should create a desktop shortcut to FusionReactor Administrator (Windows only) and if the FRAM Service should be started after all files have been installed.

If you do not want the installer to create a desktop shortcut unselect the option 'Create Desktop Shortcut to FusionReactor Administration Manager''. If you do not wish to start the FRAM Service at this moment, or wish to manually start the FRAMService unselect the option 'Start FusionReactor Service'.

Click Next to begin installing FusionReactor, Back to review the installation configuration or Cancel to exit the installer.

After the installation has finished you are presented with the Installation completed screen.

You can now click Start configuring instances or navigate to {hostname}:{FRAM port} to access the instance manager on the FRAM service.

Warning

Installing the FRAM service of FusionReactor is only part of the install process. The FRAM will installation will give you access to the Instance Manager and Enterprise Dashboard, which you must then use to install FusionReactor onto your Application Servers. To continue the installation see Configuring a FusionReactor instance in FRAM

Upgrading the Full Installer

Upgrading the full installer of FusionReactor requires you to download a newer version of the Full Installer and run the new installer on the server that currently has FusionReactor installed on.

Note

It is important to remember that upgrading the FRAM Service does not upgrade the instances of FusionReactor on your Application Server. This is done to prevent FusionReactor restarting your applications when an upgrade is performed. You must go to the Instance Manager and upgrade each instance individually.

If FusionReactor is not currently installed on the server, you will be guided through the full installation process.

When running the installer, you will first see a welcome screen.

Clicking the Next button will proceed with the installation and open the License Agreement screen.

Please carefully review the license agreement before continuing, then choose the 'I accept the agreement' option (if you accept the terms and conditions) and click Next to proceed. Press Cancel if you do not accept the license agreement. This will exit the installer.

Clicking next will show the FusionReactor Update screen

Here you can choose whether to start the FRAM Service after the upgrade is complete and add a Desktop shortcut (Windows only) for FRAM providing it does not already exist.

Clicking next will perform the upgrade then show the Installation Completed Screen.

Uninstalling the Full Installer

Uninstalling the FRAM Service of FusionReactor can be achieved by running the Uninstall command that is located in your FusionReactor directory.

The Uninstaller must be run as an Administrator / Super user of the server.

Note

In windows it is also possible to trigger the uninstaller via the Add or Remove Programs tool

Uninstalling FusionReactor will completely remove the FusionReactor directory, including all of the generated data such as log files and configurations. Please take care that you back up any files you want to keep before running the uninstaller.

When you run the installer, the FusionReactor Uninstall screen will display.

Clicking next will scan the FusionReactor Directory to check if there are currently FusionReactor instances installed within your application servers. If there are existing instances you will see an Instances Detected warning.

We strongly recommend that you follow the ‘Open FusionReactor Instance Manager to uninstall instances now’ link and Uninstall your existing FusionReactor instances

Note

You can ignore this warning and continue uninstallation but you may then see that you can no longer start your application servers. This is because arguments in your JVM.config file will now reference FusionReactor files that do not exist.

If you have no instances installed or choose to continue the uninstallation of FusionReactor with the warning, the uninstaller will remove all files in the FusionReactor directory and the FRAM service.

You will see the FusionReactor Uninstall confirmation screen when this is complete.

Using the Full Installer in console mode

It is possible to use the FusionReactor installer without a GUI by starting it in console mode.

To run the installer in console mode you can append "-c" to the run command, for example:

start /wait FusionReactor_windows-x64.exe -c
sh ./FusionReactor_linux-x64.sh -c
hdiutil mount FusionReactor_macos_6_0_0.dmg /dev/disk1 /Volumes/FusionReactor
/Volumes/FusionReactor/FusionReactor\ Installer.app/Contents/MacOS/JavaApplicationStub -c

Warning

In order to use the console installation on Linux, the libfontconfig package must be installed onto the server. This package is available in all major package managers such as apt, yum and dnf. If the package is not installed you will see an error similar to:

    Unpacking JRE ...
    Starting Installer ...
    An error occurred:
    java.lang.RuntimeException: java.lang.reflect.InvocationTargetException
    Error log: /tmp/install4jError2433237224578255824.log

When running the installer you will be prompted to input the same information as you would when using the GUI installer. Upon completion of the console installation, the FRAM instance will be available at {hostname}:{FRAM port}.

Warning

Installing the FRAM service of FusionReactor is only part of the install process. The FRAM will installation will give you access to the Instance Manager and Enterprise Dashboard, which you must then use to install FusionReactor onto your Application Servers. To continue the installation see Configuring a FusionReactor instance in FRAM

Using the Uninstaller in console mode

There is an uninstaller located at the root of the FusionReactor directory.

To run the uninstaller in console mode you can append "-c" to the run command, for example:

cd C:\FusionReactor
start /wait uninstall.exe -c
cd /opt/fusionreactor/
sh ./uninstall.sh -c
cd /Applications/FusionReactor
./FusionReactor\ Uninstaller.app/Contents/MacOS/JavaApplicationStub -c

Warning

We strongly recommend that you uninstall your existing FusionReactor instances before uninstalling FusionReactor.

Using the Preconfigured Installer

There is a separate installer for Windows and Unix (Linux and MacOS) platforms.

Note

As of FusionReactor version 8.1.0 there are no 32 bit installers available. To install FusionReactor on 32 bit systems you must manually install FusionReactor.

Platform Installer Name To run
Windows FusionReactor-windows-nojre.zip 1. Extract FusionReactor-windows-nojre.zip

2. Navigate into the Extracted FusionReactor Directory

3. Run Start.bat
Unix (Linux and Mac) FusionReactor-unix-nojre.tar.gz 1. Extract FusionReactor-unix-nojre.tar.gz

2. Navigate to the extracted fusionreactor directory

3. Run start.sh

After running the start command, a FRAM instance will have started on port 8087 of the server. When running you can access the instance manager on any IP address from your browser, for example:

  • 127.0.0.1:8087
  • 192.1.1.1:8087

You will be prompted to enter a password for the FusionReactor instance the first time you access the Instance Manager.

Warning

Installing the FRAM service of FusionReactor is only part of the install process. The FRAM will installation will give you access to the Instance Manager and Enterprise Dashboard, which you must then use to install FusionReactor onto your Application Servers. To continue the installation see Configuring a FusionReactor instance in FRAM

Upgrading the Preconfigured Installer

In order to update the preconfigured installer you will need to replace the FusionReactor files on the local file system with the updated versions.

Note

It is important to remember that upgrading the FRAM Service does not upgrade the instances of FusionReactor on your Application Server. This is done to prevent FusionReactor restarting your applications when an upgrade is performed. You must go to the Instance Manager and upgrade each instance individually.

To do this you should:

  1. Download the FusionReactor Single Jar and Debug Native Libraries (All Platforms) zip file 2.Navigate to the FusionReactor directory
  2. Stop the FRAM service
  3. Navigate to the etc > lib directory of FusionReactor
  4. Remove any existing files
  5. Place a copy of the fusionreactor.jar and extracted debug libraries in this directory
  6. Navigate to the instance > FRAM directory of FusionReactor
  7. Place a copy of the fusionreactor.jar file in this directory
  8. Start the FRAM service

Following this process will update the version of FusionReactor running in the Preconfigured installer.

Using FRAM

With FRAM (FusionReactor Administration Manager) installed, you are now in a position that you are able to install FusionReactor instances onto your application servers.

FRAM is not a full instance of FusionReactor, it includes the Instance Manager and Enterprise Dashboard only.

The intention for a FRAM instance is to be used to install instances of FusionReactor on your Application Server and to host a dashboard for your FusionReactor instances to be displayed on.

Video

Scanning the local file system for your Application Servers

In order for the Instance Manager to install instances of FusionReactor on your Application Servers, they must first be detected as being installed on the server.

To do this within the Instance Manager you can use the Scan System functionality of FRAM. To scan the system you can specify the Root Scan Directory and the Scan Depth.

The Root Scan Directory will default to the server root; / for unix and C:\ for Windows. We recommend that instead of scanning the entire root directory you specify the path to a specific application directory to save time when scanning the file system.

The Scan depth is the number of sub directories that will be scanned when you click Scan System. We recommend keeping this number low when possible as scanning the full local file system can take a significant amount of time.

Note

It is important to ensure that the user running FRAM must have sufficient permissions to scan the directory of your Application Server. If for example your FRAM Service is running as a system user and the directory is owned by the administrator we will not be able to detect the server.

When you scan the system, FusionReactor will scan for specific files that allow it to identify the type of Application Server that is installed. An Entry for each Application Server will be created when the scan is completed.

Now that the Application Servers have been detected FusionReactor can be installed.

Configuring a FusionReactor instance on your application server

To configure a FusionReactor instance on your Application Server you can click the ‘plus icon' within the instance manager. This will launch the instance configuration wizard.

The first view you see is the Configure Settings tab, this allows you configure the instance name and connection settings for the instance.

The Instance Name will default to the name of the Application Server, but can be modified to any value.

The FR Port and FR Address fields refer to the configuration of the Internal Web Server.

  • The FR Port will default to port 8088, if this port is in use the port number will increment accordingly.
  • The FR Address binds the FusionReactor port to a specific IP address if enabled, if this setting is disable the port will be bound to 0.0.0.0 and listen on all addresses.

The External Web Server Access setting will disable the access to FusionReactor via the External Web Server, making it so that you can only access FusionReactor via the Internal Web Server.

Clicking Next will display the Instance Password tab.

Here you must specify a password for FusionReactor and confirm the password. Clicking next will display the instance within the [Enterprise Dashboard]../Enterprise-Dashboard/Enterprise-Dashboard.md) tab.

Here you can choose whether to add this instance to your Enterprise Dashboard.

Note

If you plan to use the Ephemeral Data Service you should select no.

Clicking next will show the Options tab. Here you can specify how the Application Server should be started.

When possible FusionReactor will default it’s settings to automatically configure and run your Application server so that FusionReactor can be installed.

The Start / Stop Options are:

  • Use the Windows / Linux Service (FRAM will make a call to the service to start, stop or restart the service)
  • Use the Application Server run command (FRAM will run the run command to start, stop or restart the Application Server)
  • Manually start/stop the server (This option requires you to start and stop the Application Server yourself)

The Install / Uninstall options are:

  • Automatically configure the Application Server config file (FRAM will inject the required java arguments into the Application Server configuration)
  • Manual Configuration (This option requires you to manually add JVM arguments to your Application Server config file)

Warning

If you only have the option to Manually start/stop the server and Manual Configuration this indicates that the FRAM user is unable to execute commands or modify files in the directory of the Application Server. You should ensure that the user running the FRAM service can read and write to the directory of the Application Server to correct this.

The Restart Server option will specify whether your Application server should be restarted after the jvm arguments have been configured.

Warning

It is important to understand that if your Application Server is running and you select ‘No’, the Application Server will be stopped and NOT restarted.

Clicking Next will show the Confirm Settings modal. Here if you click confirm the instance of FusionReactor will be installed. If successful you will be redirected to the Instance Manager, where you will see a link to the FusionReactor instance.

If any error occurs during installation you will see a Start Failed modal.

When FusionReactor Attempts to start the instance, there is a timeout of 30 seconds in place, if your Application Server takes longer than 30 seconds to start, you may see Start Failed and as soon as the server comes online your server will then be running.

You can check the Instance Manager log file to diagnose why the start command failed. Likely causes for this are:

  • There was a permissions issue starting the Application Server
  • The start up process timed out
  • There was No JRE specified for the Application Server

Upgrading the FusionReactor instance on your application server

Upgrading an installed instance of FusionReactor requires you to first upgrade the FRAM installation:

To Upgrade the Full Installer see Upgrade Full Installer To upgrade the Preconfigured Installer see Upgrade Preconfigured Installer

Once the FRAM instance has been upgraded, in the Instance Manager you will see an upgrade button appear next to the Stop, Start/Restart and Remove buttons.

Note: In order to upgrade FusionReactor the Application Server must be restarted, you may need to schedule the upgrade at a period of time where downtime is allowed.

Clicking the upgrade button will trigger the upgrade process.

In the Configure Instance modal, you can specify whether to restart the Application Server.

Warning: It is important to understand that if your Application Server is running and you select ‘No’, the Application Server will be stopped and NOT restarted.

Clicking Next and then clicking confirm will upgrade FusionReactor and Restart your Application Server.

Uninstalling a FusionReactor instance from your application server

You can uninstall an instance of FusionReactor by clicking the delete button within the Instance Manager.

Note

In order to uninstall FusionReactor the Application Server must be restarted, you may need to schedule the removal at a period of time where downtime is allowed.

Clicking the remove button will trigger the removal process.

In the Configure Instance modal, you can specify whether to restart the Application Server.

Warning

It is important to understand that if your Application Server is running and you select ‘No’, the Application Server will be stopped and NOT restarted.

Clicking Next and then clicking confirm will remove FusionReactor and Restart your Application Server.