Running the Hyland IdP Installer from the Command Line - Identity and Access Management Services - 3.1 - 3.1 - Other - external

Identity and Access Management Services
Platform
Other
Product
Identity and Access Management Services
Release
3.1
License

The Hyland IdP server, which includes the Hyland IdP Administration application, can be installed from the command line.

Tip:

The installer can also be run using a graphical installation wizard. See Installing the Hyland Identity Provider (IdP) Server.

To install the Hyland Identity Provider (IdP) server and Hyland IdP Administration application:

  1. Open a Windows command prompt with elevated administrator privileges.
    Tip:

    It is recommended to use Windows PowerShell to run command line operations.

  2. Change to the directory where the Hyland.Identity.Server.Setup.exe is saved.
  3. Type Hyland.Identity.Server.Setup.exe, but do not run it yet.
  4. Append the following switches and their values to the command. Be sure to enclose the values in double quotation marks.

    Switch

    Value

    /silent

    Add this switch to complete the operation with no user interaction.

    idpAppName

    The name for the Hyland IdP server.

    Note:

    The Hyland IdP server cannot have the same Application Name as other applications on the website. The Application Name should use all lowercase letters. It is a best practice not to use parentheses in the Application Name.

    This value is not required. The default name for the Hyland IdP server is identityprovider.

    idpAppPool

    The name for the application pool the Hyland IdP server will use.

    This value is not required. The default name for the application pool is identityproviderAppPool.

    Note:

    The identity running the Hyland IdP server application pool must have Read access to the private key of the encryption certificate. For details on configuring certificate permissions, see the documentation provided by Microsoft for the Certificate Manager tool.

    idpSiteName

    The website in IIS to install the Hyland IdP server under.

    This value is not required. If this value is not included, the server is installed under the default web site.

    Note:

    The website must already be configured in IIS and available to the target server.

    idpInstallDir

    The installation directory for the Hyland IdP server.

    This value is not required. The default installation location is C:\Program Files\Hyland\identityprovider\.

    useAppPoolIdentity

    Set to true to configure a specific account for the Hyland IdP application pool to run under.

    This value is not required. If it is not included or is set to false, the application pool runs under the ApplicationPoolIdentity account.

    idpAppPoolUser

    The user name of the account to run the application pool under.

    This value is required if useAppPoolIdentity is set to true.

    idpAppPoolUserPass

    The password that corresponds to the user name used for the idpAppPoolUser switch.

    This value is required if useAppPoolIdentity is set to true.

    retainConfigFiles

    Set to yes to retain the configured idpconfig.json and appsettings.json configuration files from the previous version of the Hyland IdP server you are upgrading from.

    This value is not required. If it is not included or is set to no, the default idpconfig.json and appsettings.json configuration files are installed and the previously configured configuration files are not retained.

    For example, a completed installation command may look like this:

    Hyland.Identity.Server.Setup.exe /silent idpAppName="myidp" idpAppPool="myidpAppPool" idpInstallDir="C:\MyLocation\myidp" useAppPoolIdentity="false"
  5. Press the Enter key to run the installation command.
  6. After installation, complete the steps in the following sections: