Last updated

How do I install a new instance of Nodinite?

This document will guide you through the steps required to install a new instance with the Core Services for Nodinite. Installation is easily being performed by an administrator using the Nodinite Update Application. The install process usually takes less than 15 minutes (Basic track).

During the installation, you must click inside every single text box to verify/validate the content. When valid, a (green) check appears on the left side of the label you can move on to the next input field.

Installation Checklist

  1. You must have installed the latest version of the Nodinite Install and Update tool using this install guide.
  2. The prerequisites for the Nodinite core services must be met before installing a new instance of Nodinite.
  3. Make sure to download the latest version of Nodinite Core Services packages

Make sure to download, install and use the latest version of the Nodinite Update Application before installing or updating the Core Services of Nodinite.


Step 1 Basic install

Click on the Install button to open the installation dialogue.
png_Menu_Install_Button

General: The first step of installing Nodinite involves the configuration of a unique specifically named instance. This step includes among other things setting up details for the Licensee.

Using the Basic tab the following configuration steps must be followed to install a new instance of Nodinite:
Install

  1. Version to Install, Select which version to install (the highest downloaded version is pre-selected)
  2. Customer Name, Enter the company/customer name (Associated with the Product Key for Licensee)
  3. Product key, Enter the Product Key (Associated with the Customer Name for Licensee)
  4. Environment Name, Enter the mandatory custom name of the target environment (QA/DEV/PROD)
  5. Update Service Address, Preset to the default API endpoint for the local Nodinite Update Service

    http://localhost:8000/Nodinite/Service/Update/

Nodinite supports the use of multiple Update Services, installed on many different Windows servers. This is often the case for hardened environments.

  1. Installation account name, Enter credentials for the Service Account running the Monitoring Service, Logging Service and the WebAPI (can be overridden individually later on in the installation)
    4.1 Set User Name for Service Account
  2. Installation account password Enter the password
  3. Click on Validate Account to validate that user and password information is correct

When every (green) is shown for every field the setup will automatically continue to the next installation step.

General completed successfully
If all fields are validated successfully the accordion will close and is prefixed with a green check

Step 2 Install the Configuration database

The second step of installing Nodinite involves the setup of the configuration database we name and call the 'Configuration Database'.

The Install and Update Tool detects if the SQL Server is either:

  • Stand alone (including fail-over cluster) or
  • Always On in which case you must read the About Always On user guide first

The following configuration steps must be followed in order:
Install

  1. Use the previously installed configuration database, When checked, an existing configuration database will be used. This is typically chosen when performing in-place updates (for example v3.x -> v4.x) or when you change application server for Nodinite keeping the database.
    Enter the information pointing to the SQL server with the existing configuration database.

CustomInstallationOldConfigDB
Exception message is shown if the provided Server or Database does not point to an old Configuration Database

  1. Database Server, Enter the name of the SQL Server database server (default or named instance)
  2. Database Name, Enter the name of the Configuration Database.. To avoid mixups the provided naming scheme like NodiniteConfig_<environment> should be honoured
  3. Install, Click Install to install (or upgrade) the Configuration Database

When every input field is checked (green) the 'Install' button is enabled. After the installation has completed with success, the setup will automatically close this accordion and continue to the next installation step.

ConfigurationDatabaseCompleted
After the installation has completed the accordion close and is prefixed with a green check

Advanced Tab

If you switch to using the Advanced tab instead of the Basic tab some additional fields exists for this step with the following options:
Install Configuration Database Advanced options
Advanced tab options

  1. use the default Update Service, When checked, the installation will use the Update Service information provided in the General section. Uncheck Common values are http://localhost:8000/Nodinite/Service/Update or http://localhost:8000/IM/Service/Update
  2. use the default Account for installation, When checked, the installation will use the Service credentials provided in the General section
  3. Advanced file settings - Advanced file settings allow you to alter SQL instance default file settings
  4. Override default path for SQL data files - Override the default location where SQL Server creates data files. Enter a valid path for Config database DATA files (MDF)
C:\Program Files\Microsoft SQL Server\MSSQL12.MSSQLSERVER\MSSQL\DATA\
  1. Override default path for SQL log files - Override the default location where SQL Server data creates log files. Enter a valid path for Config database LOG files (LDF)
C:\Program Files\Microsoft SQL Server\MSSQL12.MSSQLSERVER\MSSQL\DATA\

Always on

If you use the SQL Always On Listener name then the Install and Update Tool automatically detects the current configuration and you must specify a valid accessible path for SQL Server backup files (The account running the SQL Service on all nodes must have access to this highly available share).

AlwaysOnConfiguration
The configuration page for Always On SQL Server target environments

Nodinite will automatically perform the required backup to the backup folder and then set the Configuration Database in the Synchronization state.

Step 3 Install the Logging Service

Options to install the Logging Service.
Install
Basic tab options

  1. Folder - Set the root path where the Logging Service will be installed (this folder should include the name of the environment).
C:\Program Files\Nodinite\Test\Nodinite Core Services\
  1. Service Name - Name of the Logging Service as installed Windows Service. To avoid problems with multiple environments installed on the same server, the proposed service name is Nodinite <environment> Logging Service (it is recommended that you keep this naming convention).
  2. Click on the Install button to install the Logging Service.

When every input field is checked (green) the 'Install' button is enabled. After the installation has completed with success, the setup will automatically close this accordion and continue to the next installation step.

LoggingServiceCompleted
After the installation has completed the accordion close and is prefixed with a green check

Advanced tab

If you switch to using the Advanced tab instead of the Basic tab some additional fields exists for this step with the following options:
Install Logging Service Advanced tab
Advanced tab options

  1. use the default Update Service - Uncheck the checkbox above if to use another Nodinite Update service for installation of Logging Service.
  2. use the default Account for installation () - Uncheck the checkbox above if to use another account for installation of Logging Service.
  3. Local Installation - Installation of Logging Service will be done on the same server as the Update Service if unchecked a remote server can be specified.
  4. use the default Account as Service Account ( - Uncheck the checkbox above if to use another account to run the Logging Service.

Step 4 Install the Monitoring Service

Options to install the Monitoring Service.

Install
Basic tab options

  1. Folder - Set the root path where the Monitoring Service will be installed (this folder should include the name of the environment).
C:\Program Files\Nodinite\Test\Nodinite Core Services\
  1. Service Name, Set the name of the Monitoring Service as installed Windows Service. To avoid problems with multiple environments installed on the same server, the proposed service name is Nodinite <environment> Monitoring Service (it is recommended that you keep this naming convention).
  2. Click on the Install button to install the Monitoring Service.

When every input field is checked (green) the 'Install' button is enabled. After the installation has completed with success, the setup will automatically close this accordion and continue to the next installation step.

MonitoringServiceCompleted
After the installation has completed the accordion close and is prefixed with a green check

Advanced tab

If you switch to using the Advanced tab instead of the Basic tab some additional fields exists for this step with the following options:
Install Monitoring Service Advanced tab
Advanced tab options

  1. use the default Update Service - Uncheck the checkbox above if to use another Nodinite Update service for installation of Monitoring Service.
  2. use the default Account for installation () - Uncheck the checkbox above if to use another account for installation of Monitoring Service.
  3. Local Installation - Installation of Monitoring Service will be done on the same server as the Update Service if unchecked a remote server can be specified.
  4. use the default Account as Service Account ( - Uncheck the checkbox above if to use another account to run the Monitoring Service.

Step 5 Install the Web API

Options to install the Web API.
png_Installation_WebApi
Basic tab option

  1. Folder - The physical file path location to where to install the Web API.
  2. IIS Web Site - Enter the name of the web site where to install the Web API.
  3. IIS Application Pool - Enter the name of the IIS App Pool (should run as AppPoolIdentity as also described in the Installation Checklist).
  4. IIS Virtual Path - Enter the name of the IIS Virtual Path. Default is "/Nodinite/<environmentname>".
  5. Install - Click on the Install button to start the installation process.

When every input field is checked (green) the 'Install' button is enabled. After the installation has completed with success, the setup will automatically close this accordion and continue to the next installation step.

WebAPICompleted
After the installation has completed the accordion close and is prefixed with a green check

Advanced tab

If you switch to using the Advanced tab instead of the Basic tab some additional fields exists for this step with the following options:
Install WebAPI Advanced tab
Advanced tab options

  1. use the default Update Service - To use the local update service (default) make sure to have this checkbox checked. If the Web API is installed on some other IIS Server then the Nodinite Update Service on that server must be used when updating Nodinite.

Note: Only un-check this checkbox for advanced setups (preferably in dialogue with our technical support)

  1. use the default account for installation (, When checked, the installation will use the Service credentials provided in the General section. If not checked, enter account and password to use when installing the Web API.
  2. Local Installation - Check to install on localhost (default and recommended)
  3. use the default account as Impersonation Account ( - When checked, the installation will use the Service credentials provided in the General section to configure impersonation for the Web API

Step 6 Install the Web Client

Options to install the Web Client.
png_Installation_WebClient
Basic tab option

  1. Folder - The physical file path location to where to install the Web Client
  2. IIS Web Site - Enter the name of the web site where to install the Web Client
  3. IIS Application Pool - Enter the name of the IIS App Pool (should run as AppPoolIdentity as also described in the Installation Checklist)
  4. IIS Virtual Path - Enter the name of the IIS Virtual Path. Default is "/Nodinite/<environmentname>".
  5. Install - Click on the Install button to start the installation of the Web Client

When every input field is checked (green) the 'Install' button is enabled. After the installation has completed with success, the setup will automatically close this accordion and continue to the next installation step.

WebClientCompleted
After the installation has completed the accordion close and is prefixed with a green check

Advanced tab

If you switch to using the Advanced tab instead of the Basic tab some additional fields exists for this step with the following options:
Install WebClient Advanced tab
Advanced tab options

  1. use the default Update Service - When checked use the local update service (default) make sure to have this checkbox checked. If the Web Client is installed on some other IIS Server then the Nodinite Update Service on that server must be used when updating Nodinite.

Note: Only un-check this checkbox for advanced setups (preferably in dialogue with our technical support)

  1. use the default account for installation, When checked, the installation will use the Service credentials provided in the General section. If not checked, enter account and password to use when installing the Web Client.
  2. Local Installation, Check to install on localhost (default and recommended)

Step 7 Install the Log API

Options to install the Log API.
png_Installation_LogAPI
Basic tab option

  1. Folder - The physical file path location to where to install the Log API
  2. IIS Web Site - Enter the name of the web site where to install the Log API
  3. IIS Application Pool - Enter the name of the IIS App Pool (should run as a domain account with specific run-time rights in the Log Databases as also described in the Installation Checklist)

Note: The App Pool will be created with the provided install account (default or overridden value in the 'Advanced' tab)

  1. IIS Virtual Path - Enter the name of the IIS Virtual Path. Default is "/Nodinite/<environmentname>".
  2. Install - Click on the Install button to start the installation of the Log API

When every input field is checked (green) the 'Install' button is enabled. After the installation has completed with success, the setup will automatically close this accordion and continue to the next installation step.

LogAPICompleted
After the installation has completed the accordion close and is prefixed with a green check

Advanced tab

If you switch to using the Advanced tab instead of the Basic tab some additional fields exists for this step with the following options:
Install LogAPI Advanced tab
Advanced tab options

  1. use the default Update Service - When checked use the local update service (default) make sure to have this checkbox checked. If the Web Client is installed on some other IIS Server then the Nodinite Update Service on that server must be used when updating Nodinite.

Note: Only un-check this checkbox for advanced setups (preferably in dialogue with our technical support)

  1. use the default account for installation - When checked, the installation will use the Service credentials provided in the General section. If not checked, enter account and password to use when installing the Log API.
  2. Local Installation - Check to install on localhost (default and recommended)

Step 8 Set default behaviour

All accordions should now be checked and look like the following image:
Completed Setup
Example with all Core Services successfully installed

Click on the Next button after installing all the Core Services.
Next button

Please continue the installation guide in Part 2