NAGIX BO On-Prem – Clean Installation Guide

This guide describes a clean installation of NAGIX BO On-Prem, including license activation, optional HTTPS disabling, and verification.

1. Prerequisites

• Install ASP.NET Core 8.0 Hosting Bundle – Download
• Install Microsoft Visual C++ 2015–2022 Redistributable (x64) – Download
• Install MongoDB Community Edition – Download
• Install IIS (Internet Information Services)
• Install IIS URL Rewrite Module 2 – Download
• If required, reboot the VM.

2. Automatic Installation

1. Run InstallPBAccessibility.ps1
2. Follow the prompts:
   • Enter Mongo database name
     Enter Mongo database name [Press Enter = master-Accessibility]:
     → <MongoDB Name>
   • Step: Migration Tool
     • If this is a clean install:
       → When prompted “Do you want to run database files migration now?”, type: N
     • If this is an update of existing installation:
       → When prompted, type: Y
   • You will see:
     

     Running the migration tool for 'from database to files' migration
     Choose migration type:
       1: Convert data storage from database to file
       2: Delete backups from MongoDB
       3: Update directory for file storage

   • Select option 1 at prompt: Enter number:
   • Then provide required paths:
     • Enter NAGIX path: → e.g. C:\Program Files\Consist\Nagix\NagixAPI
     • Enter a directory for file storage (Dictionary, Template, PreparedXmlInfo):
       → ⚠ The directory must already exist!
   • Migration tool will ask:
     • DictionaryStorageMode is 'File'
Do you want to run Dictionaries migration? [Y/N]: → Y
     • TemplateStorageMode is 'File'
Do you want to run Templates migration? [Y/N]: → Y
     • DefaultStoragePreparedXMLType is '0' (AS_FILE_PATH)
Do you want to run PreparedXMLInfos migration? [Y/N]: → Y
   • At the end:
     Press any button to exit... → Press any key to continue.
   • The installation will then proceed automatically.
3. If you lack permissions to run PowerShell scripts – see Manual Installation Steps.

3. License Installation (Based on the Purchased Package)

4. Disabling HTTPS (Optional)

1. Open the file:

   C:\Program Files\Consist\Nagix\NagixBackOfficeAPI\web.config

2. Locate the line:

   <environmentVariable name="ASPNETCORE_HTTPS_PORT" value="443" />

3. Comment it out so it looks like:

   <!--<environmentVariable name="ASPNETCORE_HTTPS_PORT" value="443" />-->

5. Verifying Application Availability

1. Open:
   • https://localhost/nagix-bo/companies/master/templates
   • http://localhost/nagix-bo/companies/master/templates
2. Go to Import and upload a Template.

3. Go to Templates → in Actions, select Upload File.

4. Click Generate.
5. Confirm that the generated PDF is received successfully.

6. Manual Installation Steps

This section continues the NAGIX BO On-Prem – Clean Installation Guide and describes how to perform a manual install using the same logic as in InstallPBAccessibility.ps1. Follow the steps exactly to mirror the scripted flow.

6.1 Prerequisites & Permissions

• Run as Local Administrator.
• Ensure IIS with WebAdministration module is installed.
• Confirm you can write into:

C:\Program Files\Consist

6.2 Create Base Folders

1. Create: C:\Program Files\Consist
2. Create: C:\Program Files\Consist\nagix

6.3 Install NagixAPI

1. Copy folder NagixAPI into:

   C:\Program Files\Consist\nagix

2. Edit appsettings.json and set:

   "NagixDatabaseName": "master-Accessibility"

3. Open IIS Manager → Application Pools → Add Application Pool…
   • Name: NagixAPI
4. In IIS, under Sites → Default Web Site, add application:
   • Alias: nagix-api
   • Application pool: NagixAPI
   • Physical path:

   C:\Program Files\Consist\nagix\NagixAP

6.4 Install Nagix BackOffice (Front)

1. Copy folder NagixBackOffice into:

   C:\Program Files\Consist\nagix

2. Create Application Pool: NagixBOFront
3. In IIS, under Sites → Default Web Site, add application:
   • Alias: nagix-bo
   • Application pool: NagixBOFront
   • Physical path:

     C:\Program Files\Consist\nagix\NagixBackOffice
     

6.5 Install Nagix BackOffice API

1. Copy folder NagixBackOfficeAPI into:

   C:\Program Files\Consist\nagix

2. Edit appsettings.json and set:

   "NagixDatabaseName": "master-Accessibility"

3. Edit web.config and replace:

   <environmentVariable name="ASPNETCORE_ENVIRONMENT" value="OnPrem" />

4. Create Application Pool: NagixBOAPI
5. In IIS, under Sites → Default Web Site, right-click nagix-bo and add application:
   • Alias: api
   • Application pool: NagixBOAPI
   • Physical path:

     C:\Program Files\Consist\nagix\NagixBackOfficeAPI

6.6 Install ConsistOCR

1. Copy folder ConsistOCR into:

   C:\Program Files\Consist\nagix

2. Edit web.config and replace:

   <environmentVariable name="ASPNETCORE_ENVIRONMENT" value="OnPrem" />

3. Create Application Pool: ConsistOCR
4. In IIS, under Sites → Default Web Site, add application:
   • Alias: ConsistOCR
   • Application pool: ConsistOCR
   • Physical path:

     C:\Program Files\Consist\nagix\ConsistOCR

6.7 License Manager

1. Unzip NagixLicenseManager.zip.
2. Continue with section 3. License Installation (set OnPremEncryptionKey).

6.8 Database Migration (Upgrade only)

1. Run:

   MigrationTool\PBDigital.Accessibility.Migration.exe

2. Select option 1: Convert DB to file storage.
3. Enter paths:
   • Nagix path:

     C:\Program Files\Consist\Nagix\NagixAPI

   • Directory for file storage: custom path
4. Confirm migrations with Y for Dictionaries, Templates, PreparedXMLInfos.
5. Update appsettings.json →

  "FileStorage": {
  "StorageFolder": "<your path>"
}

6.9 Finalize

1. Restart IIS (or recycle pools).
2. Verify endpoints:

   /nagix-api

   1. /nagix-bo
   2. /nagix-bo/api
   3. /ConsistOCR

Success: Manual installation completed and matches scripted flow.