Configure and update the SuperIT RMM agent

Where the agent keeps its files, its settings and environment variables, logs, and automatic updates.

This page lists where the SuperIT RMM agent keeps its files on Windows, the settings you can change, where it logs, and how it updates itself. Most devices never need any of these changed.

File locations

Path	What it is	Kept after uninstall
`C:\Program Files (x86)\SuperIT\agent\superit-agent.exe`	The agent, run by the `SuperIT` Windows service	No
`C:\Program Files (x86)\SuperIT\agent\superit-updater.exe`	Installs agent updates	No
`C:\Program Files (x86)\SuperIT\agent\start-service.ps1`	Sets up and removes the service during install and uninstall	No
`C:\ProgramData\SuperIT\config.yaml`	Settings, including the install key	Yes
`C:\ProgramData\SuperIT\identity.json`	The device ID SuperIT issued when the agent registered	Yes
`C:\ProgramData\SuperIT\ngs-bootstrap.creds`	A credential that only lets the agent register	No
`C:\ProgramData\SuperIT\superit.log`	The agent's and updater's log, plus up to 3 compressed older logs	Yes
`C:\ProgramData\SuperIT\runs.jsonl`	A record of recent commands the agent ran	Yes

The installer uses Program Files (x86) on both x64 and ARM64 devices. If you chose a different folder in the setup wizard, the program files are there instead. To remove the files that are kept, see Remove leftover data.

Windows service

Property	Value
Service name	`SuperIT`
Display name	`SuperIT: <version>`, for example `SuperIT: 0.1.623`
Description	System monitoring and metrics collection agent for Super IT
Runs as	LocalSystem
Startup type	Automatic

Restart the SuperIT RMM agent after changing a setting:

Restart-Service -Name SuperIT

Configuration file settings

The SuperIT RMM agent reads C:\ProgramData\SuperIT\config.yaml when the service starts. The installer creates the file with most settings commented out, so the defaults below apply. To change a setting, remove the # in front of it, or add the line, then restart the service.

Setting	Default	What it does
`install_key`	Set by the installer	The install key the agent registers with. The agent uses it every time it starts, so don't remove it.
`metrics_interval`	`60`	Seconds between collections of system information and performance data.
`status_interval`	`30`	Seconds between status messages to SuperIT.
`logs.level`	`INFO`	Log detail: `DEBUG`, `INFO`, `WARN` or `ERROR`.
`logs.file_name`	`C:\ProgramData\SuperIT\superit.log`	Where the log is written. In YAML, write each backslash twice.
`logs.max_size`	`10`	Size in MB at which the log is rotated.
`logs.max_backups`	`3`	Number of rotated logs to keep.
`logs.max_age`	`28`	Days to keep rotated logs.
`logs.compress`	`true`	Whether rotated logs are compressed.
`update_check_interval_seconds`	`3600`	Seconds between update checks. `0` or a negative number means the default (one hour); it does not turn updates off.
`update_channel`	`stable`	The update channel. See Automatic updates.
`update_manifest_url`	`https://updates.superit.ai/latest.json`	Where the agent checks for updates. Don't change it.
`nats.server`	`tls://connect.ngs.global`	SuperIT's messaging service. Don't change it.
`nats.bootstrap_creds`	`C:\ProgramData\SuperIT\ngs-bootstrap.creds`	Path to the registration credential. Don't change it.

For example, to turn on debug logging while troubleshooting:

logs:
  level: "DEBUG"
  file_name: "C:\\ProgramData\\SuperIT\\superit.log"
  max_size: 10
  max_backups: 3
  max_age: 28
  compress: true

Set the level back to INFO when you're done.

Warning

config.yaml contains your install key. Anyone who can read it can add devices to your team. By default only administrators and SYSTEM can change files in C:\ProgramData\SuperIT\, but standard users may be able to read them. If a key leaks, contact [email protected] to revoke it.

Environment variables

Environment variables override config.yaml. The SuperIT service only sees system environment variables, and only after it restarts. Set them with setx <name> "<value>" /M or in System Properties → Environment Variables → System variables, then restart the service.

Variable	Overrides
`SUPERIT_CONFIG_PATH`	The path of the configuration file itself (default `C:\ProgramData\SuperIT\config.yaml`)
`SUPERIT_INSTALL_KEY`	`install_key`
`SUPERIT_METRICS_INTERVAL`	`metrics_interval`
`SUPERIT_STATUS_INTERVAL`	`status_interval`
`SUPERIT_LOG_LEVEL`	`logs.level`
`SUPERIT_LOG_FILE`	`logs.file_name`
`SUPERIT_UPDATE_CHECK_INTERVAL`	`update_check_interval_seconds`
`SUPERIT_UPDATE_CHANNEL`	`update_channel`
`SUPERIT_UPDATE_MANIFEST_URL`	`update_manifest_url`
`SUPERIT_NATS_SERVER`	`nats.server`
`SUPERIT_NATS_BOOTSTRAP_CREDS`	`nats.bootstrap_creds`

Settings are applied in this order, with later ones winning: built-in defaults, then config.yaml, then environment variables.

Logs

The SuperIT RMM agent writes its log to C:\ProgramData\SuperIT\superit.log, one JSON object per line. The updater writes to the same file. When the log reaches 10 MB it is renamed, compressed and replaced with a new one. Up to 3 older logs are kept, for up to 28 days.

To see the latest entries:

Get-Content -Path C:\ProgramData\SuperIT\superit.log -Tail 50

The service also writes start-up messages to the Windows Application event log. During installation, the installer's service set-up script writes service_registration.log to a temp folder, usually C:\Windows\Temp or C:\Windows\SystemTemp.

Automatic updates

The SuperIT RMM agent keeps itself up to date:

Once an hour, and when the service starts, it checks https://updates.superit.ai for a newer version on its update channel.
When there is one, it downloads the signed MSI to a superit-update-* folder in the SYSTEM account's temp folder and checks its SHA-256 checksum.
If commands are still running, or their results haven't been collected yet, it waits, for up to 90 minutes.
superit-updater.exe stops the SuperIT service, installs the MSI silently, and starts the service again.

Updates never restart the device. If Windows needs a restart to remove a file that was locked during the update, the new version runs straight away and the old file is removed at the next restart you choose. Updates keep config.yaml, identity.json and the logs, so the device stays registered. Updates are only offered for newer versions; the agent never downgrades itself.

Update channels

Channel	Gets
`stable` (default)	Releases SuperIT has promoted to all devices
`beta`	New releases first, before they reach `stable`

To put a device on a channel, set UPDATECHANNEL when you install (msiexec /i ... UPDATECHANNEL=beta), or set update_channel in config.yaml and restart the service. Check the spelling: a channel name that isn't made of lowercase letters, numbers and hyphens is treated as stable, but any other name, such as a misspelt btea, is used as given, and the agent gets no updates until you correct it. Leave devices on stable unless SuperIT support asks you to use beta.

You can't turn automatic updates off. Setting the check interval to 0 makes the agent use the default of one hour.

Device identity and imaging

When the SuperIT RMM agent first registers, SuperIT issues it a device ID, which the agent stores in C:\ProgramData\SuperIT\identity.json. The agent also sends hardware identifiers (SMBIOS UUID, BIOS and motherboard serial numbers, and the Windows machine GUID), which SuperIT uses to tell devices apart.

If you capture a Windows image with the agent installed, reset its identity as the last step before capture, so each new machine registers as its own device:

From an elevated prompt, run:
```
"C:\Program Files (x86)\SuperIT\agent\superit-agent.exe" -reset-identity
```
This stops the SuperIT service and deletes identity.json. The service stays stopped, and starts on each new machine's first boot.
Run sysprep /generalize /oobe /shutdown, so each machine gets its own Windows machine GUID.
Capture the image without starting the template machine again. If it starts, the agent writes identity.json again and undoes the reset.

Alternatively, install the agent after imaging. See also Duplicate or missing devices after imaging or cloning.