In this article
Users with admin permissions or higher use this article to reference configuration options for the Windows Roaming Client. This guide includes both legacy Windows registry keys and current appsettings.overrides.json settings for version 3.0.0 or higher.
Local configurations Windows agent v3.0.0+
Starting with Windows Roaming Client v3.0.0, local configuration changes are managed through a JSON override file instead of the Windows registry.
Configuration file overview
Local configuration overrides are applied by creating an appsettings.overrides.json file. This file does not exist by default and must be created manually when overrides are required.
File locations:
-
Branded agent:
C:\ProgramData\DNSFilter, Inc\Settings -
Whitelabel agent:
C:\ProgramData\DNSAgent\Settings
Only users or processes with write access to the ProgramData directory (typically local administrators) can create or modify this file.
Create an override file
To customize configuration locally, create a separate override file:
{
}Start with an empty JSON object, then add only the specific keys to override, using the same structure and formatting shown in appsettings.defaults.json.
This ensures only the intended values change without overriding the full configuration chain.
🚨 Important: A malformed override file can prevent the Roaming Client from starting or cause it to behave unexpectedly. If troubleshooting configuration issues, Support may request a copy of the override file.
Combine related settings
When multiple configuration values belong to the same section, combine them in a single block as shown below:
"LoopbackProxy": {
"IgnoredVpnInterfaceNames": [
"vpn1",
"sonicwall2"
],
"IgnoredVpnInterfaceDescriptions": [
"vpn1",
"sonicwall2"
],
"UpstreamProtocolTypeOrder": "StandardUdp, StandardTcp, DnsOverTls"
}JSON vs registry and MSI settings
- Runtime agent configuration settings now use JSON instead of registry keys
- Most legacy registry-based runtime settings have JSON equivalents
- Install-only settings (such as
ARPSYSTEMCOMPONENT) remain in the registry and do not have JSON equivalents - MSI command-line parameters behave the same as in earlier versions and still apply during installation
Legacy Registry configurations
Edit any of the settings listed below via the Registry for agent versions 2.2.1 and older.
Locate Registry Keys
HKLM\SOFTWARE\DNSFilter\AgentHKLM\SOFTWARE\DNSAgent\Agent
Registry Key definitions
Use this table to understand Windows Roaming Client Registry settings, their values, and definitions. "Agent" refers to the Windows Roaming Client.Â
| Registry Setting | Value | Description |
Address |
IPv4 address | IPv4 address listening by the agent. For example 127.0.0.1, 127.0.0.2, 127.0.0.3, 127.0.0.4 |
AddressIPv6 |
IPv6 address | IPv6 address listening by the agent. For example, ::1, 0:0:0:0:0:0:0:1 |
ClientId |
GUID | Agent instance identifier used to identify a roaming client by back-end. |
CumulativeInterfaceInfo |
base64 encoded string | DNS setting values backup obtained on agent installation in base64 encoded string format. (cumulative over time) |
CurrentValues |
base64 encoded string | Current DNS setting values backup in base64 encoded string format. |
DiagnosticsSharingEnabled |
Default is |
If value is true then the agent allows to upload diagnostic results to the back-end. The value populates from App Dashboard settings. |
DNSDomainSuffixList |
comma delimited list Default is empty |
Comma delimited list of custom DNS suffixes used to determine local domains. Can be entered into the local domains / resolvers section of windows roaming client settings. |
EnableHyperVSupport |
Default is |
If value is Otherwise, there will be conflict between roaming client and Hyper-V. |
Hostname |
string Default is empty |
Custom hostname (device name). |
IgnoreInconclusiveDNSResolution |
Default is |
If value is true then the agent ignores unresolved SRV and SOA DNS queries and process them as resolved. |
IgnoreVpnInterfaces |
Default is empty |
Defines if VPN network adapters should be ignored by the agent. If value is true then VPN adapter will be ignored, otherwise no. |
IgnoreVpnInterfacesDescriptions |
comma delimited list | Comma delimited list of words in lower case which appear in VPN adapter description to identify VPN adapters. |
IgnoreVpnInterfacesNames |
comma delimited list | Comma delimited list of words in lower case which appear in VPN adapter name to identify VPN adapters. |
IgnoreVpnInterfacesServerValue |
Default is |
Defines if VPN network adapters should be ignored by the agent. If value is true then VPN adapter will be ignored, otherwise no. This values populates from App Dashboard settings. |
IncludeLocalResolversEdnsRecords |
Default is |
When this setting is set to true, the agent sends EDNS options (client ID, user ID and etc) to Local Resolvers specified in App Dashboard. |
InstallARPSystemComponent |
string Default is empty |
ARPSYSTEMCOMPONENT argument used on agent installation. This value is used on a roaming client auto update. |
InterfaceInfo |
base64 encoded string | Original DNS setting values backup in base64 encoded string format obtained before setting DNS to loopback address by the agent. |
LastApiSync |
date and time in format yyyy-MM-dd HH:mm:ss Default is empty |
Date and time of last Windows logged-on user account synchronization with the back-end. |
LastRemoteDiagnosticsRequest |
date and time in format yyyy-MM-dd HH:mm:ss Default is empty |
Date and time of last remote diagnostic request triggered from App Dashboard. |
NetworkKey |
string | Site Secret key from App Dashboard used on agent installation. |
ProductGUID |
Product MSI install GUID | Do not modify or remote uninstall will not work |
Registered |
1 / 0
|
Agent registration status: 1 - registered 0 - unregistered |
RemoteDiagnosticsEnabled |
Default is |
If value is true then the agent allows to run remote diagnostic triggered from App Dashboard. The value populates from App Dashboard settings |
Running |
0/1 | Used internally by RC for tracking flows. Do not Modify |
Status |
string | Agent status (deprecated). |
Tags |
string Default is empty |
Custom tags associated with the specific agent. |
TrayIcon |
Default is |
Defines if show tray icon or no. If value is enabled then the tray icon will be shown in tray, otherwise it will be hidden. |
UpstreamIpVersion |
Default is empty |
Defines IP version supported by the agent. Roaming Clients support IPv4. See our troubleshooting guides like IPv6 local resolver support information and recommended IP version priorities. |
UpstreamOrder |
Default is empty |
Comma delimited of using upstreams in specific order. Default set of upstreams is For example, |
Username |
string | Current Windows logged-on user account. |
Version |
string | The installed agent version. |
Comments
0 comments
Please sign in to leave a comment.