Install Open iT Admin Portal (Windows)

Chapter 1: Introduction #

Open iT Admin Portal #

Open iT Admin Portal allows configuration of installed and connected Open iT Clients for proper data collection. It includes a dashboard that gives an overview of the configured vendors or license managers, a health check functionality to easily administer configuration in various Open iT Clients, and interfaces for server-side configurations. Furthermore, it provides the capability of downloading configuration files and log files for troubleshooting.

Chapter 2: Installation Requirements #

Hardware Requirements #

RecommendedMinimumHardware
16GB8GBRAM
50GB10GBDisk
3GHz1GHzCPU
42Cores

Software Requirements #

Operating System #

VersionOperating System
8.1 or laterWindows 8
1607 or laterWindows 10
2012, 2012 R2, 2016, and 2019Windows Server

Web Browsers #

VersionBrowser
85 or laterEdge Chromium
44 or laterIE Edge
11 or laterInternet Explorer

(not supported in Open iT Application Launcher)
80 or laterMozilla Firefox
10 or laterOpera
13.1.2 or laterSafari
85 or laterGoogle Chrome

Open iT Software #

  1. Go to the Open iT download site, http://download.openit.com/.
  2. When prompted, provide valid credentials.
    Note: To get valid credentials, send an email request to support@openit.com.
    A list of versions will be shown once logged in.
  3. Select the latest version or any specific supported version from the list of Open iT releases. It is recommended to install the current stable version for production purposes.
    The page of the selected release contains version-specific files and directories that contain the binaries directory. Select the one suitable for the current environment and save it in a temporary installation directory.

ASP .Net Core #

Open iT Admin Portal, Application Launcher, and CLIMS require APS.NET Core 6.0 Runtime (v6.0.2) – Windows Hosting bundle. Download and install using this link.

Internet Information Services and .NET Framework #

To enable the Internet Information Services (IIS) and .NET Framework features on the host machine:

Non-Server Operating System #

  1. Open Control Panel.
  2. Click Programs.
  3. Click Turn Windows features on or off. This will open a new window with a list of Windows features.
  4. Select the following items:
    • .NET Framework 3.5
    • .NET Framework 4.6 Advanced Services (or any version available):
      • ASP.NET (any version available)
      • WCF Services
    • Internet Information Services:
      • Web Management Tools:
        • IIS 6 Management Compatibility
        • IIS Management Console
        • IIS Management Services
      • World Wide Web Services:
        • All features under Application Development
        • All features under Common HTTP Features except WebDAV Diagnostics
        • Health and Diagnostics:
          • HTTP Logging
        • Performance Issues:
          • Static Content Compression
        • Security:
          • Request Filtering
          • Windows Authentication
      • Internet Information Services Hostable Web Core
  5. Click OK to save the changes

Server Type Operating System #

  1. Open Control Panel.
  2. Under Programs, click Uninstall a Program.
  3. Click Turn Windows features on or off. In the Roles and Features wizard, click Next.
  4. Select Role-based or feature-based installation on the installation type dialog. Click Next.
  5. Select Select a server from the server pool and choose the local server host name from the Server Pool list on the destination server dialog. Click Next to see the list of roles.
  6. Locate Web Server (IIS) and ensure that the following roles are selected:
    • Web Server (IIS):
      • Web Server
        • Common HTTP Features;
          • Static Content
        • Security:
          • Windows Authentication
        • Application Development
          • .NET Extensibility 4.x
          • ASP.NET 4.x
          • ISAPI Extensions
          • ISAPI Filters
      • Management Tools:
        • IIS Management Console
  7. Click Next. This will open a list of additional features.
  8. Select the following items:
    • .NET Framework 3.5 Features:
      • .NET Framework 3.5
      • HTTP Activation
    • .NET Framework 4.5 Feature (or any version available):
      • .NET Framework 4.5
      • ASP.NET
    • IIS Hostable Web Core
  9. Click Install.

Identity Server #

Admin Portal requires communication with an installed and configured Identity Server for authentication.
Install Identity Server on the same or different machine with Admin Portal.
Note:To get an installer, send an email request to support@openit.com.
There is no need to install Identity Server if CLIMS is already installed. Its Identity Server can also host Admin Portal.

Installing through the Windows Installer Interface #

  1. Double-click the openit_[version]_identity_server.msi installer file. In the setup wizard, click Next.
  2. Read the License Agreement before accepting the terms. Click Next
  3. Specify the Identity Server installation directory. Click Change to specify a different directory and click OK. Clicking Next without doing any changes will use the default installation path. Click Next.
  4. Specify the port number. This option enables access to the Identity Server web application. The default value, 82, may also be used. Tick the option Install Identity Server under existing Admin Portal if there is an existing Admin Portal installed desired to connect to the Identity Server. Click Next.
  5. Click Install to start the installation process. If a review of the entries is needed, click Back.
  6. The installer will set up all necessary files on the computer. Click Finish to complete the installation

Verify Created Directories and Files #

Go to the $ROOT_DIR of the installation located, by default, in C:\Program Files\OpeniT\IdentityServer and verify that the following directories and files exist:

  • Data – contains the database and certificates used by the Identity Serve
  • wwwroot – contains files used by the web application
  • appsettings.json – contains application settings for web access and authentication
  • OpeniT.Identity.Server.exe – the Open iT Identity Server application executable
  • web.config – contains specific configuration for web servic
  • Other DLL files

Verify Web Site #

  1. Open IIS (Internet Information Services) in the machine with Identity Server
  2. In the Connections pane, expand the root node and Sites.
  3. Make sure that Open iT Identity Server is present
  4. Click Open iT Identity Server, and in the dashboard, double-click Authentication.
  5. Make sure that Anonymous and Windows Authentication are enabled

Chapter 3: Installation #

Software Installation #

Installing through the Windows Installer Interface #

  1. Double-click the openit_[version]_adminportal_windows_x64.msi installer file. In the setup wizard, click Next.
  2. Specify the Admin Portal installation directory. Click Change to specify a different directory and click OK. Clicking Next without doing any changes will use the default installation path. Click Next.
  3. Specify the Open iT Core Server and Identity Server URIs that will be used by the Admin Portal web interface to fetch data and authenticate.
    Specify the port number. This option enables access to the Admin Portal web application. The default value, 3000, may also be used.
    Click Next.
  4. Click Install to start the installation process. If a review of the entries is needed, click Back
  5. The installer will set up all necessary files on the computer.
    Click Finish to complete the installation.

Installing through the Command Line #

  1. Open a command prompt with Administrator level privilege.
  2. Execute the following command:
    msiexec /i [msi_file] /l*v [log_file] [options] INSTALLDIR=$INSTALL_DIR
    IISPORT=[portnumber] SERVERURI=[server_uri] IDENTITYURI=[identity_uri]

    Required:
    /i [msi_file]
    The path of the Windows installer file, openit_[version]_adminportal_windows_x64.msi.

    /l*v [log_file]
    The path of the installation log file that will be created during installation.

    Options:
    /quiet
    Run the command in silent mode.

    /passive
    Run the command in unattended mode – progress bar only.

    Note: The installer will use the Windows Installer Interface process when the installation option is not specified.

    Properties:
    INSTALLDIR=$INSTALL_DIR:
    The path where the Open iT files will be installed.
    This value is set to C:\Program Files\OpeniT\Admin Portal by default.

    IISPORT=[portnumber]:
    The TCP/IP port number used by the website. This is set to 3000 by default.

    SERVERURI=[server_uri]:
    The Open iT Core Server URI used by the Admin Portal web interface to fetch data.

    IDENTITYURI=[identity_uri]:
    The Identity Server URI used by the Admin Portal for authentication.

  3. When using the passive mode, wait until the process bar dialog disappears. When using the quiet mode, verify if the installation is complete by opening the Task Manager and checking in the Details tab if the msiexec process is still running.

Software Installation Verification #

Verify Created Directories and Files #

Go to the $ROOT_DIR of the installation located, by default, in C:\Program Files\OpeniT\Admin Portal and verify that the following directories and files exist:

  • BlazorDebugProxy – contains DLL files related to Blazor
  • Configurations – contains JSON files used as configuration for various aspects of the system
  • Documentations – contains all the markdown files of the documentations displayed in the web interface
  • wwwroot – contains files used by the web application
  • appsettings.json – contains application settings for web access and authentication
  • OpeniT.AdminPortal.Server.exe – the Open iT Admin Portal application executable
  • web.config – contains specific configuration for web service
  • Other DLL files

Verify Website #

  1. Open IIS (Internet Information Services) in the machine with Admin Portal
  2. In the Connections pane, expand the root node and Sites.
  3. Make sure that Open iT Admin Portal Website is present.
  4. Click Open iT Admin Portal Website, and in the dashboard, double-click Authentication.
  5. Make sure that Anonymous Authentication is enabled.

Post-Installation Configuration #

Support for Multiple Configuration Files #

As the configuration base keeps growing for upgrades, customizations, etc., Open iT supports the following configuration file types in Admin Portal and CLIMS:

Factory Files
These are the configuration files included in the installer. They can be modified but will be overwritten by an upgrade.

  • $CONFIG_DIR/File.json

Server-customized Files
These are optional configuration files which can be duplicated based on the factory files. These take precedence over factory files and can also be distributed from the server, but will not be overwritten by an upgrade.

  • $CONFIG_DIR/File.Override.json

User-customized Files
These are optional configuration files which can be duplicated based on the factory or server files. These take precedence over both the factory and server files and will not be overwritten by an upgrade.

  • $CONFIG_DIR/File.User.json

Time-based Files
These are optional configuration files that only activate on a specific date or time. These take precedence over all the configuration files and will not be overwritten by an upgrade.

  • $CONFIG_DIR/File.{YYYY-MM-DD}.json – activates on the specified date
  • $CONFIG_DIR/File.{YYYY-MM-DD}T{HH}.json – activates on the specified date and time
  • $CONFIG_DIR/File.{HH}.json – activates every {HH} hour

Identity Server Configuration #

Register the Identity Server to establish communication with Admin Portal:

  1. Go to the $INSTALL_DIR of Identity Server
  2. Open the appsetting.json file.
  3. Locate the IdentityServer.Clients.ClientName:AdminPortal block.

    ... { "Enabled": true, "ClientId": "0c114018-ef10-4fe3-87d8-acb5589e2b7c", "ClientName": "AdminPortal", "AllowedGrantTypes": [ "authorization_code" ], "RequireClientSecret": false, "RequirePkce": true, "AllowedScopes": [ "openid", "profile", "email", "adminportal" ], "RedirectUris": [ "http://mnl164win:3000/authentication/login-callback" ], "PostLogoutRedirectUris": [ "http://mnl164win:3000" ], "BaseUri": "http://mnl164win:3000", "Icon": "adminportal.svg" } ...
  4. Set the value of the following attributes:
    • RedirectUris: Error! Hyperlink reference not valid.
    • PostLogoutRedirectUris: Error! Hyperlink reference not valid.
    • BaseUri: Error! Hyperlink reference not valid.
  5. Save the changes.

Authority Configuration #

Perform the following configuration if the Identity Server URI is not provide upon installation.
To configure appsettings.json:

  1. Go to the $INSTALL_DIR/wwwroot of Admin Portal.
  2. Open the appsetting.json file
  3. Locate oidc.Authority and set its value to Error! Hyperlink reference not valid. if:
    • Identity Server is manually configured as a virtual application
    • Install Identity Server under existing Admin Portal check box is ticked during the Identity Server installation; or
    • Open iT Enterprise is used.
      Otherwise, use Error! Hyperlink reference not valid..

      { "oidc": { "Authority": "http://mnl164win:82/Auth", "ClientId": "0c114018-ef10-4fe3-87d8-acb5589e2b7c", "DefaultScopes": [ "openid", "profile", "email", "adminportal" ], "PostLogoutRedirectUri": "/", "ResponseType": "code", "UseMSAL": false } }
  4. Save the changes.

To configure Authentication.json:

  1. Go to the $CONFIG_DIR of Admin Portal.
  2. Open the Authentication.json file.
  3. Locate Authentication.JWT.Authority and set its value to Error! Hyperlink reference not valid. if
    • Identity Server is manually configured as a virtual application;
    • Install Identity Server under existing Admin Portal check box is ticked during the Identity Server installation; or
    • Open iT Enterprise is used.

    Otherwise, use Error! Hyperlink reference not valid..

    { "Authentication": { "JWT": { "Authority": "http://mnl164win:82/Auth",
    e, "RequireHttpsMetadata": false, "ValidateAudience": false } } }

  4. Save the changes.
X