You are viewing an earlier version of the admin guide. For the latest version, please visit EmpowerID Admin Guide v7.211.0.0.

Install the Cloud Gateway Application

Owned by Phillip Hanegan
Aug 21, 2023
3 min read

After the server is configured and a person is created for the Cloud Gateway, we will install the Cloud Gateway Client software and verify it is working correctly. Follow the instructions below to Install the EmpowerID Cloud Gateway Client, Configure Server Role and Verify that the Cloud Gateway is working.

Install EmpowerID Cloud Gateway Application

Requirements : .NET Framework 4.8 must be installed on any server running the Cloud Gateway Client.

  1. On a designated on-premise machine, double-click the EmpowerIDCloudGateway.msi installer file to run it.

  2. In the EmpowerID Cloud Gateway Setup wizard, enter the Host URL to connect with and click Next. Provide the Azure tenant URL for the tenant to connect.

     

  3. On the Ready to install page, click the Install button. 

     

  4. When the agent finishes installing, click the Finish button to close the wizard.

     

  5. You should see the EmpowerID Cloud Gateway Setup window appear.


    Optionally, if you use a proxy to connect to the internet, select Use Proxy and enter the address in the Proxy Address field.

     

  6. Click on the Connect button.

  7. Enter the EmpowerID username and password for the remote cloud gateway account you previously created and click Login.

     

  8. Click OK to close the Registration Complete message box.

  9. Open Services.msc and start the EmpowerID Remote Agent Windows service.


     

Configure Server Roles For Cloud Gateway

After you have installed the Cloud Gateway Client, you will need to set the Server Role to Cloud Gateway for the server hosting the client. Please see Configuring Server Roles for more information.

Verify Cloud Gateway is working

We will now verify that the client gateway is working and configured correctly.

Whichever server the cloud gateway is installed on needs to be able to resolve the directory name and its directory server's names and be able to communicate with those servers via LDAP

  1. Check that the Cloud Gateway added the following values to the registry under HKEY_LOCAL_MACHINE > SOFTWARE > TheDotNetFactory > EmpowerID > RemoteAgent

    • ApiKey

    • ApiPath

    • ClientID

    • ServerGUID

    • Thumbprint

    • RecycleOnIdle (Value to be in minutes, Recycles the process when there is no incoming call received in a specified time window)

    • RecycleMaxMemory (Value is in GBytes, the process is terminated automatically if the memory usage reaches this value)

  2. On the connected EmpowerID Server, do the following:

    1. Open a browser and navigate to your EmpowerID portal.

    2. Authenticate and ping the cloud gateway by pointing your browser to HTTPS://<FQDN_Of_Your_EmpowerID_Server>/ui/#w/PingEmpowerIDServerViaRemoteAgent. You should see a lookup for searching and selecting your Cloud Gateway machine.

  3. Search for and select your Cloud Gateway machine and then click Submit.

     

  4. You should see a message stating the server was pinged.

  5. Click Submit to exit the process.