Skip to main content
Version: v2.7

Silent Install

Every Hopp install asset supports unattended installation, with a syntax that depends on the asset type:

  • Installer bundles (Hopp.Portal.exe, Hopp.Runtime.Agent.exe, Hopp.Studio.exe): an installer bundle that wraps an inner MSI and installs its prerequisites first (the .NET 10 runtimes for the Portal and the Runtime Agent; .NET Framework 4.7.2, the Visual C++ runtime, SQL Server LocalDB and Crystal Reports for Studio). Use Hopp.X.exe /quiet KEY=VALUE ….
  • Plain MSIs (Hopp.EngineFramework.msi, Hopp.Libraries.msi): direct MSI installers without a wrapping bundle. Use msiexec /i Hopp.X.msi /quiet KEY=VALUE ….
  • Visual Studio extension (Hopp.VsExtension.2022.vsix): a Visual Studio extension installed via the VSIX installer that ships with Visual Studio. Use VSIXInstaller.exe /quiet /admin Hopp.VsExtension.2022.vsix.

Silent install is useful for scripted provisioning of large fleets, repeatable lab setups, and any deployment that should not require a human at the console.

Installer bundles​

Run the installer bundle with the /quiet switch and a list of KEY=VALUE properties:

.\Hopp.Portal.exe /quiet KEY1=VALUE1 KEY2=VALUE2 ...

Each KEY is a property name from the per-bundle list below. The installer bundle installs its prerequisites first, then forwards the properties to the inner MSI for the product itself.

Values that contain spaces or special characters must be quoted with double quotes:

.\Hopp.Portal.exe /quiet INSTALLFOLDER="C:\Program Files\Hopp Portal" SERVICE_USERNAME="DOMAIN\hopp-svc" SERVICE_PASSWORD="<secret>"

On an upgrade, a property marked On first install can be omitted: the installer reuses the value saved by the previous install, and the Portal keeps the modules already installed. INSTALLFOLDER and the Agent's script paths are saved too, so omitting one keeps its previous value. SERVICE_PASSWORD is not saved, so pass it on every install or upgrade (except for a Managed Service Account).

The Portal and Runtime Agent bundles download the .NET 10 runtimes they need at install time, unless version 10.0.7 or later is already installed. On a server without internet access, install them first: the .NET Runtime 10.0.7 or later (x64) for both, and the ASP.NET Core Runtime 10.0.7 or later (x64) for the Portal.

When the install completes, the product is in the same state as if it had been installed through the interactive UI with the same values supplied, except that the service is not started: start it with Start-Service HoppPortal (Portal) or Start-Service AgentService (Runtime Agent). This applies to an upgrade and a silent Change of the Portal too: either stops the running service and leaves it stopped, so end the script with Start-Service.

Portal bundle (Hopp.Portal.exe)​

PropertyRequiredDescription
INSTALLFOLDERNoAbsolute path to the Portal install folder. Default: %ProgramFiles%\HoppTech\migFx\Portal.
SERVICE_USERNAMEOn first installWindows account the Hopp Portal service runs as. Use DOMAIN\username for AD accounts, .\username for local accounts.
SERVICE_PASSWORDYesPassword for SERVICE_USERNAME. Omit for a Managed Service Account (an account name ending in $).
BOOTSTRAP_TOKENOn first installToken the operator types on the bootstrap page to sign in to the wizard. At least 8 characters; choose a strong value and keep a copy, since it cannot be read back. On an upgrade, omit it to keep the current token.
INSTALL_EXTENSION_ITEMMGRNoSet to 1 to include the Item Manager module. Default: omit (module not installed).
INSTALL_EXTENSION_PLANNINGNoSet to 1 to include the Test module. Default: omit (module not installed). The property name uses the internal PLANNING identifier.

After a silent first-install, the Portal still needs the configuration wizard walked through before it leaves bootstrap mode. The operator, or a follow-up script, starts the service (Start-Service HoppPortal), opens http://localhost:5000 on the server, signs in with BOOTSTRAP_TOKEN, fills in the wizard pages, clicks Apply, and restarts the service (Restart-Service HoppPortal) to bring the Portal up in production mode.

Silent install does not populate appsettings.portal.json itself. If you want to skip the wizard entirely, write appsettings.portal.json and bootstrap.json under %ProgramData%\HoppTech\Portal\ before the service first starts.

Uninstalling the Portal leaves %ProgramData%\HoppTech\Portal\ in place, with bootstrap.json, appsettings.portal.json, the certificates, the data protection keys and the logs. A later install finds them and keeps the previous configuration, replacing only the bootstrap token and the module selection, so a Portal that was set up before does not start in the setup wizard. To walk the wizard again, use Reconfigure as described under Common pitfalls.

Runtime Agent bundle (Hopp.Runtime.Agent.exe)​

PropertyRequiredDescription
INSTALLFOLDERNoAbsolute path to the Agent install folder. Default: %ProgramFiles%\HoppTech\migFx\Agent.
SERVICE_USERNAMEOn first installWindows account the Hopp Runtime Agent service runs as.
SERVICE_PASSWORDYesPassword for SERVICE_USERNAME. Omit for a Managed Service Account (an account name ending in $).
PORTAL_URLOn first installPublic HTTPS URL of the Hopp Portal on the Master Server (the https:// prefix is optional; http:// is rejected). The Agent uses this URL at startup to request its runtime configuration from the Portal.
CLIENT_IDOn first installClient ID of the Agent's client application on the Portal.
CLIENT_SECRETOn first installClient secret of that client application. Also required on an upgrade that changes CLIENT_ID or SERVICE_USERNAME, or when the Agent has not started since the previous install; otherwise the Agent keeps the secret it has.
AGENT_STARTUP_SCRIPT_PATHNoFull path to an existing executable or script the Agent runs at service start, without arguments (use a wrapper script to pass any). Omit when none is required.
AGENT_SHUTDOWN_SCRIPT_PATHNoFull path to an existing executable or script the Agent runs at service stop, without arguments (use a wrapper script to pass any). Omit when none is required.

Create the Agent's client application on the Portal (Configuration > System > Client Applications) before silently installing the Agent. The CLIENT_ID and CLIENT_SECRET values come from that client application; without them the Agent fails to authenticate to the Portal at startup.

Studio bundle (Hopp.Studio.exe)​

PropertyRequiredDescription
INSTALLFOLDERNoAbsolute path to the Studio install folder. Default: %ProgramFiles%\HoppTech\migFx\Studio.

The Studio bundle accepts the SQL Server LocalDB license terms automatically during silent install (IACCEPTSQLLOCALDBLICENSETERMS=YES is set by the bundle). No operator-supplied property is required for that step.

Plain MSIs​

The Engine Framework and Libraries assets are direct MSI installers. They have no wrapping bundle, so silent install uses the standard msiexec syntax:

msiexec /i Hopp.EngineFramework.msi /quiet INSTALLFOLDER="C:\Program Files\Hopp\EngineFramework"
msiexec /i Hopp.Libraries.msi /quiet INSTALLFOLDER="C:\Program Files\Hopp\Libraries"

Both MSIs accept a single operator-supplied property:

PropertyRequiredDescription
INSTALLFOLDERNoAbsolute path to the install folder. Default: %ProgramFiles%\HoppTech\migFx\Engine Framework (Hopp.EngineFramework.msi) and %ProgramFiles%\HoppTech\migFx\Libraries (Hopp.Libraries.msi).

Neither MSI prompts for any further input, so silent install is the same operation as an interactive run with all defaults accepted, just without the UI.

Visual Studio extension (Hopp.VsExtension.2022.vsix)​

The Visual Studio extension is installed through the VSIX installer that ships with Visual Studio (VSIXInstaller.exe, typically under %ProgramFiles%\Microsoft Visual Studio\<version>\<edition>\Common7\IDE\). The VSIX has no custom properties; the only silent-install controls are the installer switches themselves:

& "C:\Program Files\Microsoft Visual Studio\18\Community\Common7\IDE\VSIXInstaller.exe" /quiet /admin Hopp.VsExtension.2022.vsix

The /quiet switch suppresses the UI; /admin is required because the extension is published as a machine-wide install (AllUsers="true" in the VSIX manifest), so it must be registered for every user on the workstation rather than only the current user. Omit /admin only when intentionally installing per-user.

Visual Studio must be closed when the silent install runs. A running Visual Studio instance holds locks on the extension's assemblies and the installer fails to replace them.

Common pitfalls​

  • A missing required property produces a silent failure: the exit code is non-zero and the install log explains which property was empty. To capture a log, pass /log "<path>.log" to an installer bundle (Hopp.X.exe), or /l*v "<path>.log" to msiexec for a plain MSI. The Windows Application event log also records the failure.
  • Passwords supplied on the command line appear in the process command line and may be captured by audit tooling. For high-security environments, either use a Managed Service Account that needs no password, or run the installer bundle through a deployment tool that injects the password from a secrets store at run time.
  • A repeat run of the same bundle with /quiet against an already-installed product enters maintenance mode (Repair or Uninstall, depending on flags). For a silent Change of the Portal, run msiexec /i with the installed Portal's product code and PORTAL_MAINTENANCEMODE=Change, the service credentials and both INSTALL_EXTENSION_* properties (1 for a module the Portal keeps or gains, 0 otherwise). To add or remove a module, also pass ADDLOCAL or REMOVE with ItemMgrExtensionFeature or PlanningExtensionFeature: the Portal loads every module whose files are installed. The Portal bundle accepts REENABLE_BOOTSTRAP=1 without effect. To return an already-configured Portal to setup mode, add REENABLE_BOOTSTRAP=1 to that silent Change, use Reconfigure in the Portal (Configuration > System > Reconfigure), or run the installer interactively, choose Change, and tick Re-enable Portal Setup wizard after install.