Installing on Windows

Install the Nuix RESTful Service in a Windows 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 Windows environment.

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.bat file within your installation directory. See Verifying Java Options after completing your upgrade for steps on adding these configurations back to installation.

Installation

To get started, perform the following steps to install:

  1. Download the Windows installer from the Nuix Customer Portal.
  2. Browse to the location that contains the installer.
  3. Right-click on the installer and choose Run as administrator, even if you are already running as an administrator. The installer may take a moment to prepare for the installation. When the initial preparation is complete, follow the steps within the wizard to complete the installation.
  4. From the Welcome Screen, click Next to begin.
  5. 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.
  6. 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.
  7. Click Next to begin the installation.
  8. 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.
  9. Enter credentials for an account that has access to the specified Licensing Server, then click Next.
  10. 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 Configurations

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

Windows Service User Account

If Nuix RESTful Service is configured to be run as a Windows service, the default Log On account associated with the service must be changed when performing a new installation to ensure proper operation of the application.

To update the Log On account associated with Nuix RESTful Service:

  1. Use the Keyboard shortcut Win + R to open the Windows Run dialog box.
  2. Type services.msc in the text field, then press OK.
  3. In the Windows Services Manager, locate the Nuix-Rest service.
  4. Right-click on the service and select Properties.
  5. Select the Log On tab.
  6. Select This Account, and provide the appropriate credentials for an account to use
  7. Click Apply.

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.

    Default path: C:\Program Files\Nuix\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 command prompt.

  2. Navigate to the location where Nuix RESTful Service is installed.

    Default path: C:\Program Files\Nuix\Nuix RESTful Service

  3. Start the application using the following command:

    Nuix-REST.exe /run

  4. Stop the application using the following key combination within the command prompt:

    Ctrl + C

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 
}

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
Last modified January 7, 2021