Install on Linux

Install the Nuix RESTful Service in a Linux environment.

Nuix RESTful Service provides a wizard-based installer that guides you through the installation and initial configuration of the application. Follow the steps in this section to complete your installation of Nuix RESTful Service in a Linux environment.

Depending on the configuration of your system, Nuix RESTful Service can be installed into both graphical and non-graphical environments using the same installer.

If performing an upgrade, ensure that a backup of your existing Java Options is made prior to installation as these values will be overwritten. These values can be found in the bin/setenv.sh file within your installation directory. See Verifying Java Options after completing your upgrade for steps on adding these configurations back to installation.

Prerequisites

The following prerequisites must be installed prior to using Nuix RESTful Service in a Linux environment.

  • GTK+ graphical user interface library
  • X11 Screen Saver extension library
  • Chromium browser (if using OCR)

Perform the following steps to install all prerequisites:

  1. Open a terminal within your Linux environment:
  2. Based on your operating system, enter one of the following commands to install the dependences:
    • Debian/Ubuntu: apt-get install libgtk-3-0 libxss1 xvfb
  3. If using the Nuix OCR Addon, install the Chromium browser using the following command:
    sudo apt install --assume-yes chromium-browser
    
  4. After installation completes, start the X-Server Virtual Framebuffer using the following command:
    Xvfb :1 &
    

Installation

Perform the following steps to install Nuix RESTful Service.

  1. Download the Linux installer from the Nuix Customer Portal.
  2. Open a terminal and navigate to the directory that contains the installer.
  3. Enter the following command to untar the installer:
    tar xvf [path to installer]rest-OEM-linux_[version].tar
    
  4. Enter the following command to assign execute privileges for the installer to the current user:
    sudo chmod u+x rest-OEM-linux_[version].sh
    
  5. Enter the following command to run the installer:
    ./rest-OEM-linux_[version].sh
    

    The installer may take a moment to prepare the wizard. When complete, follow the steps within the wizard to complete the installation. If installing in a non-graphical environment, the following steps will be presented within the terminal.

  6. From the Welcome Screen, click Next to begin.
  1. Read and understand the terms included in the Nuix End User License Agreement.
    • If you agree to the terms, select I accept the agreement, and click Next.
  2. If installing for the first time, choose a location to install Nuix RESTful Service.
    • Click Next to accept the default location and proceed.
    • Alternatively, click Browse to choose a specific location to install the application files.
  3. Click Next to perform the installation.
  4. On the License Server Configuration screen, provide the following details then click Next:
    • Server address: The URL used to access a configured Nuix Management Server.
    • Server port: The server port used to access the configured Nuix Management Server.
  5. Enter credentials for an account that has access to the specified Licensing Server, then click Next.
  6. Review and make changes, if necessary, to the details provided on the Java & Folder Options screen.
Option Description
Java Options Optimize the Java settings used by Nuix RESTful Service to suit your hardware specifications. Define one argument per line.
Default settings are recommended for most configurations. For help or assistance with tuning your JVM settings, contact the Nuix Support team at https://nuix.service-now.com/support.
IP Address or Hostname The URL that will be used to access Nuix RESTful Service.
Connection Timeout Specify the amount of time that REST should wait for a response after accepting a connection. Use a value of -1 to indicate no timeout.
HTTP Port The server port used to access Nuix RESTful Service.
Case Directory Specify a location where case files are stored.
User Scripts Directory Specify a location where user generated scripts are stored.
Logs Directory Specify a location to save logs generated by Nuix RESTful Service.
  1. After reviewing the Java & Folder Options screen, click Next to continue.
  2. Specify how Nuix RESTful Service should be run:
Option Description
Service Run Nuix RESTful Service in the background as a Windows service.
Application Run Nuix RESTful Service as a standalone application. See Starting in Application Mode after installation completes for details on starting the application.
Start Service Select this checkbox, if the Service option was selected, to start the Nuix RESTful Service when installation completes.
  1. Click Finish to complete the setup and exit the wizard.

Post-Installation Configuration

After completing the installation of Nuix RESTful Service, the following configurations should be considered.

Verifying Java Options

If upgrading an existing installation to version 7.8, any backed up Java Options can be added back to the upgraded installation using the following steps.

To add any of these options to your existing installation:

  1. Navigate to the location where Nuix RESTful Service is installed.
    • Debian/Ubuntu default path: /opt/nuix-restful-service
  2. Locate and open Nuix-REST.vmoptions within a text editor.
  3. Modify the file, adding one argument per line.
  4. Save and exit the editor.
  5. Restart Nuix RESTful Service.

Starting in Application Mode

If Nuix RESTful Service was configured to be run as a standalone application, the service must be manually started and stopped.

To start Nuix RESTful Service in Application Mode:

  1. Open a terminal.
  2. Navigate to the location where Nuix RESTful Service is installed.
    • Debian/Ubuntu default path: /opt/nuix-restful-service
  3. Start the application using the following command:
    ./nuix-rest start
    
  4. Stop the application using the following command:
    ./nuix-rest stop
    

Verifying Your Installation

Once your installation is complete, complete the following steps to verify your deployment:

  1. Open a web browser and enter the following URL
    localhost:8080/nuix-restful-service/svc/v2/about
    
  2. If the installation was successful, the response body will return with information about the RESTful service.
     "server" : "http://localhost:8080/nuix-restful-service/svc",
     "serverId" : "rest-oem-server",
     "startupTime" : null,
     "nuixRestfulVersion" : null,
     "engineVersion" : null
    }
    
Last modified January 7, 2021