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

Humly Sensor Gateway - First-time setup

This article takes you from a fresh installation to a gateway that is paired with Humly Control Panel. It takes about 15 minutes. You prepare Humly Control Panel first, then set up HSG in its dashboard.

In this article

Before you start

Tip

The Windows and Linux installers can create the admin account and the pairing for you. If you entered those details during installation, sign in and go straight to step 5.

Step 1: Prepare Humly Control Panel

HSG sends readings to Humly Control Panel through an integration user. Humly Control Panel only accepts the readings when the licence and the integration are both active.

  1. Go to Settings > Licenses and add your Humly Sensor Gateway licence.
  2. Go to Settings > Sensor integration and turn on Humly Sensor Gateway.
  3. Go to Users and add a user with the API Integration role. Write down the username and password. HSG uses them in step 4.

Note

Add the licence before you turn on the integration. Without a valid licence, Humly Control Panel turns the integration off again.

Step 2: Find the setup token

HSG prints a one-time setup token when it starts and no admin account exists yet. The token proves that you have access to the server.

Server Where to find the token
Linux Run sudo journalctl -u humly-hsg and look for the line about the setup token.
Windows Open C:\ProgramData\Humly\SensorGateway\logs\HsgService.log.

A restart creates a new token. Always use the most recent one.

Step 3: Create the admin account

  1. Open http://<hsg-server>:3100 in a browser.
  2. Paste the setup token.
  3. Choose an admin username. Use 3 to 64 characters: letters, digits, and . _ @ -.
  4. Choose a password. Use 12 to 64 characters, with an uppercase letter, a lowercase letter and one of these characters: @ ! # $ % ' ( ) = ? / + * , . -
  5. Click Create admin & continue.

The HSG create-admin screen with the setup token, admin username and password fields

Important

Store the admin password safely, for example in your password manager. HSG has no self-service password reset yet.

Step 4: Pair with Humly Control Panel

  1. Enter the HCP URL, for example https://humly.example.com.
  2. Enter the username and password of the integration user from step 1.
  3. Click Pair with HCP.

The HSG pairing screen with HCP URL, integration user and password

HSG signs in to Humly Control Panel to check the details. When pairing succeeds, the dashboard opens on the Sensors page. The top right shows Paired with HCP and the address.

If pairing fails: Check that the HSG server can reach the HCP URL over HTTPS. Then check the integration user's username, password and role.

Step 5: Turn on two-factor authentication

We recommend two-factor authentication for every gateway. The dashboard controls pairing and sensor access, so protect it like any other admin tool.

  1. Go to Settings. Under Security, click Enable two-factor authentication.
  2. Scan the QR code with an authenticator app, such as Google Authenticator, Microsoft Authenticator or 1Password.
  3. Enter the 6-digit code from the app and click Confirm & enable.
  4. HSG shows one recovery code. Store it safely. It works once, if you lose access to your authenticator app.

The Enable two-factor authentication dialog with a QR code and a verification code field

Optional: Serve the dashboard over HTTPS

By default the dashboard runs over HTTP on your local network. To use HTTPS, upload your own certificate under Settings > TLS certificates. HSG switches to HTTPS without a restart.

The TLS certificates panel with fields for the server certificate, private key and CA chain

Important

After the switch, change your network server's webhook address from http:// to https://. The network server must trust your certificate. Certificates from public certificate authorities work without changes. A private certificate authority may need to be added to the network server's trust store.

Next steps

Humly Sensor Gateway guide

Get started

Install and set up

Connect sensors

Manage and troubleshoot