SYNERGY
SYNERGY Management Gateway for Active DirectoryUser guide
Chapters

2.2Stage 1: Run the installer

Last updated

The installer is a Windows Installer package named Synergy.ManagementGateway.msi.

The installer checks two things before it will run:

CheckMessage if it fails
Windows versionThe product requires Windows Server 2016 or later.
ASP.NET Core Module V2The ASP.NET Core Module V2 was not found. Install the ASP.NET Core 10 Hosting Bundle, then run the installer again.

To install the product:

  1. Sign in to the server as a local administrator.
  2. Double-click Synergy.ManagementGateway.msi.
  3. On the welcome page, select Next.
  4. Read the licence agreement, accept it, and select Next.
  5. On the destination folder page, choose where the setup wizard and the update agent are installed. The default is C:\Program Files\Synergy\Management Gateway. Select Next.
  6. Select Install, and confirm the Windows elevation prompt if one appears.
  7. On the final page, leave Configure SYNERGY Management Gateway now (required before first use) selected and select Finish. The setup wizard starts.

If you clear the checkbox, the product is installed but does nothing until you run the setup wizard from the Start menu.

What the installer puts where

ItemDefault location
API (the server application)C:\inetpub\apps\api
Web consoleC:\inetpub\wwwroot
Setup wizardC:\Program Files\Synergy\Management Gateway
Update agent serviceC:\Program Files\Synergy\Management Gateway\Agent
Release notes and known limitationsRELEASE-NOTES.md and KNOWN-LIMITATIONS.md in the setup wizard's folder
Start menu entrySYNERGY Management Gateway Setup, in the SYNERGY Management Gateway folder
Windows serviceSYNERGY Management Gateway Update Agent (SynergyManagementGatewayUpdateAgent)
Install recordRegistry key HKLM\Software\Synergy\ManagementGateway (values ApiPath, ClientPath, Version)

The installer also places a web.config file in the API folder and in the web console folder. An upgrade does not replace an existing web.config, so changes you made to it are kept. The one exception is the name of the program the API's web.config starts, which an upgrade always sets to the current program file. An uninstall leaves both web.config files in place for the same reason. Earlier versions of the installer removed both files during an upgrade, so the upgrade from such a version still replaces them: if you edited a web.config, copy it somewhere safe before upgrading and put your changes back afterwards. Later upgrades keep it.

Installing to other folders

The API and web console locations are not offered on the installer's pages. To install them elsewhere — for example on a data drive — run the installer from an elevated command prompt and pass the folders as properties:

powershell
msiexec /i Synergy.ManagementGateway.msi APIFOLDERPATH="D:\apps\gateway" CLIENTFOLDERPATH="D:\web\gateway"

The installer records the folders it used, and the setup wizard reads them back, so the wizard configures IIS for the folders you chose. Upgrades read them back too, including the ones the update agent installs, so you pass the folders only at the first installation.

Last updated

Did this page help you?