Configure HEAT Capture

Settings are edited in the application’s settings pages. Every edit is written to C:\ProgramData\VRAI\HEATCapture\UserConfig.json, and that file is watched, so most changes apply immediately. The tables below mark the settings that need a restart.

appsettings.json in the install directory holds the shipped defaults. It is not watched and is replaced on upgrade, so make deployment changes in the application or in UserConfig.json, not there.

Configuration is layered. Later layers win:

1. appsettings.json in the install directory
2. heat.modules.json, install directory then C:\ProgramData\VRAI\HEATCapture
3. UserConfig.json in C:\ProgramData\VRAI\HEATCapture
4. Command-line overrides in the form --Section:Key=value

Platform connection

Changing HEAT_URL at runtime recreates the platform connection and signs the current user out. It also stops undelivered sessions recorded against the previous URL from being replayed: replay only runs when a stored session’s platform URL matches the configured one.

Platform connection settings, with the URL validated and the template and input node resolved to names.

Embedded web server

The application hosts its own HTTP server for the user interface and the API.

All four need an application restart. They are read once, before the web server starts.

Two behaviours worth knowing before enabling HTTPS:

• The HTTPS listener always binds every interface, whatever Host says. Enabling HTTPS on a loopback-bound deployment exposes the application to the network.
• If the resolved HTTPS port is outside 1 to 65535, or equal to the HTTP port, the HTTPS listener is skipped and HTTP stays up. The log records the reason.

Capture

Capture settings, with an example session name and Manual capture type.

Changing the language reloads the interface.

Capture store

The capture store is the on-disk buffer every packet passes through before delivery.

Session backup

An optional local copy of session data, separate from the capture store.

Module trust

This setting needs a restart. The application reports that when you change it.

Module sources and policy

The Modules section defines where module packages come from and what may be installed. It is read once at startup, so every key here needs a restart.

For a locked-down workstation, set EnforceAllowedModules to true with an explicit AllowedModules list, and set AllowPackageMutations to false once the workstation is provisioned.

Each installed module has its own settings section, including an Enabled flag. Module settings apply live and are pushed to the running module. See the page for the module in question.

Import a deployment configuration

Most customer deployments receive a VRAI-prepared .hcz file rather than a Module Library token. The HEAT Configuration Zip contains merged application settings, package metadata and the approved module directories. Import it from Settings using Import Config.

Import is a replacement, not a merge: it backs up the current state, replaces the current settings and all installed modules, and requires a restart. The package must contain settings.json and metadata.json; the upload limit is 512 MiB. The exported package format version at this product ref is 1.0.

The package excludes the installed-package manifest and removes the module-repository authentication token from exported settings. A customer package therefore does not need or carry a Module Library token unless separate registry access is configured after import.

Settings that need a restart

• Everything under WebSettings
• ModuleSecurity:AllowUnsignedModules
• Everything under Modules
• Any value set only in appsettings.json
• Importing a configuration package

Everything else applies as soon as it is saved. Installing, updating and removing a module apply to the running application and need no restart. See Modules.

Storage Settings at the documented defaults.

HEAT Capture team. Last updated 2 October 2026.