Installing on Linux

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.

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 -screen 0 1280x1024x24 &
   

   Note

   This command only needs to be performed after the initial installation or if the xvfb process is ever terminated.

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-linux_[version].tar
   

4. Enter the following command to assign execute privileges for the installer to the current user:

   sudo chmod u+x rest-linux_[version].sh
   

5. Enter the following command to run the installer:

   ./rest-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.

7. 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.

8. 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 for the installation.

9. Click Next to perform the installation.

10. On the License Server Type screen, select the option that matches the server type you are using for licensing, then click Next.

    • Nuix Management Server (NMS)
    • Relay server with NMS users
    • Relay server with CLS users
    • Cloud License Server (CLS)

11. If NMS or a Relay server was selected, enter the following details on the License Server Configuration screen, then click Next:

    Note

    If CLS is selected as the server type, this step is skipped.
    • 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.

12. On the License Server Credentials screen, enter the credentials for an account that has access to the selected server type, then click Next.

13. Review and make changes, if necessary, to the details provided on the Java & Folder Options screen.

14. After reviewing the Java & Folder Options screen, click Next to continue.
15. Specify how Nuix RESTful Service should be run:

16. 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 from an installation earlier than version 7.8, backed up Java Options can be added back to the installation after the upgrade 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" : "72670a5e-f0e1-4046-8b2e-22a42fe2ac9a",
    "startupTime" : null,
    "nuixRestfulVersion" : null,
    "engineVersion" : null
   }
   

API Documentation

The Nuix RESTful Service provides a robust Application Programming Interface (API) that enables you to integrate your product or application with the Nuix Engine. For information about the endpoints that are available within the API, refer to the Nuix RESTful Service API documentation.

The API reference documentation is included with Nuix Restful Service and can be accessed at the following URL after installation.

http://<localhost>:8080/nuix-restful-service/svc/docs