Skip to content
  • There are no suggestions because the search field is empty.

Install Humly Sensor Gateway on Windows

This article explains how to install Humly Sensor Gateway (HSG) on a Windows server. The installer sets up everything HSG needs, including its MQTT broker, and runs both as Windows services.

In this article

Before you start

  • A server that meets the requirements: Windows Server 2022 or later, 64-bit.
  • A local administrator account on the server.
  • The installer file, HsgInstaller_v<version>.exe.
  • Optional: the address of Humly Control Panel and an integration user. You can also add these after installation.

Install HSG

  1. Run HsgInstaller_v<version>.exe as an administrator.
  2. Read and accept the licence terms.
  3. Click through the welcome page, and choose the install folder. The default is C:\Program Files\Humly\SensorGateway.
  4. On the Administrator & HCP pairing page, you can fill in:
    • A dashboard admin username and password.
    • The Humly Control Panel address, integration user and password.
    All fields are optional. Leave them empty to set them up in the dashboard instead.
  5. Click Install and wait for the installer to finish.

The installer also installs .NET Framework 4.8, the Visual C++ runtime and Node.js 22, if they are missing. They stay on the server if you uninstall HSG later.

After installation

  1. Open http://<server>:3100 in a browser.
  2. If you created an admin in the installer, sign in.
  3. If not, open C:\ProgramData\Humly\SensorGateway\logs\HsgService.log and copy the setup token.
  4. Continue with Humly Sensor Gateway - First-time setup.

Services, folders and logs

Item Value
HSG service Humly Sensor Gateway (HumlySensorGateway). Starts automatically and restarts after a failure.
MQTT broker service Humly Mosquitto (HumlyMosquitto). Starts automatically.
Program folder C:\Program Files\Humly\SensorGateway
Data folder C:\ProgramData\Humly\SensorGateway. Holds the database, settings, secrets and certificates.
HSG log C:\ProgramData\Humly\SensorGateway\logs\HsgService.log
Firewall rules Humly Sensor Gateway Dashboard (TCP 3100) and Humly Sensor Gateway MQTT (TCP 1883)

MQTT broker messages appear in the dashboard under Logs, with the source Mosquitto.

Change the dashboard port

  1. Open C:\Program Files\Humly\SensorGateway\HsgService.exe.config in a text editor as an administrator.
  2. Change the Port value.
  3. Restart the Humly Sensor Gateway service.
  4. Update the Humly Sensor Gateway Dashboard firewall rule to the new port. The installer does not change it for you.
  5. Update the webhook address in your network server.

Uninstall HSG

Important

Uninstalling removes the data folder, C:\ProgramData\Humly\SensorGateway. That deletes your sensors, settings, MQTT logins and certificates. Copy the folder somewhere safe first if you may need it again.

  1. Open Settings > Apps (or Programs and Features).
  2. Select Humly Sensor Gateway and click Uninstall.

The uninstaller removes both services, the firewall rules, the program folder and the data folder.

To install a newer version, do not uninstall. See Update Humly Sensor Gateway.

Humly Sensor Gateway guide

Get started

Install and set up

Connect sensors

Manage and troubleshoot