UTMSTACK logoUTMSTACK logo
AdministrationBranding

Branding

Branding (white-labelling) replaces the UTMStack name, colours and logos with your own. In UTMStack v12 the brand appears on the sign-in screen, in the menu, in emails and in PDF reports. Branding needs an Enterprise licence.

Before you start

  • You need the Administrator role (config.write permission).

  • The server needs an Enterprise licence. On Community, the page shows "White-labelling is an Enterprise feature" and nothing can be changed. See License and Editions.

  • Prepare your images. The page lists PNG, SVG, WEBP, JPG or ICO; GIF is accepted too. Each image can be up to 5 MB. A logo with a transparent background looks best in both the light and the dark theme.

Set up your brand

  1. 1

    Open Branding

    Go to Configure > Settings > Branding.

    The Branding page with the White-label switch, the Identity section (product name and accent colour) and the Logos section with upload boxes for the light logo, dark logo and favicon
  2. 2

    Turn on white-labelling

    Under White-label, switch on Enable white-labeling.

  3. 3

    Set the identity

    Under Identity:

    • Product name: the name shown in the browser title bar, the menu and emails.

    • Accent color: the main colour for buttons, links and selected items. Pick one of the eight preset colours or choose Custom color.

  4. 4

    Upload logos

    Under Logos, for each image click Upload (or Replace), choose the file, then click Upload to tenant:

    • Logo (light): used with the light theme.

    • Logo (dark): used with the dark theme.

    • Favicon: the small icon in the browser tab.

  5. 5

    Upload report images

    Under Report assets, upload a Report logo and a Report cover the same way. They are added to the PDF reports UTMStack generates.

  6. 6

    Save

    Click Save changes. Sign out to check the sign-in screen with your brand.

Each image is uploaded and stored when you click Upload to tenant ("Image uploaded"); the other settings are saved with Save changes ("Branding updated").

Go back to the UTMStack look

Click Restore UTMStack defaults on the Branding page. This removes your product name, colour and images ("Branding restored to the UTMStack defaults").

To hide your brand only for a while, switch off Enable white-labeling and click Save changes; your settings and images stay stored.

Branding and the licence

Your brand is shown only while white-labelling is switched on and the server has a valid Enterprise licence. If the licence expires, UTMStack shows its own look again, and your settings return when a valid licence is installed. See License and Editions.

Troubleshooting

MessageCauseFix
The page shows only "White-labelling is an Enterprise feature"No valid Enterprise licenceInstall the licence.
"Could not upload image"The image is larger than 5 MB, or it is not a PNG, JPEG, WEBP, GIF, SVG or ICO file (the server checks the content, not only the name).Make the image smaller, or export it again in one of the allowed formats.
"Could not save branding"Your roles lack config.write, or the licence is not EnterpriseAsk an administrator, or install the licence.

If the browser tab still shows the old icon after you change the favicon, reload the page while bypassing the cache (for example Ctrl+Shift+R), because browsers keep favicons for a long time.

Branding and tenants

On a multi-tenant licence, each tenant has its own branding. A tenant administrator can brand their own tenant from the same page. A tenant that has not set up branding shows the standard UTMStack look; it does not take the operator's branding.

Branding at installation

UTMStack partners can also ship an installer with a built-in brand: a branding folder with a brand.yaml file and image files, placed next to the installer, sets the product name shown by the installer and the starting branding of the server. A LICENSE file placed next to the installer is installed as the licence.