How do I install a new instance of Nodinite?

This document guides you through the steps to install a new instance of the Nodinite Core Services.

The system administrator with elevated rights installs Nodinite using the Nodinite Install and Update Web Application. The installation process usually takes less than 15 minutes (Basic track). The installation is straightforward but may involve many steps to provide a rich plethora of options running Nodinite with the proper access rights and the performance you need and can afford.

Installation Checklist

1. First, ensure you have all the prerequisites to install the Nodinite Install and Update Tool.
2. Always use the latest version of the Nodinite Install and Update Tool. Read more here.
3. Ensure the prerequisites for the Nodinite core services are met before installing a new instance of Nodinite.
4. Download the latest version of the Nodinite Core Services package.

Note

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

---

Step 1 Basic install

Click on the Install a new instance button to open the installation dialogue.

A new page then loads with the following two tabs:

• 1. Basic; provides the least possible steps to quickly get you started.
• 2. Advanced; offers all possible options to facilitate demanding requirements.
     

Note

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

Tip

You can switch between the tabs during installation; this is handy if you only need the advanced options during a specific step.

When you install Nodinite, among other things, you must enter a unique Environment name for the instance. You must also enter details about the license (product key). You must configure the following fields:

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 the Licensee).

3. Product key, Enter the Product Key (Associated with the Customer Name for the Licensee).

4. Environment Name, Enter the mandatory custom name of the target environment (QA/DEV/PROD).

   You must comply with the following naming pattern: /^[a-z0-9]{1,}$/i

5. Update Service Address, The preset is the default API endpoint on the local Nodinite Update Service host.

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

Note

Nodinite supports using different Update Services instances scattered on multiple hosts in almost all installation steps.

6. Installation account name, enter credentials for the Service Account running the Monitoring Service, Logging Service and the WebAPI (you can override this in each installation step using the advanced tab).
7. Installation account password, enter the password.
8. Click the Validate Account button to validate that the user and password information is correct.

When the fields validate successfully, the accordion closes and is prefixed with a green check icon.

Step 2 Install the Configuration database

In the second step of installing Nodinite, you create the Nodinite configuration database. By definition, this is the 'Configuration Database'.

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

• Stand-alone (including fail-over cluster) or
• Always On, you must read the About Always On user guide before continuing(!)

The following configuration steps must be followed in order:

1. Make sure to verify you have the latest DacFX and if you are re-installing that the System Parameter SqlPackageExecutable points to the accurate folder.

2. Use an existing configuration database; When checked, you will re-use an existing Nodinite Configuration database for this installation. If the Nodinite Configuration Database is of an old version, it gets updated in the installation process to match this package.

   Note

   Choose this option to perform an in-place update (for example, v3.x -> v4.x) or when you change the application server hosting environment for Nodinite. >This option allows you to keep all the data.

Enter the information pointing to the SQL server with the existing configuration database.

An Exception message displays when the Server or Database does not point to an existing Configuration Database.

3. Database Server, enter the name of the SQL Server database server (default or named instance)

1. Database Name, Enter the name of the Configuration Database. To avoid mixups, the naming scheme is NodiniteConfig_<environment>. We recommend that you follow this pattern.

2. Install, click the Install button to install (or upgrade) the Nodinite Configuration Database.

The' Install' button gets enabled when every input field has the (green) icon. When the installation is successful, the application automatically closes the accordion and continues to the next installation step.

When the installation successfully completes, the accordion closes and is prefixed with a green check icon.

Advanced Tab (configuration database)

Use the Advanced tab to enter additional options to facilitate the installation.

Configuration Database Advanced tab with additional options.

1. Use the default Update Service; when checked, the installation uses the Update Service information from the General section. The default is http://localhost:8000/Nodinite/Service/Update
2. Use the default Account for installation; when checked, the installation uses the Service credentials provided in the General section. Uncheck the checkbox to use another account to install the Configuration Database.
3. SSL Settings; Please review the SQLPackageParams system parameter for additional details.
4. Advanced file settings; advanced file settings allow you to alter the SQL Server instance default values.
5. Override the default location of SQL Server DATA files. Enter a valid path for Configuration Database DATA files (MDF)

C:\Program Files\Microsoft SQL Server\MSSQL12.MSSQLSERVER\MSSQL\DATA\

6. Override the default location of SQL Server LOG files. Enter a valid path for Configuration 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, the Install and Update Tool automatically detects the current configuration, and you must also specify a valid accessible path for the SQL Server backup files (The account running the SQL Service on all nodes must have access to this highly available share).

The configuration page for Always On SQL Server target environments.

Nodinite automatically performs the required backup to the backup folder and then tries to set the Configuration Database in the Synchronized state.

Azure SQL Managed Instance

^{New 6.1} To use an Azure SQL Managed instance, from the Advanced tab, check the Use Azure SQL Managed Instance checkbox.

Enter SQL User name and Password (SQL authentication is the one option to use with this version).

Here's an example of the feature to enable the use of an Azure SQL Managed instance.

The credentials are securely stored in the Connection String in the .config files of Nodinite binaries connecting with the database.

Here's an example of an encrypted connection string.

Note

The installation of an Azure SQL Managed database can easily take more than 10-15 minutes to complete.

Step 3 Install the Logging Service

The following options exist to install the Nodinite Logging Service.

Install the Logging Service with basic 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\

2. 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).
3. Click the Install button to install the Logging Service.

When the installation is successful, the application automatically closes the accordion and continues to the next installation step.

Advanced tab (Logging Service)

Use the Advanced tab to enter additional options to facilitate the installation.

Install the Logging Service using the Advanced tab options.

1. Use the default Update Service; uncheck the checkbox to use another Nodinite Update Service instance to install the Logging Service.
2. Use the default Account for installation (); uncheck the checkbox to use another account to install the Logging Service.
3. Local Installation; install the Logging Service on the same server as the Update Service. Uncheck the checkbox to install on a remote host.
4. Use the default Account as Service Account () ; uncheck the checkbox above to use another service account running the Logging Service.

Step 4 Install the Monitoring Service

The following options exist to install the Nodinite Monitoring Service:

Monitoring Service Basic tab options.

1. Folder - Enter the root path where to install the Monitoring Service (this folder should include the name of the environment).

C:\Program Files\Nodinite\Test\Nodinite Core Services\

2. Service Name, enter 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 (we recommend that you follow this naming convention).
3. Click the Install button to install the Monitoring Service.

When the installation is successful, the application automatically closes the accordion and continues to the next installation step.

Advanced tab

Use the Advanced tab to enter additional options to facilitate the installation.

Advanced tab options.

1. Use the default Update Service; uncheck the checkbox to use another Nodinite Update service to install the Nodinite Monitoring Service.
2. Use the default Account for installation () - uncheck the checkbox to use another account to install the Monitoring Service.
3. Local Installation; Install the Monitoring Service on the same server as the Update Service. Uncheck to install on a remote host.
4. Use the default Account as Service Account (); uncheck the checkbox to use another service account running the Monitoring Service.

Step 5 Install the Web API

The following options exist to install the Nodinite Web API:

Web API Basic tab options.

1. Folder; enter the physical file path location to where to install the Web API.
2. IIS Web Site; enter the name of the website 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 initiate the installation step.
   When the installation is successful, the application automatically closes the accordion and continues to the next installation step.

Advanced tab

Use the Advanced tab to enter additional options to facilitate the installation.

Web API 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 another IIS Server, you must point to and use the Nodinite Update Service on that server to update Nodinite.

   Important

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

2. Use the default account for installation ; when checked, the installation uses the Service credentials provided in the General section. Uncheck the checkbox to use another account to install the Web API.

3. Local Installation, When checked (default and recommended), perform a local installation.

4. Use the default account as Impersonation Account ; when checked, the installation uses the Service credentials provided in the General section to configure impersonation for the Web API.

Step 6 Install the Web Client

The following options exist to install the Nodinite Web Client.

Web Client Basic tab options.

1. Folder; the physical file path where to install the Web Client
2. IIS Web Site; enter the name of the website 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. The default is "/Nodinite/%EnvironmentName%".
5. Install; click on the Install button to initiate the installation step.

When the installation is successful, the application automatically closes the accordion and continues to the next installation step.

Advanced tab

Use the Advanced tab to enter additional options to facilitate the installation.

Web Client Advanced tab options.

1. Use the default Update Service - When checked (default), use the locally installed UpdateService. If the Web Client is installed on another IIS Server, then the Nodinite UpdateService on that server must be set.

Important

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

2. Use the default account for installation; when checked, the installation uses the Service credentials provided in the General section. Uncheck the checkbox to use another account to install the Web Client.
3. Local Installation, When checked (default and recommended), perform a local installation.

Step 7 Install the Log API

The following options exist to install the Nodinite Log API.

Log API Basic tab options.

1. Folder - The physical file path location to where to install the Log API
2. IIS Web Site - Enter the name of the website 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)

Info

The App Pool is 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. The Default is "/Nodinite/<environmentname>".
2. Install - Click the Install button to initiate the installation step.

When the installation is successful, the application automatically closes the accordion and continues to the next installation step.

Advanced tab

Use the Advanced tab to enter additional options to facilitate the installation.

Log API Advanced tab options.

1. Use the default Update Service - When checked (default), use the locally installed UpdateService. If the Log API is installed on another IIS Server then the Nodinite UpdateService on that server must be set.

   Important

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

2. Use the default account for installation, When checked, the installation uses the Service credentials provided in the General section. Uncheck the checkbox to use another account to install the Log API.
3. Local Installation, When checked (default and recommended), perform a local installation.

Step 8 Set default behaviour

All accordions should now be closed and have a look like the following image:

Here's an example image with all Nodinite Core Services successfully installed.

Click the Next button after installing all the Core Services.

Next, please continue with the configuration using the Part 2 guide.