Skip to main content

Bliksund Update Service - Installation Guide

Overview​

The Bliksund Update Service is the client-side component of the Version Manager system. It runs on client devices and handles:

  • Checking for available updates
  • Downloading update packages
  • Installing updates at scheduled times
  • Reporting installed software versions back to the Version Manager API

Prerequisites​

Before proceeding with the installation, ensure the following requirements are met:

  • Administrator Privileges: Installation requires administrator permissions to ensure the service has sufficient rights to install packages and perform updates.
  • Windows Service Compatibility: The application is intended to run as a Windows Service under the LocalSystem account for optimal security and access rights.
  • .NET Environment: Ensure the compatible .NET runtime is installed on the target machine.

Installation Steps​

  1. Unpack the VersionManager.Client.Installer.zip file and open this directory in the terminal.
  2. Run the MSI installer with the API URL and API key:
msiexec /i VersionManager.Client.Installer.msi SERVERAPIURL=https://your.versionmanager.api.url/api/device SERVERAPIKEY=yourDeviceApiKey
note

The SERVERAPIURL and SERVERAPIKEY parameters are required to connect the service to the VersionManager API.

  • The SERVERAPIURL parameter should be the URL of the VersionManager API
  • The SERVERAPIKEY parameter should be the API key configured in the VersionManager API (the DeviceApiKey)
  • The SERVERAPIURL must end with api/device

For example, if the service is deployed at https://your.versionmanager.api.url, the SERVERAPIURL parameter should be https://your.versionmanager.api.url/api/device.

Post-Installation Configuration​

  • Event Viewer Logging: Service logs are available in the Windows/Application section of the Event Viewer. Logs are bundled in warning events for each main process execution.
  • Configuration File: The service settings are stored in appsettings.json in the installation directory.

Configuration Options​

The service can be configured by editing the appsettings.json file:

{
  "ServiceTimer": {
    "ProcessIntervalMinutes": 5,
    "AllowedMinutesBeforeInstall": 30,
    "AllowedMinutesPastInstall": 30
  },
  "VersionManagerApi": {
    "Url": "https://versionmanager.bliksund.com/api/device/",
    "ApiKey": "your-api-key",
    "UpdateEndpoint": "update",
    "LogEndpoint": "log",
    "PackageEndpoint": "package"
    "TimeoutMinutes" : 2
  }
}

Key settings:

  • ProcessIntervalMinutes: How often the service checks for updates (in minutes)
  • AllowedMinutesBeforeInstall: How early to download before scheduled install time
  • AllowedMinutesPastInstall: How late after scheduled time installation can occur

Service Updates​

To update the service itself:

  1. Stop the service
  2. Delete the installation directory
  3. Re-install using the MSI installer
  4. Restart the service

Troubleshooting​

  • Permission Issues: Ensure the service runs with administrative privileges.
  • Configuration Changes: Modifications to appsettings.json require a service restart to take effect.
  • Installation Failures: Check Event Viewer for error messages.
  • Updates Not Installing: Verify the device is assigned to a group in the Version Manager web interface.
  • Service Not Running: Check Windows Services to ensure the service is running.

Verification​

To verify the service is running correctly:

  • Check Event Viewer under Windows/Application for logs
  • Verify the device appears in the Version Manager website
  • Look for state.json in the installation directory which indicates the service has run at least once