Skip to content

Custom Branding Guide

Last updated on Oct 05 2023.

OVD version restrictions

This document is deprecated for OVD versions 3.3 and later. They will be removed in a future version of OVD.

As an alternative, use the new Client Customization configuration page, which allows a more simple configuration on a per-tenant basis.

Preface

This document describes how to configure OVD to use your custom branded images in place of the Inuvika brand.

Introduction

This document describes the functionality and configuration of custom branding options in OVD.

Overview

In OVD, a customer may use their own images to customize branding within the web client for the login and logout screens, and the session activation and deactivation screens. The desktop wallpaper on the OVD Application Server may be customized for all clients. Modifying the Inuvika branding requires PNG files of specific dimensions and a custom style sheet (CSS) to enable correct display of the images for the customer branding.

Prerequisites

The OVD Web Access is installed and running.

Custom branding is available for web browser based OVD clients. In this case, a customer may use their own images to customize branding within the web client for the login and logout screens, and the session activation and deactivation screens.

The desktop wallpaper on the OVD Application Server may also be customized and will be available to all clients.

Functionality

Once custom images are provided and the proper configuration steps are followed to apply them, all Inuvika branding will be replaced by the custom branding. The logo images within the login and logout screens, and the session activation and deactivation screens will be replaced by the custom logo images and the desktop wallpaper for the OVD Application Server will be set by default to the custom desktop image.

Inuvika Attribution

When custom branding is applied, Inuvika is given attribution through the appearance of a "Powered by Inuvika" statement in the bottom right of the desktop.

Setup & Configuration

OVD Web Access

The OVD Web Access can be customized to use your own logos.

The custom configuration will be placed within /usr/share/ovd/web-access/media/custom. This directory must be created: 

#
mkdir -p /usr/share/ovd/web-access/media/custom

Logos

Custom branding for the web access requires three images: a small logo, a small logo for the Portal mode, and a large logo.

Format Height Width CSS class
Small Logo Image PNG 80px 141px image_logo-small_png
Small Logo Image for Portal mode PNG 80px 141px image_logo-small-w_png
Large Logo Image PNG 182px 320px image_logo_png

Drop the image files into the custom folder.

Then a custom.css file, in the same directory, is required to apply your logos. This file will define the three classes for which you will specify the locations of the image files.

Example:

.image_logo-small_png {
    background: url("customLogoSmall.png") no-repeat transparent;
}

.image_logo-small-w_png {
    background: url("customLogoSmall-w.png") no-repeat transparent;
}

.image_logo_png {
    background: url("customLogoLarge.png") no-repeat transparent;
}

The icon used during a web-access OVD session to open the top-menu can be changed to use more clear or bold icons.

Example:

#menuContainer_bottom {
  width: 80px;
  height: 20px;
}
#menuContainer_bottom .menu-down::before, #menuContainer_bottom .menu-up::before {
  content: "\1f4cb \1f5a8 \1f4be";
}

Document title

A custom JSON file called custom.json is required to enable a custom document title. The expected JSON data is an associative array containing a title key which has a non empty string for value.

Example:

{
    "title": "My custom title!"
}

Favicon

The document favicon can also be customized by pushing a favicon.png image into the custom folder.

The image format can be 16×16, 32×32, 48×48, or 64×64 pixels in size, and 8-bit, 24-bit, or 32-bit in color depth.

OVD User Configuration Access (OUC)

The OVD User Configuration component can be customized to override the following items:

  • Logo images, including the favicon
  • Document name and title
  • Colors and theme

The custom configuration must be placed within /usr/share/ovd/user-configuration/media/custom.

Start from example

When the User Configuration component is installed, it contains an example folder that can be used to simplify setup of your custom branding.

  1. Go to the OUC's media folder 

    #
    cd /usr/share/ovd/user-configuration/media

  2. Copy the example folder 

    #
    cp -R custom-example custom

  3. Refresh your web browser

    You should see the custom branding activated

  4. Edit the custom.json file and start implementing your organization identity.

Desktop Wallpaper

The desktop wallpaper can be replaced on OVD Application Servers. In order to apply a custom wallpaper as the default, the Inuvika branded wallpaper must be replaced with the new one.

Windows OAS

On each OVD Application Server involved, navigate to C:\ProgramData\OVD\slaveserver. This folder will contain the Inuvika wallpaper, ovd-wallpaper.jpg. This wallpaper can be renamed and the custom branded wallpaper should be moved here and renamed to ovd-wallpaper.jpg.

The format must be a jpg file with the specification of 1024px width and 768px height.

Linux OAS

On each OVD Application Server involved, navigate to /usr/share/wallpapers. This folder will contain the Inuvika wallpaper, ovd-wallpaper.png. This wallpaper can be renamed and the custom branded wallpaper should be moved here and renamed to ovd-wallpaper.png.

The format must be a png file with the specification of 1024px width and 768px height.

Note

The custom wallpaper will revert to the Inuvika wallpaper again once an OVD update is applied. The above steps will need to be carried out again to restore the custom branding of the desktop.