Download

Enterprise Clients Guide

Preface

This document describes the Inuvika Enterprise Clients which allow a user to start an OVD session from their desktop or mobile device.

History

Version Date Comments
1.12 2018-05-15 Updates for OVD 2.6, including information for using the EMC with ChromeOS
1.11 2017-11-15 Updates for OVD 2.5, including information for Ubuntu 16.04, added systray setting.
1.10 2017-09-01 Fix minor mistakes in installation instructions
1.9 2017-07-18 Updates for OVD 2.4; Reformatting
1.8 2017-02-06 Updates for OVD 2.3
1.7.3 2017-10-16 Updates for OVD 2.2
1.7.2 2016-11-24 Minor changes (JSON syntax validation, multi-monitor)
1.7.1 2016-11-03 Minor changes
1.7 2016-10-24 Update regarding Standalone archive
1.6 2016-09-16 Add information about the network-auto-detect parameter in EDC 2.1
1.5 2016-07-14 Update for EDC 2.0
1.4.1 2016-05-24 Update regarding supported OS
1.4 2016-01-06 Update for OVD 1.4
1.3 2015-1110 Update the paths for OVD 1.3
1.2 2015-08-13 Update the paths
1.1.1 2015-08-06 Update for RHEL/CentOS
1.1 2015-07-15 Initial version

Introduction

This document describes the Inuvika Enterprise Clients which allow a user to start an OVD session from their desktop or mobile device. Inuvika provides an Enterprise Desktop Client (EDC) for Windows, macOS and Linux as well as an Enterprise Mobile Client (EMC) for Android and iOS devices. The information in this document is based on the latest release of Inuvika OVD and subsequent releases. If any of the information requires updating as a result of a future change in behavior, the document will be updated and re-released.

Pre-requisites

Inuvika OVD Enterprise and a valid Subscription Key are required to use any of the Enterprise Clients.

Overview

The EDC is a standalone application that can be used instead of a browser to provide a tighter integration with the platform on which it is running. The EDC allows users to run an OVD session in either Desktop or Application mode. Application mode provides a seamless interaction with the applications published by OVD on the user's device. This mode also offers a local integration feature that combines the user's locally installed applications with the applications published by OVD. Similarly, the EMC is a standalone application that can be used instead of a browser on mobile devices powered by iOS and Android. It provides a platform specific user interface that enhances the user interaction with OVD applications. The EMC provides desktop mode only on mobile devices.

Requirements

EDC clients are provided for platforms running:

  • Microsoft Windows 7, 8, 8.1 and 10. (x86 or x86-64)
  • Apple macOS 10.09 and up
  • Linux Desktop (x86 or x86-64)

The recommended configuration is based on running RemoteFX with a Windows 2016 Application Server.

  • A CPU with 2 cores and a clock speed of 2.2 GHz or higher
  • 1 GB RAM
  • 100 MB of free disk space

If only Linux Application Servers are used, then the CPU requirements can be reduced.

EMC clients are provided for platforms running:

  • Apple iOS 9.0+ armv7, arm64
  • Android 2.3.3+ armv7, arm64, x86, x86-64
  • ChromeOS 61+1 armv7, arm64, x86, x86-64

Enterprise Desktop Client

The EDC is available for all versions of Microsoft Windows from, and including, Windows 7. The EDC can also be installed on macOS Maverick and higher and on all Linux platforms based on x86 or AMD64. The most recent EDC software can be downloaded from the Inuvika archive at https://archive.inuvika.com/ovd/latest/.

Installing the EDC on Windows

Inuvika provides an installation program to install the EDC on Windows platforms. The installation is performed by running the downloaded installation program and following the prompts.

Installing the EDC on macOS

Inuvika provides an installation program as a dmg file for the EDC on macOS platforms.

Due to the Apple Gatekeeper mechanism, the following message may appear: "Your security preferences allow installation of only apps from the Mac App Store and identified developers". In this case, you need to adjust the Gatekeeper options. Gatekeeper options are found in the System Preferences > Security & Privacy > General tab under the heading Allow applications downloaded from: and choose Anywhere.

To install, double-click the downloaded dmg file to mount it. A new Finder window showing the contents of the mounted volume will appear. Drag the app icon to the Applications folder displayed. The installation is now complete.

Installing the EDC on Linux

The EDC can only be installed on a 64-bit operating system via the online package. The standalone archive file described below can be used if a 32-bit operating system is installed.

Note

The standalone archive may not be fully supported by the Linux distribution used if so feel free contact the Inuvika Support.

Ubuntu LTS

Inuvika provides an online installation mechanism for Debian-based systems using the standard installation tools for Debian systems. To install the EDC using the Debian package follow the instructions below:

  • Edit the /etc/apt/sources.list.d/ovd.list file and add these lines:

    • For Ubuntu 16.04 LTS (Xenial Xerus):

      deb http://archive.inuvika.com/ovd/latest/ubuntu xenial main
    • For Ubuntu 14.04 LTS (Trusty Tahr):

      deb http://archive.inuvika.com/ovd/latest/ubuntu trusty main
  • Install the keyring package to validate the repository using gpg by using the command:

    # wget -O- "http://archive.inuvika.com/ovd/latest/keyring" | apt-key add -
  • Update the package database:

    # apt-get update
  • Install the inuvika-ovd-enterprise-desktop-client package:

    # apt-get install inuvika-ovd-enterprise-desktop-client

RHEL/CentOS 7

Inuvika provides an online installation mechanism for the RPM packaging system used by RHEL and CentOS. To install the EDC using the RPM package follow the instructions below:

  • The first step is to configure yum to enable the Inuvika RPM repository. Create the file /etc/yum.repos.d/ovd.repo using the following commands:

    [ovd]
    name=Inuvika OVD
    baseurl=http://archive.inuvika.com/ovd/latest/rhel/7/
    enabled=1
    gpgcheck=1
    gpgkey=http://archive.inuvika.com/ovd/latest/keyring
  • Add the repository which provides QT5 support:

    # yum install http://download.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
  • Install the inuvika-ovd-enterprise-desktop-client package:

    # yum install inuvika-ovd-enterprise-desktop-client

Standalone archive file

Inuvika also provides a compressed archive for Linux that can be downloaded from the Inuvika OVD software archive and extracted to the user's home directory.

# tar xzvf Inuvika-OVD-X.X-Enterprise-Desktop-Client.tar.gz
  • Rename the directory:

    # mv Inuvika-OVD-X.X-Enterprise-Desktop-Client EDC
  • The EDC can be run by using the following command:

    # EDC/OVDEnterpriseDesktopClient

Settings

The default settings displayed upon starting the EDC include the following parameters:

  • Server: The IP or FQDN of the Session Manager. If you are using the Enterprise Secure Gateway, enter the IP or FQDN of the Enterprise Secure Gateway. The EDC can also be used to login directly to a Windows OAS by using the RDP protocol without going through the OSM. Enter the address of the Windows OAS in the format rdp://user:pass@server:port.
  • Login: The login id to be used.
  • Password: The associated password.
  • Remember me: if the checkbox is selected, the current configuration is saved in a configuration file, or the Microsoft registry if using Windows.

By default, the EDC allows additional configuration parameters to be set by the user by clicking the Advanced options button in the main EDC window. The following options will be displayed:

  • Mode: This option allows you to select which session mode you would like to use.
    • Application: The client will display a window with a list of the published OVD applications. The applications will be presented to the user as though they were running on the local machine.
    • Desktop: The client will display a full desktop with OVD applications integrated within it.
  • Resolution: Choose which screen resolution will be used. This setting is valid for desktop sessions only.
  • Auto-publish shortcuts: Select this option if you would like to have shortcuts for the published OVD applications created on your local desktop at the start of the session. This option applies only when using the application mode.
  • Automatic network detection: By default, the network connection capabilities will be detected automatically. However, if you want to use RemoteFX with a Windows Server Application Server, this option should be unchecked and the corresponding option in the Administration Console selected to enable RemoteFX.
  • Language: This option allows you to select which language your OVD session will use.

The appearance and functionality of the User Interface for the login screen can be modified by specifying various parameters in a configuration file as described in the next section.

EDC Configuration File

A pre-defined configuration file may be provided for the EDC that can be used to enable or disable various parts of the login UI. The possible settings are:

  • server: IP or FQDN for the Session Manager. If you are using the Enterprise Secure Gateway, use its IP or FQDN. A custom port can be added using the following syntax: IP_OR_FQDN:PORT.
  • login: the login you would like to use.
  • mode: the session mode can application or desktop.
  • width: specifies the width in pixels for the desktop window.
  • height: specifies the height in pixels of the desktop window.
  • fullscreen: specifies to start the desktop session in fullscreen mode.
  • maximized: set to false by default. If set to true, the screen size will be set to fullscreen while also allowing space for the toolbar or command bar.
  • autopublish: set to true by default. For application mode only, if set to true, the EDC will create shortcuts for the published OVD applications on the Desktop and also associate OVD applications with files based on the file type.
  • systray: set to true by default. For application mode only, when set to true, a systray is shown on the system toolbar that allows you to show the applications list and close the EDC if needed.
    • note: set to false with Unity (Ubuntu Desktop) in order to prevent an issue with the systray management done by the Window manager.
  • language: specifies the language to use based on the IETF language code.
  • autosave: set to false by default. If set to true, the EDC will operate as though the Remember me checkbox has been selected.
  • unicode-keyboard: enables unicode keyboard support
  • grab-keyboard: set to false by default. If set to true, the EDC will take control of the keyboard. This means that any key or key combination will be redirected to the OVD session. This includes OS specific key combination such as Alt+Tab or Command+Tab.
    • Limitation: using this setting means that all key combinations entered on the client side will be sent to the remote desktop. That means it is not recommended to use this setting when using local IME.
  • disable-static-shares: set to false by default. If true, local folders such as Desktop and Documents are not redirected to the RDP session. Only USB drives can be seen in the session if enabled in the Session Manager. This setting may be particularly useful when the EDC is installed on a thin client device.
  • log: specifies the logging level. Possible levels are:
    • 1: Debug
    • 2: Info
    • 3: Warn
    • 4: Error
  • console-log: logging will be redirected to standard error if set to true.
  • rdp-client: specifies the RDP client to use. Must be freerdp for normal use.
  • hide-advanced: set to false by default. If set to true, the Advanced options UI will be disabled so the user cannot modify the associated settings.
  • hide-remember-me: set to false by default. If set to true, the Remember me checkbox will not be displayed so the user cannot modify the setting in the default configuration file.
  • hide-session-manager: set to false by default. If set to true, the Server input field will not be displayed so the user cannot modify the value in the default configuration file.
  • toolbar: when a certain key combination is pressed, the EDC will display a toolbar with some shortcuts for toggling the Unicode keyboard, grabbing/releasing the keyboard, and logging out. The default key combination is Ctrl+Alt+Meta+Esc. Any other key combination can be specified, such as CTRL+ALT+T for example.
    • This setting does not work on macOS machines due to technology limitations with the Operating System.
  • jpeg: True by default. Informs the Linux ApS that the client can handle jpeg encoding. Normally does not need to be modified.
  • network-auto-detect: True by default which will enable automatic network detection. If set to false, then if the session has been configured to use RemoteFX via the Session Manager settings, a LAN connection will be specified. If the session has not been configured to use RemoteFX, a WAN connection will be specified.
  • h264: reserved for future use.
  • cpassword: this value is user specific, for internal use only. Do not distribute this value in the default configuration file.

By default, the configuration settings are stored as follows, depending on the system being used:

  • Windows: The configuration data is stored in the registry. The EDC reads the HKEY_LOCAL_MACHINE first and then the HKEY_CURRENT_USER tree. The path to the registry data is Software\ovd\client.

    The boolean settings should be represented as a DWORD key where '1' and '0' equal true and false respectively.

    Alternatively, the configuration can also be set in a json file located in %LOCALAPPDATA%\ovd\client\config.json. This file will take precedence over the registry settings.

  • macOS: The configuration file is located in ~/Library/ovd/client/config.json

  • Linux: The configuration file is located in ~/.config/ovd/client/config.json

If the json configuration file is not found in the default location, the EDC will then search in the current working directory and then the application folder for a configuration file.

Warning

The json file must be validated before using it. This can be done by using an online syntax validator. Some examples of validators available online are http://jsonlint.com/ or http://codebeautify.org/jsonvalidator

Logs

The log files are located on specific places depending on the Operating System.

  • On Windows: %LOCALAPPDATA%\ovd\client
  • On macOS: ~/Library/ovd/client
  • On Linux: ~/.config/ovd/client

Command line

It is possible to pass the majority of the configuration through command line arguments in the following way:

# ovd-edc -width 1200 -height 800 -mode desktop -login paul

To display a list of the possible arguments, use the -help option.

Single Sign-On

On a Microsoft Windows client with an Active Directory domain user, it is possible to enable Single Sign-on (SSO) to OVD using the local credentials. For further information, please refer to the document Single Sign-On with Microsoft Active Directory using Kerberos.

Printing

Printing with redirected printers uses the default printer settings. Currently, there is no support to manage the printer settings from an OVD session. This means that the printer settings required must be set as the default settings on the redirected printer. For example, if you wish to print in color, the default printer setting must be set to Color. During the print processing, a pdf file is generated by OVD and transmitted to the redirected printer. So if the printer is configured to only print in black & white and the actual print request has been defined to use color printing in the OVD session, the pdf file will be printed in black & white.

Multi-monitor

The multi-monitor feature allows users to start an OVD session across all the available screens on their machine when full screen mode is selected. This setting (available on the OVD Administration Console) is only supported by the Enterprise Desktop Client when connecting to a Windows desktop session. A maximum of four screens are supported. The cursor position indicates where the session will start so place it on whichever screen you would prefer it to start on while the session is initializing.

Enterprise Mobile Client

Installing the EMC

The EMC is available on Google Play for Android and the App Store for iOS. For further information, please check the Google Play and App Store sites.

To connect to OVD, the following fields must be entered:

  • Login
  • Password
  • Session Manager: IP:PORT (if not specified the default port used will be 443)

Using the EMC with ChromeOS

The EMC can be used with any Chromebook compatible with Android applications1.

Once you have a Chromebook, do the following to enable the Google Play Store:

  • Update your Chromebook software so it is at version 61 or higher
  • Sign into the Google Play Store

    • Click your account photo
    • Click Settings
    • Go to the "Google Play Store" section and turn on Enable Google Play Store on your Chromebook.

    Note: If you don't see this option, your Chromebook is not compatible with Android applications.

    • Follow the instructions to sign into your Google account
    • When you are done, the Google Play Store application will open. Click Accept to finish.

Once the Google Play Store application has been installed, open it and search for "inuvika" and install the EMC application. When it is successfully installed, it will work the same way as it would on an Android device (i.e. follow Android settings documentation below).

Settings for Android

The EMC provides the following settings for the Android platform:

  • Hide session manager in login screen: The Session Manager field, normally presented in the login screen, is not displayed. The Session Manager details are stored for re-use.
  • Session manager URL (visible if the previous setting is disabled): IP or FQDN for the Session Manager. If you are using the Enterprise Secure Gateway, use its IP or FQDN. A custom port can be added using the following syntax: IP_OR_FQDN:PORT
  • Save the password: Allows the user to save the password on his device.
  • Fullscreen: Enable or disable fullscreen mode. In fullscreen mode, the Android UI controls are hidden.
  • Manual resolution: Allows the user to set the resolution manually
  • Session resolution: When the Manual resolution setting is enabled, you can also set the screen dimensions to be used for the OVD session.
  • Force wide screen: Enforce usage of the wide screen resolution.
  • Adapt resolution: If 'Force wide screen' is not enabled, the session will automatically rotate and resize.
  • Dim system bar: If enabled, the system tray (with clock) is dimmed on the desktop.
  • Enhanced keyboard: If enabled, predictive text for the keyboard is enabled.
  • RDP Compression: Enabling compression may provide better bandwidth utilization.
  • Connection type: Select the connection type that best reflects the actual available bandwidth.
    • Not specified (default)
    • Modem (56 Kbits/s)
    • Broadband Low (256 Kbits/s)
    • Satellite (2 Mbits/s)
    • Broadband High (10 Mbits/s)
    • WAN (10 Mbits/s)
    • LAN (100 Mbits/s)

Settings for iOS

The EMC provides the following settings for the iOS platform:

  • Save the password: Allows the user to save the password on your device.
  • Use native resolution: Enforces usage of the native resolution of your device.
  • Force Landscape: Enforces landscape mode while in an OVD session.
  • Adapt resolution: If 'Force Landscape' is not enabled, the session will automatically rotate and resize.
  • RDP Compression: Enabling compression may provide better bandwidth utilization.
  • Connection type: Select the connection type that best reflects the actual available bandwidth.
    • Not specified (default)
    • Modem (56 Kbits/s)
    • Broadband Low (256 Kbits/s)
    • Satellite (2 Mbits/s)
    • Broadband High (10 Mbits/s)
    • WAN (10 Mbits/s)
    • LAN (100 Mbits/s)

  1. For a list of compatible ChromeOS devices, see here: https://www.chromium.org/chromium-os/chrome-os-systems-supporting-android-apps