Download

Custom Branding Guide

Preface

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

History

Version Date Comments
1.5 2017-11-03 Upgrades for 2.5
1.4 2017-07-18 Reformatting
1.3 2017-03-07 Add details about OAS Windows server desktop
1.2 2016-01-12 Add details about OAS Linux server desktop
1.1 2016-02-23 Published the Inuvika OVD Custom Branding Guide

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.

Pre-requisites

A Subscription key must be installed using the Administration Console. 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

Logos

Custom Image Specifications

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

Small Logo Image
  • Format: PNG
  • Height: 80px
  • Width: 141px
  • Location: /usr/share/ovd/web-access/media/custom
Small Logo Image for Portal mode
  • Format: PNG
  • Height: 80px
  • Width: 141px
  • Location: /usr/share/ovd/web-access/media/custom
Large Logo Image
  • Format: PNG
  • Height: 182px
  • Width: 320px
  • Location: /usr/share/ovd/web-access/media/custom

Applying Custom Branding

Logos

A custom CSS file called custom.css is required to enable custom branding of logos. This file will define two classes for which you will specify the locations and dimensions of your custom images. These class definitions will then be used to override the pre-existing definitions. The logos must be placed with the custom.css file.

File Location

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

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

Classes

The custom.css will define the image_logo-small_png, image_logo-small-w_png and image_logo_png class selectors.

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;
}

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.