On-Prem System
      Back to home
      1. Help Center
      2. Getting Started
      3. On-Prem System

      AAI Platform Software v3 Installation (Windows Server)

       

      Installation Permissions

      Ensure the Windows Account used for the installation has local Administrative privileges on the machine where the Alcatraz AI Platform will be installed.

      1. Locate the Installer file – ex. alcatraz-admin-portal-win-3.0.0.exe.
      2. Right-click the alcatraz-admin-portal-win-x.x.x.exe file and select "Run as Administrator" to begin the installation.
      3. Read and agree to the "License Agreement."
      4. Select the install locations for the Alcatraz AI Platform. Click Browse... for each of the three fields (Installation directory, Data directory, Backup directory) and select the respective locations where the AHP Platform components should be installed. Note: It is recommended that the "Data" and "Backup" directories be placed on a drive sized according to the Alcatraz Platform system requirements. For a small system and short-term use, a drive with at least 100GB of free space could be used.
      5. Select "Login type" from one of the following:
        1. Local System Account (default) – Integrated with Windows. Services will run under the local system account on the server.
        2. This Account – Typically used with a Windows domain account. Enter the Username and Password for the account you want to use.
      6. Select the preferred database engine:
        1. PostgreSQL (default) - PostgreSQL will be installed automatically by the application.
        2. Microsoft SQL Server - You will need to provide or install an instance of MS SQL.
      7. PostgreSQL Specific Settings:
        1. Select Browse... to change the default location for the installation and data files.
        2. Port - 5432 (default) - It is recommended to use the default setting
        3. Superuser Password - It is recommended to use the default password. CAUTION: If you change the password, be sure to make a note of it. Losing the superuser password may result in loss of data access.
        4. Retype Superuser Password - This is only required if changed from the default.
      8. Microsoft SQL Server Specific Settings:
        1. Enter the "Server Name" and "Database Name".
        2. Select the preferred "Login Type." Note: the associated database user should have db_owner permissions for the database named.
          1. Windows - The account specified in Step 5 will be used to access the MS SQL database.
          2. SQL - Enter the "Login" and "Password" for an account created in MS SQL.
        3. Storage Type - Check the box for "Database" to store all data in the MS SQL database
        4. Select Test Connection to validate the connection settings.
      9. Select certificate settings:
        1. Use self-signed certificate for Web application (default) - The application will self-sign a certificate to be used for secure access to the Admin Portal.
        2. Use custom certificate for Web application - Provide a certificate via the Windows Certificate Store to be used for secure access to the Admin Portal.
      10. Check "Setup NTP Server" if you want the application to automatically configure the server to provide NTP services. This may be necessary for an air-gapped installation where the Rocks will not have access to a local or public NTP server.
      11. Enter service endpoint settings. Note: It is recommended to use the default settings. CAUTION: changing the ‘Devices Service Listen Port’ after Rocks have been onboarded to the system will cause them to lose communications unless they are deleted and then re-onboarded to the Alcatraz Platform. 
        1. Devices Service Listen Port - 8443 (default)
        2. Public Service Listen Port - 443 (default)
        3. Create Firewall Rules - Check the box (default)
        4. Select Check Ports Availability to confirm the entered ports are open and available. If the Alcatraz Services are already running on the server, these ports may not be available. This may occur when modifying an existing installation or upgrading the Platform software.
      12. "Enable Remote Assistance" can remain unchecked for most installations.
      13. High availability requires a separate license and additional infrastructure to implement. Contact your Alcatraz AI account manager for more details.

      14. When the installation is complete, be sure to note the randomly generated Admin password that is displayed, as this will be needed to log into the Admin Portal.
      15. After noting the Admin password, select Close to exit the installer.
      16. Details for accessing the Admin Portal can be found here:  Accessing the Admin Portal

       

      How to modify the installation or uninstall the application

      1. Right-click the alcatraz-admin-portal-win-x.x.x.exe file and select "Run as Administrator."
      2. Select an option:  Configure, Modify, or Uninstall.
      3. Select Configure to select a custom certificate from the Windows Certificate Store.
      4. Select Modify to make changes to the installation.
      5. Select Uninstall to remove the Alcatraz Platform application.
        1. When uninstalling, you can choose to delete or retain the application database and data files.