Administration

DeskClient Customization

You can customize the look of certain parts of the DeskClient helping you to distinguish the different DeskClients you work with.

Location of all custom image files

All custom image files explained in the following sections must be located in a folder named branding in the DeskClient installation.

  • On Windows, the branding folder must be placed in the DeskClient root folder (containing the deskclient.exe and deskclient.ini).
  • On macOS, the branding folder must be placed in the /Contents/MacOS folder of the DeskClient app bundle.

Change splash screen

The splash screen is shown on application start. The image file must have a size of 500 x 540 pixels and named splash.bmp or splash.png.

Place a logo in login screen

You can customize the login screen by adding your own logo in the top right corner. The image file must be a transparent PNG not larger than 207 x 71 pixels and named splash_additional_logo.png.

Maximum size of branding logo is 207 x 71 pixels
Sophora Login (Image: subshell/CC BY)

Change background of login screen

The background image of the login screen must be a PNG of size 500 x 540 pixels and must fit with the fields, buttons and links of the login form. The position of these elements can not be customized. The name of your image file must be splash_background.png.

Change icon of Sophora menu item in main toolbar

The image file of the Sophora menu item in the main toolbar of the DeskClient must be a PNG of size 32 x 34 pixels with name main_toolbar_logo.png. For high resolution displays a second image of size 64 x 68 pixels with name main_toolbar_logo@2x.png is needed.

Add environment information to main toolbar

In addition to changing the images, environment information can also be configured and displayed in the main toolbar of the DeskClient. To do this, you need to set the following parameters in the configuration document.

ParameterDescriptionPossible Values
environment.descriptionAn optional description for the server environment that is displayed in the DeskClient.Any string, e.g.:
"This is a test system for experimental usage."
environment.nameA name for the server environment that is displayed in the DeskClient.Any string, e.g: "TEST", "PROD", ...

Last modified on 9/26/23

The content of this page is licensed under the CC BY 4.0 License. Code samples are licensed under the MIT License.

Icon