Install Nodinite v7
Welcome! This guide walks you through installing Nodinite v7, whether you are upgrading from a previous version or starting fresh. If you are new to Nodinite, you’ll find all the steps, requirements, and tips needed for a smooth, secure deployment.
Before you start, make sure you:
- ✅ Have administrator access to the Application Server
- ✅ Know all required account names and passwords
- ✅ Have reviewed prerequisites and downloaded necessary installers
- ✅ Understand if you are performing a fresh install or an upgrade
What you’ll achieve by following this guide:
- ✅ Rapid, reliable installation with minimal downtime
- ✅ Clear prerequisites and configuration steps for success
- ✅ Flexible agent and database setup for any environment
- ✅ Access to expert support and resources throughout the process
Tip
If you have a non-prod environment, we recommend testing the install process there first. This ensures you can validate all steps and configurations before applying them to your production environment.
Looking for a partner to help you install? Please contact any of our certified Partners.
Important
You must have knowledge of account names and their passwords and you must have administrative rights on the Nodinite Application Server to perform the installation.
Prerequisites
Before you begin the installation process, ensure you have the following prerequisites in place:
- Administrator access to the Nodinite Application Server where the installation will be performed.
- PowerShell 7 installed on the Nodinite Application Server. This is required to run the installation scripts.
- You must temporarily allow importing/loading script blocks in PowerShell 7. Review this guide; Either use Unrestricted or ByPass. When you are done, you may revert the execution policy to its original setting.
- Powershell 7 script user must be a member of the sysadmin role on the SQL Server instance where the Nodinite databases are hosted. This is required for the script to perform database migration updates and fresh installations.
- You must temporarily allow importing/loading script blocks in PowerShell 7. Review this guide; Either use Unrestricted or ByPass. When you are done, you may revert the execution policy to its original setting.
- Latest version of .NET 9.0 Install .NET Runtime 9.0.x AND ASP.NET Core Runtime 9.0.x (Hosting bundle) installed on the Nodinite Application Server. This is required for the new features and improvements in Nodinite v7.
- Latest version of DacFX installed on the Nodinite Application Server. This is required for database migrations and updates.
- .NET Framework 4.8 or later.
Note
If you are installing on a Windows Server OS prior to Windows Server 2022, you must install the .NET Framework 4.8 feature.
- MSDTC
- IIS (Internet Information Services) with the following features installed on the Nodinite Windows Server Application Server:
| Feature Category | Feature Name | Comment |
|---|---|---|
| Web Server Role | Web Server (IIS) | Required for hosting Nodinite web applications |
| Common HTTP Features | HTTP Redirection | Required for URL redirection |
| Static Content | Serves static files | |
| Performance Features | Dynamic Content Compression | Improves performance |
| Static Content Compression | Improves performance | |
| Security Features | Basic Authentication | Enable if using basic auth |
| Windows Authentication | Windows auth is required | |
| Application Development | .Net Extensibility 4.x | Allows IIS to load and run managed code modules for ASP.NET Framework apps. |
| ASP.NET 4.x | Enables IIS to run web applications built on the .NET Framework (not .NET Core/.NET 5+/.NET 9) | |
| ISAPI Extensions | Allow IIS to run applications and scripts (like ASP.NET .aspx pages) via DLLs | |
| ISAPI Filters | Enable IIS to filter and modify HTTP requests/responses at a low level, often used for custom authentication, logging, or URL rewriting | |
| ASP.NET Core Module V2 | Required for .NET 9 (Core) apps | |
| .NET 9 Hosting Bundle | Required for .NET 9 (Core) apps | |
| Management Tools | IIS Management Scripts and Tools | Required for PowerShell automation and scripted installs |
Estimated time
On a high level, there are a few distinct steps in the installation process:
- Register the Environment in the Nodinite Portal.
- Download
- Extract and run the Powershell 7 script to install Nodinite Core Services, and Monitoring Agents and Log Agents.
Running the script typically takes a few minutes. This estimate includes installing all Monitoring Agents and Log Agents.
Visual overview of the installation process.
Step 1: Register Environment
In the Nodinite Portal, register your environment by following these steps:
Navigate to the existing Customer entry.
Find and Click on the Customer entry.Ensure you have Nodinite 7 product key available. If not, create it by clicking on Create Product Key button.
Example of a Nodinite 7 product key entry.Important
You must have a valid Nodinite 7 product key to proceed with the upgrade. If you can't create one, please contact your partner or Nodinite Support.
Click the Environment tab, then click the Add Environment button.
Example of the Add Environment button in the Nodinite Portal.A modal appears, click 'Install Fresh Nodinite 7' button.
Example of the 'Install Fresh Nodinite 7' button.The modal changes and you must now enter variables (ultimately parameters in the PowerShell 7 scripts).
Example of the Add Environment Variables modal.
Configure Nodinite 7 variables
💡Configure the necessary variables for the Nodinite 7 environment.
In this step, you will set the required variables for your Nodinite 7 environment. These variables are essential for the proper functioning of Nodinite and must be configured correctly.
Please ensure that you set the configuration values correctly, as some of them are difficult to change later. Your runtime platform is configured with these values, and they are utilized in the PowerShell script that will run later in the process. If you need to modify these values, you might have to remove everything except for the databases and start over.
If you are unsure about some values, enter placeholder information to continue. You can override these parameters later when you run the PowerShell 7 installation script. This flexibility allows you to update settings before finalizing the installation, ensuring you have full control over your environment configuration.
| Mandatory | Variable | Default | Description |
|---|---|---|---|
| Environment Name* | The name of the target environment NOTE: Once set, this should not be changed as databases, app pools, folders and more are poisoned with this name. |
||
| Description | Description to clarify purpose or usage. | ||
| Destination Root Path | C:\Program Files\Nodinite | Leave it empty to select default value. | |
| Default Domain Name* | <DomainName> |
Name of the Windows Active Directory Domain; Default prefix for accounts; | |
| Admin Account | <NodiniteAdminUsrAccountName> |
Enter Nodinite Administrator Account Name. | |
| Admin Account Email | Enter Nodinite Administrator Account Email. | ||
| Default Services Account Name | <DefaultServiceAccountName> |
Enter Default Services Account Name. You can override these in the 'Advanced' tab | |
| Web Client Port | 40000 | IIS Port for Web Client | |
| Web API Port | 40001 | IIS Port for Web API | |
| Log API Port | 40002 | IIS Port for Log API | |
| Logging Service Port | 40003 | IIS Port for Logging Service | |
| Monitoring Service Port | 40004 | IIS Port for Monitoring Service |
Configure Database Settings
💡Configure the database settings for Nodinite 7.
There are different settings depending on the type of database you want to use.
- Standalone - Use a single SQL Server instance for all databases. Use this option if you are using SQL Server Standard, Enterprise, or Express edition. Tihs also works for failover clusters.
- Always on - Use a SQL Server Always On Availability Group for high availability and disaster recovery.
- Azure - Managed Instance - Use an Azure SQL Managed Instance for a fully managed database service in the cloud. This option is suitable for cloud-based deployments. If you select this option, you must provide the connection string to the Azure SQL Managed Instance. As this option is NOT using integrated security, you must eventually provide the username and password for the database. This should be done by replacing this value directly in the PowerShell script that is run later in the process.
- You can also choose to Edit Connection String Manually if you prefer to configure the connection string yourself.
| Mandatory | Option/Setting | Default | Description |
|---|---|---|---|
| Database Type |
|
Type of database to use for Nodinite 7. The default is Standalone. If you select Clustered, you must provide a connection string to the SQL Server instance. | |
| Database Server Name | localhost |
Name of the SQL Server instance. The default is localhost. If you are using a named instance, use the format ServerName\InstanceName. |
|
| Edit Connection String Manually | No | Whether to edit the connection string manually. | |
| Connect without encrypt | No | Whether to connect without encryption. | |
| Encrypt Connection | Checked | Whether to encrypt the connection, or not. Should be checked on most environments | |
| Trust server certificate | Checked | Whether to trust the server certificate, or not. Should be checked on most environments | |
| Trust Server Certificate | Checked | Whether to trust the server certificate, or not. Should be checked on most environments | |
| Sql Package Path | C:\Program Files\Microsoft SQL Server\170\DAC\bin\SqlPackage.exe | Path to the SqlPackage.exe tool. |
Step 2: Save
💡Persist your settings.
You should save your settings before proceeding to the next step. Review all settings carefully to ensure they are correct.
Click the 'Save' button to persist settings.
*Example Screenshot of the 'Save' button.
If the save is successful, you will see a confirmation message and another tab will appear in the modal. You can click the Review button to review your settings before proceeding. Your settings display with a visual graph. See Step 4: Review for more details.
Step 3: Configure Authentication
💡Configure authentication settings.
In this step, you will configure the authentication settings for your Nodinite 7 environment. You can choose between Windows Authentication or OAuth 2.0/OIDC.
Configure Windows Authentication
This is the default authentication method when your Environment is running on Windows Servers. It leverages Active Directory for user management and provides a seamless experience for users within the organization. It is suitable for most on-premises deployments.
Nodinite version 6 only had the option to use Windows Authentication. If you are upgrading from version 6, this is the recommended option.
If you select Windows Authentication, there are no additional settings to configure. The system will use the Windows credentials of the users to authenticate them.
Example of the Authentication tab with Windows Authentication selected.
Configure OAuth 2.0 / OIDC
This authentication method is recommended for cloud-based deployments or when you want to integrate with external identity providers. It supports modern authentication protocols and provides enhanced security features.
Example of the Authentication tab with OAuth 2.0 / OIDC selected.
If you select OAuth 2.0 / OIDC, you must provide the following settings:
OAuth General settings
In the General settings section, you must provide the following information:
- Authentication Method - Select OAuth 2.0 / OIDC from the dropdown menu.
- Discovery URL (.well-known) - The URL of the OpenID Connect discovery document provided by your identity provider. This document contains metadata about the identity provider, including endpoints, supported scopes, and other configuration details. Example:
https://idp/.../.well-known/openid-configuration.
Example of the OAuth General settings section.
OAuth Web Client settings
In the Web Client settings section, you must provide the following information:
| Field Label | Default Value / Example | Description |
|---|---|---|
| Require HTTPS Metadata | Unchecked | When enabled, the application will only accept metadata from the discovery URL if it is served over HTTPS. This ensures that the metadata is transmitted securely and cannot be tampered with during transit. |
| Client ID * | nodinite-%ENVIRONMENTNAME%-webclient |
The client identifier registered with your identity provider for the Web Client application. This ID is used to identify the application during the authentication process. |
| Callback Path | /signin-oidc |
The path where the identity provider will redirect users after they have authenticated. This should match the redirect URI registered with your identity provider. |
| Signed-Out Callback Path | /signout-callback-oidc |
The path where the identity provider will redirect users after they have signed out. This should match the post-logout redirect URI registered with your identity provider. |
| Signed-Out Redirect URI * | https://nodinite.local:41000/ |
The URI where users will be redirected after they have signed out. This should be a valid URI that is registered with your identity provider. |
| Access Denied Path | / | The path where users will be redirected if they are denied access to a resource. This can be a custom error page or a specific route in your application. |
| Scopes | openid, profile, email, and offline_access |
The scopes that the application will request from the identity provider. These scopes determine the level of access and information that the application will receive about the authenticated user. The default scopes are openid, profile, email, and offline_access. You can add additional scopes as needed. |
OAuth Web API settings
In the Web API settings section, you must provide the following information:
- Audiences - A list of valid audiences that the Nodinite Web API will accept. This should include the client IDs of any applications that will be accessing the Web API. Example:
nodinite-%ENVIRONMENTNAME%-webapi.
Example of the OAuth Web API settings section.
OAuth Log API settings
In the Log API settings section, you must provide the following information:
- Audiences - A list of valid audiences that the Nodinite Log API will accept. This should include the client IDs of any applications that will be accessing the Nodinite Log API. Example:
nodinite-%ENVIRONMENTNAME%-logapi.
Example of the OAuth Log API settings section.
Step 4: Configure TLS
💡Configure TLS settings for secure communication.
In this step, you will configure the TLS settings for your Nodinite 7 environment. You can choose to enable or disable TLS for secure communication between clients and the server.
Important
To use the OAuth 2.0 / OIDC authentication method, you must have a valid TLS/SSL certificate installed on the Nodinite Application Server. This is required to ensure secure communication between clients and the server. As such, you cannot continue editing the environment entry without enabling TLS in your hosting environment.
- ❗If you are using OAuth 2.0 / OIDC, you must enable TLS.
- ✅If you are using Windows Authentication, you can choose to enable or disable TLS based on your security requirements.
If you choose to enable TLS, you can provide the following settings (depending on your environment, policies, and certificate):
| Field Label | Default Value / Example | Description |
|---|---|---|
| Host / Domain | portal.example.com | The domain name or host for TLS certificate validation. |
| Certificate Thumbprint (TLS, optional) | 9b27c9d1939b821bb... |
TLS certificate thumbprint for additional security validation. |
Note
All Nodinite Web Applications will be configured to use the same TLS settings. This includes the Web Client, Web API, Log API, Logging Service, and Monitoring Service and any Agents you choose to install. If you were not using TLS in your previous version of Nodinite, you must ensure that all clients accessing the Web Client and Web API are configured to use HTTPS. This may involve updating bookmarks, links, and configurations in other systems that interact with Nodinite. In addition, you must ensure that any firewalls or proxies between the clients and the server are configured to allow HTTPS traffic. If you have an existing Nodinite environment and opt in, or opt out of using TLS, you should uninstall the Nodinite environment (keep the databases and config files) and run the installation script again. You cannot change the name of the environment.
Step 5: Select and Configure Agents
💡Select and configure Agents to include in the installation.
In this step, you will select the Agents you want to include in the installation. The Agents are responsible for Monitoring and Logging.
Click the Agents tab to view the available Agents.
Example of the Agents tab in the Nodinite Portal.
Click on the accordion on any of the agents to expand the configuration options.
Check the checkboxes for the Agents you want to include in the installation.
You must enter a port number for use within the IIS for each Agent you select. The port numbers must be unique and not conflict with other services running on the same server. The default port numbers are provided, but you can change them if needed.
Some agents like BizTalk, Azure Logic Apps, Dynamics CRM and IBM DataPower require additional configuration, such as the database connection string. Ensure you provide the correct values for these settings.
Example of the Logic Apps Agent configuration entry with additional configuration properties.
Step 4: Review
💡Review settings using a visual graph before you continue with the installation operation.
In this step, you have the opportunity to review your settings before you download the necessary binaries for Nodinite v7.
We recommend reviewing all settings carefully to ensure they are correct before proceeding. Click on the 'Overview' tab to open a Mermaid diagram displaying the current configuration in a user-friendly graph.
Example of how the Environment will look with the current settings after the installation operation has completed.
Step 5: Download Binaries
In this step, you will download the necessary binaries for Nodinite 7.
- Close the modal if it is still open, or navigate to the Environments tab.
- Click the Actions button, and the click the Download menu item to start the download process.
Example of 'Download' menu item in the Actions button.
While generating your ZIP package with the necessary binaries the following screen will be displayed:
Example of the Downloading Nodinite Binaries screen.
Once the download is complete, you can proceed to the next step.
Step 6: Run PowerShell 7 Script
💡Run the PowerShell 7 script to install your environment.
In this step, you will run the PowerShell 7 script to install your environment.
- Open a PowerShell 7 terminal with administrative privileges.
- Navigate to the folder where you extracted the downloaded ZIP file.
- Run the script by executing the following command (If you run the script like this, you will be prompted to enter the mandatory values interactively):
dir -r | unblock-file
At first, you must unblock all files in the extracted folder.
.\Nodinite7-%ENVIRONMENTNAME%-Installation.ps1
Replace %ENVIRONMENTNAME% with the name of your environment.
Example Screenshot of the Interactive Installation Script.
After applying passwords the script starts the installation process:
Example of the Installation in progress.
Important
If you provided bogus values in the previous steps, you must NOT edit the script to provide the correct values for the parameters. This includes the database connection string, service account names, and other settings you specified in the Nodinite Portal. You must run the script providing the new values, for example (you can use tab to switch between the available parameters):
For each unique password, repeat the following command to acquire a secure string:
dir -r | unblock-file
First, you must unblock all files in the extracted folder.
$serviceAccountPassword = ConvertTo-SecureString 'P@ssw0rd' -AsPlainText -Force
.\Nodinite7-DEMO-Installation.ps1 -WebClientServiceAccount 'Domain\n-svc' -WebClientServiceAccountPassword $serviceAccountPassword
Important
The password is SecureString. You must create a separate variable and use it accordingly for each unique password.
You must use a single quote (') when providing the account name and password to avoid issues with special characters.
-
- Open the Web Client and perform some basic checks to ensure the installation was successful.
Contact our support
If you have questions or encounter issues during the upgrade, contact your Partners for 1st line support or email us at support@nodinite.com.