Install Web-Based Clients at a Command Prompt

About this task

This topic describes how to install Web-Based Clients at a command prompt. You can also install Web-Based Clients using an installer.

Procedure

  1. If you want to install Web-Based Clients with the default values, run the following command:
    install.exe /quiet AdminClientSecret=<password> ConfigHubAdminClientSecret=<password>
  2. If you want to modify the default values, run the following command:
    install.exe /quiet AdminClientSecret=<password> ConfigHubAdminClientSecret=<password> <parameter>=<value>
    The following table describes the installation parameters.
    Parameter Description Default Value
    PublicPort Port for https protocol communication used by Web-Based Clients. 443
    UAAHttpPort Port for http protocol communication used by the UAA service. 9480
    UAADatabasePort Port for the UAA database. 9432
    HistorianHttpPort Port for the http protocol communication used by Web-Based Clients. 8070
    HistorianDatabasePort Port for the PostgreSQL Historian database. 8432
    UAALdapConfigPort Port for the Configuration Hub LDAP service. 7010
    UAASecurityAppPort Port for the UAA Configuration tool. 7011
    AdminClientSecret The password to connect to the UAA service. The password must satisfy the following conditions:
    • Must not contain only numbers.
    • Must not begin or end with a special character.
    If the password does not satisfy these conditions, the installation may be successful, but Web-Based Clients will not work.
    Not applicable
    UseExternalUaa Identifies whether you want to use an external UAA service. If you want to use an external UAA, enter 1. 0
    ActiveUaaBaseUrl The base URL to connect to an external UAA. A value is required only if you want to connect to an external UAA service. Enter a value in the following format: https://<UAA server machine name>:<public https port number>
    UAAAdminClientSecret The admin password to connect to an external UAA service.
    ConfigHubPort The NGINX port that you want to use for Configuration Hub. 5000
    ConfigHubContainerPort The port for the Configuration Hub container. 4890
    ConfigHubInstallFolder The installation folder for Configuration Hub. C:\Program Files (x86)\GE\ConfigurationHub
    UseExternalConfigHub Identifies whether you want to use Configuration Hub installed with iFIX or on a remote machine. If you want to use an external Configuration Hub, enter 1. 0
    ExternalConfigHubMachineName The FQDN of the remote server or the iFIX server that you want to use for Configuration Hub.
    ConfigHubClientId The username to connect to Configuration Hub. admin
    ConfigHubClientSecret The password to connect to Configuration Hub.
    DataPath The path to the log files and PostgreSQL data. C:\ProgramData\HistorianWebBasedClientsLogs
    DestinationHistorian The name of the destination Historian server.
    Note: If you want to connect to a remote Historian server, you must disable the Enforce Strict Client Authentication and Enforce Strict Collector Authentication options using Historian Administrator in the remote server.
    To install Web-Based Clients, run the following command:
    Install.exe /quiet PublicPort=443 UAAHttpPort=9480 UAADatabasePort=9432 HistorianHttpPort=8070 
    HistorianDatabasePort=8432 UAALdapConfigPort=7010 UAASecurityAppPort=7011 AdminClientSecret=abc 
    ConfigHubPort=5000 ContainerPort=4890 ConfigHubInstallFolder= C:\Program Files (x86)\GE\ConfigurationHub 
    ConfigHubAdminClientId=admin ConfigHubAdminClientSecret=xyz 
    DataPath=C:\ProgramData\HistorianWebBasedClientsLogs
    To install Web-Based Clients with an external Configuration Hub, run the following command:
    Install.exe /quiet PublicPort=443 UAAHttpPort=9480 UAADatabasePort=9432 HistorianHttpPort=8070 
    HistorianDatabasePort=8432 UAALdapConfigPort=7010 UAASecurityAppPort=7011 AdminClientSecret=abc 
    UseExternalConfigHub=1 ActiveConfigHubBaseUrl=abc123 ConfigHubAdminClientId=admin
    ConfigHubAdminClientSecret=xyz DataPath=C:\ProgramData\HistorianWebBasedClientsLogs