Launching TrueConf client application with settings taken from JSON file
Konstantin Kotov
October 2, 2023Very often system administrators have to effectively apply the same settings to multiple instances of an application installed in the corporate network.
One of the solutions for this task is to save settings in the file with a specific format (e.g., JSON, XML, or CSV) and place it on each of the target computers.
Starting from the 8.2.0 version, TrueConf can be launched with predefined parameters specified in a JSON file. Below, we will show how to create such a file.
How this method works:
- If a user adds the settings file, the application will read its contents, when launched, and update settings with the values from this file (the change will be reflected in the Settings menu).
- If a user manually changes settings in the application after creating/editing the file, the new settings will have higher priority and will be used afterwards. The json file will not be overwritten, but it will be ignored until it is edited (refer to Part 3).
- If the json file has already been created, to override application settings with this file, you just need to change the time when this file was last modified. For example, you can add and remove any character and then save the file.
Creating a file with parameters
First of all, it is necessary to create a JSON file and list the required settings as "key":"value" pairs where:
"key"is the identifier of the parameter that you want to configure"value"is the value of the given parameter.
To learn more about the JSON format, check the official documentation.
The PDF file with the full list of keys, their values, and corresponding settings is available for download via this link:
Here is an example of a JSON file with client application settings:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
{ "selfViewMirror":false, "invertedPTZControl":false, "audioPlayLevel":0.6, "aecEnable":true, "noiseSupEnable":true, "audioDumpEnable":false, "isSpeakerphoneHardwareMuted":false, "corporateServer":true, "canAskForServerSelector":false, "enableAutologin":true, "canAskForRateUs":false, "userDefinedServerHost":"192.168.0.1", "userDefinedServerPort":4307, "language":"ru" } |
The values of some parameters can be used only in combination with other parameters. For example, if the value of the corporateServer parameter is set to true (this parameter is responsible for automatic connection to the server when the application is started), you have to specify the value of the userDefinedServerHost parameter with the corresponding address of the server to which the application should connect. All the parameters that have to be used in pairs are marked in the PDF file mentioned before.
Launching the application
Place the created file settings.json to the directory where the application is installed:
- On Windows –
C:\Program Files\TrueConf\Client - On Linux –
/opt/trueconf/ - On macOS –
/Applications/TrueConf\ Client.app/Contents/MacOS(the character\is needed for escaping the space).
The file name settings.json is required if you choose this way of launching the application. The settings provided in any file with a different name will not be applied.
At this point, you can launch the application. All settings will be applied automatically.
Launching the application with an explicitly specified file path
Sometimes, it may not be convenient to replace the file stored at the installation path. A user may have to run the application with pre-defined settings only once. In this case, one has to launch the application with the --settings parameter. Specify the full path to the settings file as the argument. For example, you can do it in the Windows command line:
|
1 |
"C:\Program Files\TrueConf\Client\TrueConf.exe" --settings "D:/my_settings.json" |
There are multiple ways of running TrueConf client applications with command-line parameters. All of them are fully described in our knowledge base article.
Unlike the method described in the previous sub-section, here, you do not have to name the settings file only as settings.
