Linux/Unix/Mac Installation

The following guide outlines the process of installing Report Out on Linux, Unix, or Mac OSX.

Java Installation

Report Out requires the latest version of the Java Run time Environment (JRE) 1.8 or later to be installed.  If it is not already installed, you will need to install Java 8 using your systems built-in utilities or download and install the latest version of Java from Oracle at https://java.com/.

Ubuntu 16.04 or later

# sudo apt install openjdk-8-jdk

Report Out Installation

Download the latest version of Report Out and extract the zip file to a folder.  Report Out doesn’t need to be installed, it should be executed directly from the extracted folder.  There are two components to Report Out which are referred to as the Frontend and the Backend.

  • Open a two terminal windows and navigate using the cd command into the ReportOut directory.
  • In the first window execute:
    ./StartBackend.sh
  • In the second window execute:
    ./StartFrontEnd.sh

These command do not need to be run as root or with the sudo command.  They can be executed by a standard user account.  Wait for both services to start up, which may take up to 5 minutes to complete.  After the services have started you can access Report Out by opening a browser and navigating to:

URL:
http://localhost:8080

Username:
admin@localhost.loc

Password:
password

Report out will create a directory called ReportOutData and will store it in the home directory of the user who executed Report Out.  This directory includes settings, email templates, the Report Out database, logs, and database drivers.  This folder should be backed up to ensure recovery of Report Out is possible.

Email Setup

If you would like Report Out to sent data via Email or if you would like to be able to send confirmation emails, you will need to configure Report Out to connect to a SMTP server.  This is done by editing the application.properties file which is located in the ReportOutData directory in your home folder.  After making changes to this file you will need to restart Report Out.

Remote Connections

By default, the frontend service will only connect to localhost, if you would like to allow connections from remote hosts, you will need to modify the following file:

[ReportOutRoot]/web-root/app/model/appsettings/appsettings.js

Change:

 Object.defineProperty(AppSettings, "backEndRoot", {
 get: function () {
 return "http://127.0.0.1:8081";
 },
 enumerable: true,
 configurable: true
 });

to

 Object.defineProperty(AppSettings, "backEndRoot", {
 get: function () {
 return "http://X.X.X.X:8081";
 },
 enumerable: true,
 configurable: true
 });

where X.X.X.X is the IP address the machine running Report Out.

Upgrading Report Out

Most of the data for Report Out is stored in the ReportOutData directory on your home directory, so upgrading is very simple.  To upgrade perform the following steps.

  1. Stop Report Out
  2. Download and extract the latest version of Report Out
  3. Start the new version of Report Out by executing the StartBackend.sh and StartFrontEnd.sh files

Once you upgrade, it is typically not possible to downgrade to a previous version as database modifications can not be rolled back.