2. Managing advanced configurations

Managing advanced configurations

In this section, you will find a description of advanced Desktop App configuration options. These options offer the capability to manage update, minimise and autostart behavior.

The settings.json is a configuration file, mostly used in, but not limited to, automated roll-outs. It is located next to the Desktop App executable in the installation folder, usually located in c:\Program Files\DFN VoIP-Centrex\win-unpacked\ (Windows) or ~/Applications/DFN VoIP-Centrex.app/Contents/MacOS (MacOS).

Important

Encoding

Please note that the settings.json needs to be encoded in UTF-8.

Tip

Please note that all options are applied on the app start. If the options are changed, it is necessary to restart the app.

Configuration options

Example of settings.json:

{

"handle-updates": "IGNORE",

"access-to-traybar": false,

"autostart": true,

"microsoft-entra-fido2": false

}

handle-updates

Type: string (values: INFORMIGNORE)

DefaultINFORM

Description:
By default, the Desktop App regularly checks for new versions and prompts the user to install updates. This behavior can be undesired in an environment where software updates are centrally managed by an admin.
With handle-updates set to IGNORE, the update prompt will not be shown to the user.

access-to-traybar

Type: boolean

Defaulttrue

Description:
By default, the Desktop App will minimise into the system tray on Windows. In some environments, for example, a Citrix environment, the system tray is not available. Setting access-to-traybar to false will cause the Desktop App to minimise to the task bar instead, making sure it is still available to the user without the system tray.

autostart

Please note that this feature is only available starting with Desktop App v2.0.0.

Type: boolean

Default: false

Description:
By default, the Desktop App needs to be started after each machine restart, for the user to be available for calls. This option can be used to automatically start the Desktop App on machine start.

Tip

The autostart feature of the Desktop App can be managed using the system settings.

If the feature is not working as intended, please also check your system settings to confirm the Desktop App is allowed by the system to automatically start.

Windows: Settings > Apps > Startup

MacOS: System settings > General > Login Items

microsoft-entra-fido2

Please note that this feature is only available starting with Desktop App v2.1.0.

Type: boolean

Default: false

Description:
Enables support for FIDO2 security key login with Microsoft Entra ID (formerly Azure Active Directory).

Microsoft Entra may block security key authentication in some environments unless specific compatibility requirements are met. Activating this option ensures that the Desktop App is recognized as compatible for FIDO2 authentication during login.

Please note that this requires restart of the application when changed while the Desktop App is running.

Automatic creation via PowerShell

The following PowerShell script can be used to automatically create the JSON file:

create-local-settings.ps1

# Define your data as a PowerShell object (hashtable)

$data = @{

"handle-updates" = "IGNORE"

"access-to-traybar" = $false

"autostart" = $true

"microsoft-entra-fido2" = $false

}

# Convert the PowerShell object to JSON

$json = $data | ConvertTo-Json -Depth 4

# Specify the path for the JSON file

$jsonFilePath = "C:\Program Files\DFN VoIP-Centrex\win-unpacked\settings.json"

# Write the JSON string to the file without BOM

[System.IO.File]::WriteAllLines($jsonFilePath, $json)