2. Managing advanced configurations

Managing advanced configurations

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

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

Important

Encoding

Please note that the Cloudya-local-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 Cloudya-local-settings.json:

{

"handle-updates": "IGNORE",

"access-to-traybar": false,

"autostart": true

}

handle-updates

Type: string (values: INFORM, IGNORE)

Default: INFORM

Description:
By default, the Cloudya 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

Default: true

Description:
By default, the Cloudya 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 Cloudya 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 Cloudya Desktop-App v2.0.0.

Type: boolean

Default: false

Description:
By default, the Cloudya 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 Cloudya Desktop App on machine start.

Tip

The autostart feature of the Cloudya 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 Cloudya Desktop App is allowed by the system to automatically start.

Windows: Settings > Apps > Startup

MacOS: System settings > General > Login Items

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

}

# Convert the PowerShell object to JSON

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

# Specify the path for the JSON file

$jsonFilePath = "C:\Program Files\Cloudya\win-unpacked\Cloudya-local-settings.json"

# Write the JSON string to the file without BOM

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