Skip to main content

Default theme

As a reseller or managed service provider (MSP), you can rebrand your organization in the Virtana Platform by customizing colors, logos, and the favicon. Branding changes apply to the platform UI, all outbound emails, and any associated sub-organizations or departments.

The following elements update when you apply a new theme:

  • Login page, header bar, and Virtana branding areas: reflect the updated UI color and logo.

  • Browser tabs: display the updated favicon across all tabs.

  • Emails: show the updated email logo in place of the default Virtana logo, including report emails, password recovery emails, and other platform-generated messages.

For more information about themes and white-labeling, see Themes for white-labeling.

On-premises deployments

In an on-premises environment, you can update the default theme to match your branding and compliance requirements. You can customize the favicon, logos, and browser tab name. After you update the default theme, the login page reflects your changes immediately. All newly created child organizations inherit the updated theme automatically.

Important

Updating the default theme is an admin-only feature that requires direct access to an on-premises deployment.

Update the default theme

The following procedure describes how to update the default theme using the update_default_theme.sh script. Before you begin, prepare the following files:

  • Email logo file

  • Favicon file

  • Logo file

To update the default theme, perform the steps:

  1. Copy your branding files to the branding service pod's temporary directory. Replace logo_file_path and branding_service_pod with your actual file path and pod name:

    kubectl -n controlplane cp <logo_file_path> <branding_service_pod>:/tmp

    Repeat this command for each file (email logo, favicon, and logo).

  2. Open a shell session inside the branding service pod. Replace branding_service_pod with your pod name:

    kubectl -n controlplane exec -it <branding_service_pod> -- sh

  3. Navigate to the update script directory:

    cd scripts/update_default_theme

  4. Grant execute permission to the script:

    chmod +x update_default_theme.sh

  5. Run the script with your branding file paths and tab name. Replace each placeholder with the actual path and name:

    sh update_default_theme.sh <email_logo_file_with_path> <favicon_logo_file_with_path> <logo_file_with_path> <tab_name>

    The table below describes each script parameter:

    Table 130.

    Parameter

    Description

    <email_logo_file_with_path>

    Full path to the email logo file inside the pod, for example /tmp/email_logo.png . This logo appears in all platform-generated emails.

    <favicon_logo_file_with_path>

    Full path to the favicon file inside the pod, for example, /tmp/favicon.ico . This icon appears in browser tabs.

    <logo_file_with_path>

    Full path to the main logo file inside the pod, for example, /tmp/logo.png . This logo appears on the login page and in the header bar.

    <tab_name>

    The text that appears in the browser tab title, for example, My Company Platform .



  6. Open the login page for your installation and confirm that the updated logo, favicon, and tab name are displayed correctly.

In this section: