Install on Windows

import { Aside } from ‘@astrojs/starlight/components’;

The Windows sink runs as a Windows Service and survives reboots automatically. It supports self-updating — when your administrator publishes a new version, the service downloads and installs the update without manual intervention.

Prerequisites

Windows 10 / Windows Server 2016 or later
Python 3.12+ installed and on PATH, or use the provided installer which bundles a runtime
Network connectivity to the Hub host and port (outbound TCP — no inbound rules needed)
Administrator privileges on the machine
A configured Sink Type with its Client ID and Client Secret (see Sink Types & Configuration)

Installation via Installer

The recommended approach is to use the Inno Setup installer provided by your administrator.

Step 1 — Run the installer

Double-click the .exe installer and follow the wizard. You will be prompted for:

Field	Value
Hub Host	Hostname or IP of the Hub (e.g. `hub.example.com`)
Hub Port	Port the Hub listens on (default `50051`)
Client Secret	The secret for this Sink Type (provided by your admin)
Tenant UUID (optional)	Your tenant UUID if pinning to a single tenant
Tenant Secret (optional)	Tenant registration secret if required

Step 2 — Verify the service

Open Services (services.msc), find Nexomatic Sink, and confirm it shows Running.

You can also check from PowerShell:

Get-Service -Name NexomaticSink

Step 3 — Confirm in the UI

Within a few seconds the sink should appear as ONLINE on the Sinks screen in Nexomatic.

Manual Installation

If you need to install without the wizard (e.g. in a scripted deployment), follow these steps.

Step 1 — Place the files

Copy the sink files to a directory, for example C:\Program Files\NexomaticSink\.

Step 2 — Create a virtual environment

cd "C:\Program Files\NexomaticSink"
python -m venv venv
.\venv\Scripts\pip install -r requirements.txt

Step 3 — Set environment variables

The service reads its configuration from the Windows Registry under:

HKLM\SYSTEM\CurrentControlSet\Services\NexomaticSink\Environment

Set the following values (type REG_SZ):

$svcKey = "HKLM:\SYSTEM\CurrentControlSet\Services\NexomaticSink\Environment"
New-Item -Path $svcKey -Force | Out-Null
Set-ItemProperty -Path $svcKey -Name SERVER_URL    -Value "https://controller.example.com"
Set-ItemProperty -Path $svcKey -Name HUB_HOST      -Value "hub.example.com"
Set-ItemProperty -Path $svcKey -Name HUB_PORT      -Value "50051"
Set-ItemProperty -Path $svcKey -Name HUB_TLS       -Value "true"
Set-ItemProperty -Path $svcKey -Name CLIENT_ID     -Value "REMOTE:WINDOWS"
Set-ItemProperty -Path $svcKey -Name CLIENT_SECRET -Value "<your-secret>"
Set-ItemProperty -Path $svcKey -Name AUTH_METHOD   -Value "client_credentials"
Set-ItemProperty -Path $svcKey -Name TENANT_UUID   -Value "<your-tenant-uuid>"
Set-ItemProperty -Path $svcKey -Name TENANT_SECRET -Value "<your-tenant-secret>"

Step 4 — Register and start the service

sc.exe create NexomaticSink binPath= "C:\Program Files\NexomaticSink\venv\Scripts\python.exe C:\Program Files\NexomaticSink\sink_service.py" start= auto
sc.exe failure NexomaticSink reset= 60 actions= restart/5000/restart/5000/restart/5000
sc.exe failureflag NexomaticSink 1
sc.exe start NexomaticSink

Automatic Updates

When your administrator publishes a new version, the Hub signals the running service to update. The service will:

Finish any in-progress tasks
Download the new installer silently
Apply the update and restart

No manual action is required. The service will be briefly unavailable during the update (typically under 30 seconds).

Managing the Service

# Stop
Stop-Service NexomaticSink

# Start
Start-Service NexomaticSink

# Restart
Restart-Service NexomaticSink

# View recent log entries (Event Viewer)
Get-EventLog -LogName Application -Source NexomaticSink -Newest 20

Uninstalling

Run the uninstaller from Add or Remove Programs, or from PowerShell:

sc.exe stop NexomaticSink
sc.exe delete NexomaticSink
Remove-Item -Recurse "C:\Program Files\NexomaticSink"

Troubleshooting

Symptom	Likely cause	Fix
Service fails to start	Missing or wrong credentials	Check registry values with `Get-ItemProperty`
Sink shows `OFFLINE` in UI	Cannot reach Hub	Check firewall — outbound TCP to Hub host:port must be allowed
Tasks not running	Sink Type mismatch	Confirm `CLIENT_ID` matches the Sink Type registered in Nexomatic
Update stuck	Installer running silently	Wait 60 seconds; if still stuck, manually restart the service