NICE DCV
Administrator Guide
NICE DCV: Administrator Guide
Copyright © Amazon Web Services, Inc. and/or its affiliates. All rights reserved.
Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.
Table of Contents
What Is NICE DCV? ... 1
How NICE DCV Works ... 1
Features ... 1
Pricing ... 2
NICE DCV Servers ... 3
Requirements ... 3
Supported Features ... 4
Setting up ... 6
Installing ... 6
Windows ... 6
Linux ... 10
Licensing ... 34
NICE DCV licensing requirements ... 34
Installing an extended evaluation license ... 36
Installing a production license ... 37
Updating the production license ... 44
Upgrading ... 44
Compatibility considerations ... 45
Upgrading the NICE DCV Server on Windows ... 45
Upgrading the NICE DCV Server on Linux ... 45
Uninstalling ... 45
Uninstalling the NICE DCV Server on Windows ... 46
Uninstalling the NICE DCV Server on Linux ... 46
Managing the Server ... 48
Starting the Server ... 48
Starting the server on Windows ... 48
Starting the server on Linux ... 49
Stopping the server ... 49
Stopping the server on Windows ... 49
Stopping the server on Linux ... 50
Enabling QUIC UDP ... 50
Changing the TCP/UDP ports and address ... 51
Changing the server TCP/UDP ports ... 52
Listening on specific endpoints ... 53
Managing the TLS certificate ... 54
Disconnecting idle clients ... 55
Changing the idle timeout period on Windows ... 56
Changing the idle timeout period on Linux ... 56
Enabling GPU sharing on Linux ... 57
Enabling touchscreen and stylus support ... 58
Configuring a stylus ... 59
Enabling gamepad support ... 60
Supporting Xbox 360 controllers ... 60
Enabling USB remotization ... 61
Adding devices to an allow list on Windows ... 61
Adding devices to an allow list on Linux ... 62
Configuring smart card caching ... 62
Enabling session storage ... 63
Enabling session storage on Windows ... 63
Enabling session storage on Linux ... 64
Configuring the printer on Linux ... 65
Troubleshooting printer issues ... 66
Configuring the clipboard on Linux ... 66
Pasting client clipboard content to the primary selection ... 67
Copying primary selection content to the client clipboard ... 67
Configuring multi-channel audio ... 68
Configuring the audio channels on Windows NICE DCV servers ... 69
Configuring the audio channels on Linux NICE DCV servers ... 69
Configuring the HTTP headers ... 70
Configuring HTTP headers on a Windows NICE DCV Server ... 70
Configuring HTTP headers on a Linux NICE DCV Server ... 71
Configuring authentication ... 71
Configuring authentication on Windows ... 72
Configuring authentication on Linux ... 73
Configuring authorization ... 74
Default permissions file ... 74
Custom permissions file ... 74
Working with permissions files ... 74
Managing sessions ... 79
Introduction to NICE DCV sessions ... 79
Console sessions ... 79
Virtual Sessions ... 80
Using the Command Line Tool to Manage Sessions ... 80
Using the command line tool on a Windows NICE DCV Server ... 80
Using the command line tool on a Linux NICE DCV Server ... 81
Starting sessions ... 81
Manually starting console and virtual sessions ... 81
Enabling Automatic Console Sessions ... 85
Stopping Sessions ... 86
Syntax ... 82
Example ... 86
Managing running sessions ... 86
Managing session storage ... 86
Managing session authorization ... 87
Managing the session display layout ... 89
Managing the session name ... 90
Viewing sessions ... 92
List all active sessions ... 92
View information about a specific session ... 92
Getting screenshots ... 93
Syntax ... 82
Options ... 82
Examples ... 95
How To.. ... 96
Use External Authentication ... 96
NICE DCV Server Configuration ... 96
Using the Token ... 97
Authentication service requirements ... 97
Find and Stop Idle Sessions ... 98
Enable Remote X Connections to the X Server ... 99
Enable Remote X Connections to the X Server ... 99
Embed the NICE DCV web browser client inside an iFrame ... 100
Troubleshooting ... 102
Using the Log Files ... 102
Changing Log File Verbosity on Windows ... 102
Changing Log File Verbosity on Linux ... 103
Troubleshooting Virtual Session Creation on Linux ... 103
Investigating Virtual Session Creation Failure on Linux ... 103
Creating a Failsafe Virtual Session on Linux ... 104
Linux Sessions fail to start after UID change ... 105
Fixing Cursor Issues on Windows ... 105
Fixing Copy and Paste to IntelliJ IDEA ... 106
Parameter Reference ... 107
audio Parameters ... 107
clipboard Parameters ... 108
connectivity Parameters ... 110
display Parameters ... 113
display/linux Parameters ... 117
input Parameters ... 118
license Parameters ... 118
log Parameters ... 119
security Parameters ... 120
session-management Parameters ... 125
session-management/automatic-console-session Parameters ... 128
session-management/defaults Parameters ... 129
smartcard Parameters ... 129
webcam Parameters ... 130
windows Parameters ... 130
Modifying Configuration Parameters ... 131
Windows NICE DCV Servers ... 131
Linux NICE DCV servers ... 132
NICE DCV end of support life ... 133
EOSL timeline ... 133
EOSL paths for customers ... 133
EOSL FAQs ... 134
Release notes and document history ... 135
Release Notes ... 135
NICE DCV 2022.0-11954 ... 136
NICE DCV 2021.3-11591 ... 136
NICE DCV 2021.2-11445 ... 137
NICE DCV 2021.2-11190 ... 137
NICE DCV 2021.2-11135 ... 138
NICE DCV 2021.2-11048 ... 138
DCV 2021.1-10851 ... 139
DCV 2021.1-10598 ... 140
DCV 2021.1-10557 ... 140
DCV 2021.0-10242 ... 141
DCV 2020.2-9662 ... 141
DCV 2020.2-9508 ... 142
DCV 2020.1-9012 ... 142
DCV 2020.1-9012 ... 143
DCV 2020.1-8942 ... 143
DCV 2020.0-8428 ... 144
DCV 2019.1-7644 ... 144
DCV 2019.1-7423 ... 145
DCV 2019.0-7318 ... 145
DCV 2017.4-6898 ... 146
DCV 2017.3-6698 ... 147
DCV 2017.2-6182 ... 148
DCV 2017.1-5870 ... 149
DCV 2017.1-5777 ... 150
DCV 2017.0-5600 ... 150
DCV 2017.0-5121 ... 150
DCV 2017.0-4334 ... 151
DCV 2017.0-4100 ... 151
Document history ... 151
How NICE DCV Works
What Is NICE DCV?
NICE DCV is a high-performance remote display protocol. It lets you securely deliver remote desktops and application streaming from any cloud or data center to any device, over varying network conditions.
By using NICE DCV with Amazon EC2, you can run graphics-intensive applications remotely on Amazon EC2 instances. You can then stream the results to more modest client machines, which eliminates the need for expensive dedicated workstations.
Topics
• How NICE DCV Works (p. 1)
• Features of NICE DCV (p. 1)
• NICE DCV Pricing (p. 2)
How NICE DCV Works
To use NICE DCV, install the NICE DCV server software on a server. The NICE DCV server software is used to create a secure session. You install and run your applications on the server. The server uses its hardware to perform the high-performance processing that the installed applications require. Your users access the application by remotely connecting to the session using a NICE DCV client application.
When the connection is established, the NICE DCV server software compresses the visual output of the application and streams it back to the client application in an encrypted pixel stream. The client application receives the compressed pixel stream, decrypts it, and then outputs it to the local display.
Features of NICE DCV
NICE DCV offers the following features:
• Shares the entire desktop — Uses the high-performance NICE DCV protocol to share full control of the entire remote desktop.
• Transport images only — Transports rendered images as pixels instead of geometry and scene information. This provides an additional layer of security as no proprietary customer information is sent over the network.
• Supports H.264-based encoding — Uses H.264-based video compression and encoding to reduce bandwidth consumption.
• Supports lossless quality video compression - Supports lossless quality video compression when the network and processor conditions allow.
• Matches display layouts — Automatically adapts the server's screen resolution and display layout to match the size of the client window.
• Supports multi-screen — Lets you expand the session desktop across up to four monitors.
• Adapts compression levels — Automatically adapts the video compression levels based on the network's available bandwidth and latency.
• Enables collaboration — Provides dynamic sessions that support multiple collaborative clients. Clients can connect and disconnect at any time during the session.
• Supports multiple sessions per server (Linux NICE DCV servers only) — Supports multiple virtual sessions per Linux NICE DCV server to maximize cost savings.
• Supports GPU sharing (Linux NICE DCV servers only) — Lets you share one or more physical GPUs between multiple virtual sessions running on a Linux NICE DCV server.
Pricing
• Supports touch input, stylus input, and gamepads — Lets you use you interact with a remote NICE DCV session using input devices attached to your local computer.
• Supports USB and Smart Card, and stylus remotization — Lets you use your peripherals in a NICE DCV session just like you would on your local computer.
• Supports audio in and out, printing, and copy and paste — Lets you perform these key actions between the session and your local computer.
• Supports file transfer — Lets you transfer files between the session and your local computer.
• Provides an HTML5 client - Offers an HTML5 client that can be used with any modern web browser on Windows and Linux.
• Supports modern Linux desktop environments — Supports modern Linux desktops, such as Gnome 3 on RHEL 8.
NICE DCV Pricing
There is no additional charge for using the NICE DCV server on an Amazon EC2 instance. You pay the standard rates for the instance and other Amazon EC2 features that you use.
A license is required to install the NICE DCV server on an on-premises or alternative cloud-based server.
For more information, see Licensing the NICE DCV Server (p. 34).
Requirements
NICE DCV Servers
The NICE DCV server is available for Windows and Linux. Both servers offer similar features, but there are some differences. Choose the NICE DCV server that best meets your needs. The following table compares the features supported by the Windows and Linux NICE DCV servers.
Topics
• Requirements (p. 3)
• Supported Features (p. 4)
Requirements
For a good user experience with NICE DCV, ensure that your server meets the following minimum requirements. Keep in mind that your users' experience is largely dependent on the number of pixels streamed from the NICE DCV server to the NICE DCV client.
If you are installing the NICE DCV server on an Amazon EC2 instance, we recommend that you use an Amazon EC2 G3, G4dn, or G4ad instance type. These instance types offer GPUs that support hardware- based OpenGL and GPU sharing. For more information, see Amazon EC2 G3 Instances and Amazon EC2 G4 Instances. You can install the NICE DCV server on any other instance type, but there might be screen resolution limitations. To bypass this limitation, download and install the NICE DCV Virtual Display Driver for EC2.
Your server must meet the minimum requirements listed in the following table.
Windows server Linux server
Operating
system • Windows 8.1
• Windows Server 2012 R2
• Windows 10
• Windows Server 2016
• Windows Server 2019
Note
All supported Windows operating systems require .NET Framework 4.5 and must support the x86-64 architecture.• Amazon Linux 2
• CentOS 7.6 or later
• CentOS 8.x or CentOS Stream 8
• RHEL 7.6 or later
• RHEL 8.x
• SUSE Linux Enterprise 12 with SP3 or later
• SUSE Linux Enterprise 15
• Ubuntu 18.04
• Ubuntu 20.04
Supported
architecture 64-bit x86 • 64-bit x86
• 64-bit ARM (supported with Amazon EC2 instances running Amazon Linux 2, CentOS 7.x/8.x, RHEL 7.x/8.x, and Ubuntu 18.04 only)
GPU (Optional) An NVIDIA or AMD GPU is required for hardware-based video encoding. If your server does not have a GPU, software-based video encoding is used.
Supported Features
Windows server Linux server
Note
• NVIDIA GPUs require NVENC for hardware-based video encoding. On Ubuntu 20, an NVIDIA GPU with compute capabilities >= 3.5 is required.
• AMD GPUs require Advanced Media Framework (AMF) for Linux or Windows, or Rapidfire for Windows only, for hardware-based video encoding. For Linux, the AMF encoder can be used on Ubuntu instances by installing the additional package amf-amdgpu-pro provided by the AMD driver.
An NVIDIA GPU is required for GPU sharing
across virtual sessions.
Note
Only console sessions are supported on Linux servers with AMD GPUs.Network By default, the NICE DCV server communicates over port 8443. The port is configurable but must be greater than 1024. Ensure that the server allows communication over the required port.
For more information about the NICE DCV Client requirements, see NICE DCV Client requirements in the NICE DCV User Guide.
Supported Features
The following table compares the features that are supported by the Windows and Linux NICE DCV servers.
Feature Windows
NICE DCV server (p. 6)
Linux NICE DCV server (p. 10)
Console sessions (p. 79) ✓ ✓
Virtual sessions (p. 79) ✗ ✓
QUIC (UDP) transport protocol (p. 50) ✓ ✓
Configurable TCP/UDP ports and addresses (p. 51) ✓ ✓
Custom TLS certificates (p. 54) ✓ ✓
Idle client disconnection (p. 55) ✓ ✓
GPU sharing (p. 57) ✗ ✓
USB remotization (p. 61) ✓ ✓
Smart card support (p. 62) ✓ ✓
Webcam support ✓ (Windows 10
and Server 2016 and later)
✗
Supported Features
Feature Windows
NICE DCV server (p. 6)
Linux NICE DCV server (p. 10)
Session storage and file transfer (p. 63) ✓ ✓
Copying and pasting (p. 66) ✓ ✓
Custom HTTP headers (p. 70) ✓ ✓
Printing from sessions (p. 65) ✓ ✓
Stereo 2.0 audio playback (p. 68) ✓ ✓
Surround sound audio playback (p. 68) ✓ (up to 7.1) ✓ (up to 5.1)
Stereo 2.0 audio recording (p. 68) ✓ ✓
Touchscreen support (p. 58) ✓ (Windows 8.1
and Server 2012 and later)
✓
Stylus support (p. 58) ✓ (Windows 10
and Server 2019) ✓
Gamepad support (p. 60) ✓ (Windows 10
and Server 2016 and later)
✗
For more information about the NICE DCV Client features, see NICE DCV Client features in the NICE DCV User Guide.
Installing
Setting up the NICE DCV server
To use NICE DCV, install the NICE DCV server software on the server where you intend to host NICE DCV sessions. Make sure that the software is properly licensed.
The following topics describe how to install and license the NICE DCV server. The Licensing (p. 34) topic applies to installing on on-premises and on other cloud-based servers only. This is because no license is required to use the NICE DCV server on an Amazon EC2 instance.
Topics
• Installing the NICE DCV Server (p. 6)
• Licensing the NICE DCV Server (p. 34)
• Upgrading the NICE DCV Server (p. 44)
• Uninstalling the NICE DCV Server (p. 45)
Installing the NICE DCV Server
The following topics describe how to install the latest version of the NICE DCV server on Windows and Linux. Follow these steps if you're installing NICE DCV on an Amazon EC2 instance or other on-premises or cloud-based server.
Note
If you're upgrading from an earlier version of the NICE DCV server to the latest version, see Upgrading the NICE DCV Server (p. 44).Topics
• Installing the NICE DCV Server on Windows (p. 6)
• Installing the NICE DCV Server on Linux (p. 10)
Installing the NICE DCV Server on Windows
This section describes how to install the NICE DCV server on Windows.
Topics
• Prerequisites for Windows NICE DCV server on Amazon EC2 instances (p. 6)
• Installing the NICE DCV Server on Windows (p. 8)
Prerequisites for Windows NICE DCV server on Amazon EC2 instances
This topic describes how to configure your Windows Amazon EC2 instance before you install the NICE DCV server. If you're not installing the NICE DCV server on an Amazon EC2 Windows instance, skip these prerequisites.
Topics
• Prerequisites for accelerated computing instances (p. 7)
• Prerequisites for other instance families (p. 7)
Windows
Prerequisites for accelerated computing instances
Prerequisites for GPU graphics instances
If you're using a GPU graphics instance (for example, a G2, G3, G4dn, or G4ad instance), we recommend that you install and configure the appropriate NVIDIA or AMD GPU drivers. The GPU drivers allow for the following:
• DirectX and OpenGL hardware acceleration for applications
• Hardware acceleration for H.264 video streaming encoding
• Customizable server monitor resolutions
• Increased maximum resolution for server monitors— up to 4096x2160
• Increased number of server monitors
For instructions on how to install NVIDIA GPU drivers on your GPU graphics instance, see the following topics in the Amazon EC2 User Guide.
• For instances with an NVIDIA GPU (for example, a G2, G3, or G4dn instance), see Installing the NVIDIA Driver on Windows.
• For instances with an AMD GPU (for example, a G4ad instance), see Install AMD drivers on Windows instances.
For more information about Amazon EC2 G4ad instances, see the Deep dive on the new Amazon EC2 G4ad instances blog post.
Prerequisites for other accelerated computing instances
If you're using an accelerated computing instance that isn't a GPU graphics instance (for example a P2, P3, or P3dn instance), we recommend that you install and configure the appropriate NVIDIA GPU drivers.
The NVIDIA GPU drivers enable hardware acceleration for H.264 video streaming encoding.
For instructions on how to install NVIDIA GPU drivers on your accelerated computing instance, see Public NVIDIA Drivers in the Amazon EC2 User Guide for Windows Instances.
Installing the NVIDIA GPU drivers on an accelerated computing instance doesn't enhance server monitor limits or resolutions. To add the additional server monitor resolution support, you can install the NVIDIA GRID drivers. For more information, see NVIDIA vGPU Software on the NVIDIA website.
Prerequisites for other instance families
For instances other than accelerated computing instances, we recommend that you install the NICE DCV Virtual Display driver. This includes instances in the general purpose, compute-optimized, memory- optimized, and storage-optimized instance families.
Installing the NICE DCV Virtual Display driver enables the following:
• Support for up to four monitors
• Support for custom resolutions
• Support for 4K UHD resolution
You can't manage server monitors attached by the NICE DCV server using Windows Control Panel.
Note
The NICE DCV Virtual Display driver is supported on Windows Server 2016 and later.Windows
Important
Installing the NICE DCV Virtual Display driver with any other GPU drivers, such as NVIDIA GPU drivers, might cause conflicts. To avoid conflicts, we recommend that you don't install the NICE DCV Virtual Display driver in combination with any other GPU drivers.
To install the NICE DCV Virtual Display driver on your instance
1. Download the NICE DCV Virtual Display driver installer from the NICE DCV website.
2. To install the driver by running the wizard, open or double-click the installation file. Or, use the following command to run an unattended installation.
C:\> nice-dcv-virtual-display-x64-Release-38.msi /quiet /norestart 3. Reboot the instance, and then reconnect to it.
Installing the NICE DCV Server on Windows
You can use an installation wizard to install the NICE DCV server on a Windows host server. The wizard guides you through a series of steps that show how to customize your NICE DCV server installation.
Alternatively, you can use the command line to perform an unattended installation. This uses default settings to automate the installation procedure.
Contents
• Using the wizard (p. 8)
• Unattended installation (p. 9)
Using the wizard
Use the NICE DCV server installation wizard for a guided installation.
To install the NICE DCV server on Windows using the wizard
1. Launch and connect to the server on which to install the NICE DCV server.
2. Download the NICE DCV server installer from the NICE DCV website.
Note
The NICE DCV server is available only in a 64-bit version and supported on 64-bit Windows operating systems.
Tip
The latest packages page of the download website contains links that always point to the newest available version. You can use these links to automatically retrieve the newest NICE DCV packages.
3. Run nice-dcv-server-x64-Release-2022.0-version_number.msi.
4. On the Welcome screen, choose Next.
5. On the End-User License Agreement screen, read the license agreement. If you accept the terms, select the I accept the terms in the License Agreement check box, and then choose Next.
6. (Optional) configure which components will be installed by selecting items in the Components Selection screen. To mark a component for installation, select the item and choose Will be installed on local hard drive. To omit a component from the installation select the item and choose Entire feature will be unavailable.
7. On the DCV Service Configuration screen:
a. (Optional) To manually configure your server's firewall to allow communication over the required port, select No, I will manually configure my firewall later.
Windows
b. (Optional) To manually start the NICE DCV server after the installation, select No, I want to start a DCV Service manually. If you select this option, you can't start a console session automatically after the installation is complete. If you select this option, step 9 is skipped.
8. Choose Next.
9. On the DCV Session Management Configuration screen, specify the owner for the automatic console session. Or, to prevent the automatic console session from starting after the installation is complete, select No, I will create the session manually.
Note
Complete this step only if you previously chose to allow the server to start automatically.10. Choose Install.
Unattended installation
By default, the unattended installation does the following:
• Adds a firewall rule to allow communication over port 8443.
• Enables NICE DCV server auto-start.
• Creates an automatic console session.
• Sets the console session owner to the user who performs the installation.
You can override the default actions by appending the following options to the installation command:
• DISABLE_FIREWALL=1 — Prevents the installer from adding the firewall rule.
• DISABLE_SERVER_AUTOSTART=1 — Prevents the NICE DCV server from starting automatically after the installation.
• DISABLE_AUTOMATIC_SESSION_CREATION=1 — Prevents the installer from starting the automatic console session.
• AUTOMATIC_SESSION_OWNER=owner_name — Specifies a different owner for the automatic console session.
• ADDLOCAL=component_list — Adds elements to the set of elements to be installed.
• REMOVE=component_list — Removes elements from the set of elements to be installed.
Note
The REMOVE option is evaluated after the ADDLOCAL option. An element that's on both lists isn't installed.The component_list is a comma-separated list that can contain the following values:
• audioMicDriver: Microphone driver
• audioSpkDriver: Speaker driver
• printerDriver: Printer driver
• usbDriver: USB device remotization driver (Disabled by default)
• webcamDriver: Webcam driver
• gamepadDriver: Gamepad driver
• webClient: Web client
• ALL: All components
To install the NICE DCV server on Windows using an unattended installation
1. Launch and connect to the server that you intend to install the NICE DCV server on.Linux
2. Download the NICE DCV server installer from the NICE website.
Note
The NICE DCV server is available only in a 64-bit version and supported on 64-bit Windows operating systems.
3. Open a command prompt window and navigate to the folder where you downloaded the installer.
4. Run the unattended installer as seen in one of the following examples:
• Install default components:
C:\> msiexec.exe /i nice-dcv-server-x64-Release-2022.0-version_number.msi /quiet /norestart /l*v dcv_install_msi.log
• Install all components:
C:\> msiexec.exe /i nice-dcv-server-x64-Release-2022.0-version_number.msi ADDLOCAL=ALL /quiet /norestart /l*v dcv_install_msi.log
• Install a subset of components:
C:\> msiexec.exe /i nice-dcv-server-x64-Release-2022.0-version_number.msi
ADDLOCAL=audioMicDriver,audioSpkDriver,printerDriver,webcamDriver /quiet /norestart / l*v dcv_install_msi.log
Installing the NICE DCV Server on Linux
This section describes how to install the NICE DCV server on Linux.
Topics
• Prerequisites for Linux NICE DCV servers (p. 10)
• Install the NICE DCV Server on Linux (p. 20)
• Post-Installation checks (p. 32)
Prerequisites for Linux NICE DCV servers
NICE DCV enables clients to access a remote graphical X session on a Linux server. This provides access to the corresponding Linux desktop. NICE DCV supports two types of Linux desktop streaming: console sessions and virtual sessions. For more information about console and virtual sessions, see Managing NICE DCV sessions (p. 79).
This topic describes how to install the prerequisites required to use NICE DCV on a Linux server.
Contents
• Install a desktop environment and desktop manager (p. 11)
• Disable the Wayland protocol (GDM3 only) (p. 15)
• Configure the X Server (p. 16)
• Install the glxinfo utility (p. 16)
• Verify OpenGL software rendering (p. 17)
• Install GPU drivers for graphics instances (p. 17)
• Install XDummy driver for non-GPU instances (p. 19)
Linux
Install a desktop environment and desktop manager
Install a desktop environment and desktop manager to improve your experience with NICE DCV on a Linux server.
A desktop environment is a graphical user interface (GUI) that helps you to interact with the Linux operating system. There are several desktop environments, and NICE DCV works with many of them.
A desktop manager is a program that manages the user login screen, and starts and stops the desktop environment sessions and the X server.
The following tabbed content shows the steps for installing the default desktop environment and desktop manager on the supported operating systems.
RHEL 7.x/8.x and CentOS 7.x/8.x
The default desktop environment for RHEL 7.x/8.x and CentOS 7.x/8.x is Gnome3 and the default desktop manager is GDM.
To install and configure the desktop environment and desktop manager on RHEL 7.x/8.x and CentOS 7.x/8.x
1. Install the desktop environment and the desktop manager packages.
• RHEL 7.x/8.x and CentOS 8.x
$ sudo yum groupinstall 'Server with GUI'
• CentOS 7.x
$ sudo yum groupinstall "GNOME Desktop"
2. Update the software packages to ensure that the Linux server is up to date.
$ sudo yum upgrade 3. Reboot the Linux server.
$ sudo reboot
Amazon Linux 2
The default desktop environment for Amazon Linux 2 is Gnome3 and the default desktop manager is GDM.
To install and configure the desktop environment and desktop manager on Amazon Linux 2
1. Install the desktop environment and the desktop manager packages.
$ sudo yum install gdm gnome-session gnome-classic-session gnome-session-xsession
$ sudo yum install xorg-x11-server-Xorg xorg-x11-fonts-Type1 xorg-x11-drivers
$ sudo yum install gnome-terminal gnu-free-fonts-common gnu-free-mono-fonts gnu- free-sans-fonts gnu-free-serif-fonts
Linux
2. Update the software packages to ensure that the Linux server is up to date.
$ sudo yum upgrade 3. Reboot the Linux server.
$ sudo reboot
Ubuntu 18.x
For Ubuntu 18.x, the default desktop environment is Gnome3 and the default desktop manager is GDM3. With Ubuntu 18.x, GDM3 isn't currently supported with NICE DCV console sessions. For this reason, we recommend that you use the LightDM desktop manager if you plan to work with NICE DCV console sessions.
To install and configure the desktop environment and desktop manager on Ubuntu 18.x
1. Install the desktop environment and the desktop manager packages.$ sudo apt update
$ sudo apt install ubuntu-desktop
Install LightDM.
$ sudo apt install lightdm
2. Update the software packages to ensure that the Linux server is up to date.
$ sudo apt upgrade 3. Reboot the Linux server.
$ sudo reboot
Ubuntu 20.x
For Ubuntu 20.x, the default desktop environment is Gnome3 and the default desktop manager is GDM3. Depending on the session type that you run, you might need to configure the system differently.
• Console sessions
LightDM isn't currently supported with NICE DCV console sessions on Ubuntu 20.x. We
recommend that you use the GDM3 desktop manager if you plan to work with NICE DCV console sessions.
• Virtual Sessions
Because of a known GDM issue, virtual sessions can't work with GDM3 on Ubuntu 20.x. To make virtual sessions working correctly, you can adopt one of the following solutions:
• On servers that do not have a GPU, you can disable the desktop manager because it's not required to run virtual sessions. Configure the system to run in multi-user mode by running the following command before creating virtual sessions:
Linux
sudo systemctl isolate multi-user.target
• On servers with a GPU, in addition to disabling the desktop manager, you need to start an X server on the system before creating virtual sessions. To do this, run the following commands:
sudo systemctl isolate multi-user.target
sudo dcvstartx &
To install and configure the desktop environment and desktop manager on Ubuntu 20.x
1. Install the desktop environment and the desktop manager packages.$ sudo apt update
$ sudo apt install ubuntu-desktop
Install GDM3 (only works with console sessions)
$ sudo apt install gdm3
2. If you use GDM3, verify that GDM3 is set as the default desktop manager.
$ cat /etc/X11/default-display-manager
The output is as follows.
/usr/sbin/gdm3
If GDM3 isn't set as the default desktop manager, use the following command to set it as the default.
$ sudo dpkg-reconfigure gdm3
3. Update the software packages to ensure that the Linux server is up to date.
$ sudo apt upgrade 4. Reboot the Linux server.
$ sudo reboot
SUSE Linux Enterprise 12.x
The default desktop environment for SUSE Linux Enterprise 12.x is SLE Classic and the default desktop manager is GDM.
Linux
To install and configure the desktop environment and desktop manager on SUSE Linux Enterprise 12.x
1. Install the desktop environment and the desktop manager packages.
$ sudo zypper install -t pattern gnome_basic
$ sudo update-alternatives --set default-displaymanager /usr/lib/X11/
displaymanagers/gdm
$ sudo sed -i "s/DEFAULT_WM=\"\"/DEFAULT_WM=\"gnome\"/" /etc/sysconfig/
windowmanager
2. Update the software packages to ensure that the Linux server is up to date.
$ sudo zypper update 3. Reboot the Linux server.
$ sudo reboot
SUSE Linux Enterprise 15.x
The default desktop environment for SUSE Linux Enterprise 15.x is SLE Classic and the default desktop manager is GDM3. Depending on the session type you run, you might need to configure the system differently.
• Console sessions
LightDM isn't currently supported with NICE DCV console sessions on SUSE Linux Enterprise 15.x.
We recommend that you use the GDM3 desktop manager if you plan to work with NICE DCV console sessions.
• Virtual Sessions
Because of a known GDM issue, virtual sessions cannot work on SUSE Linux Enterprise 15.x. To make virtual sessions working correctly, you can adopt one of the following solutions:
• On servers that do not have a GPU, you can disable the desktop manager since it's not required to run virtual sessions. Configure the system to run in multi-user mode by running the following command before creating virtual sessions:
sudo systemctl isolate multi-user.target
• On servers with a GPU, in addition to disabling the desktop manager, you need to start an X server on the system before creating virtual sessions. To do this, run the following commands:
sudo systemctl isolate multi-user.target
sudo dcvstartx &
Linux
To install and configure the desktop environment and desktop manager on SUSE Linux Enterprise 15.x
1. Install the desktop environment and the desktop manager packages.
$ sudo zypper install -t pattern gnome_basic
$ sudo update-alternatives --set default-displaymanager /usr/lib/X11/
displaymanagers/gdm
$ sudo sed -i "s/DEFAULT_WM=\"\"/DEFAULT_WM=\"gnome\"/" /etc/sysconfig/
windowmanager
2. Update the software packages to ensure that the Linux server is up to date.
$ sudo zypper update 3. Reboot the Linux server.
$ sudo reboot
Disable the Wayland protocol (GDM3 only)
NICE DCV doesn't support the Wayland protocol. If you're using the GDM3 desktop manager, you must disable the Wayland protocol. If you aren't using GDM3, skip this step.
To disable the Wayland protocol
1. Open the following file using your preferred text editor.
• RHEL 8.x, CentOS 8.x, and SUSE Linux Enterprise 15.x
/etc/gdm/custom.conf
• Ubuntu 20.x
/etc/gdm3/custom.conf
2. In the [daemon] section, set WaylandEnable to false.
[daemon]
WaylandEnable=false 3. Restart the GDM service.
• RHEL 8.x and CentOS 8.x
$ sudo systemctl restart gdm
• Ubuntu 20.x
$ sudo systemctl restart gdm3
• SUSE Linux Enterprise 15.x
Linux
$ sudo systemctl restart xdm
Configure the X Server
If you intend to use a console session or GPU sharing, you must ensure that your Linux server has a properly configured and running X server.
Note
If you intend to use virtual sessions without GPU sharing, you don't need an X server.The X server packages are typically installed as dependencies of the desktop environment and the desktop manager. We recommend that you configure the X server to start automatically when your Linux server boots.
The following content shows how to configure and start the X server on the supported operating systems.
RHEL 7.x/8.x, CentOS 7.x/8.x, Amazon Linux 2, Ubuntu 18.x/20.x, and SUSE Linux Enterprise 12.x/15.x
To configure and start the X server on RHEL 7.x/8.x, CentOS 7.x/8.x, Amazon Linux 2, Ubuntu 18.x/20.x, or SUSE Linux Enterprise 12.x/15.x
1. Configure the X server to start automatically when the Linux server boots.
$ sudo systemctl get-default
If the command returns graphical.target, the X server is already configured to start automatically. Continue to the next step.
If the command returns multi-user.target, the X server isn't configured to start automatically. Run the following command:
$ sudo systemctl set-default graphical.target 2. Start the X server.
$ sudo systemctl isolate graphical.target 3. Verify that the X server is running.
$ ps aux | grep X | grep -v grep
The following shows example output if the X server is running.
root 1891 0.0 0.7 277528 30448 tty7 Ssl+ 10:59 0:00 /usr/bin/Xorg :0 -background none -verbose -auth /run/gdm/auth-for-gdm-wltseN/database -seat seat0 vt7
Install the glxinfo utility
The glxinfo utility provides information about your Linux server's OpenGL configuration. The utility can be used to determine whether your Linux server is configured to support OpenGL hardware or software rendering. It provides information about the drivers and supported extensions.
Linux
The glxinfo utility is installed as a package dependency of DCV GL. Therefore, if you installed DCV GL, the glxinfo utility is already installed on your Linux server.
To install the glxinfo utility Run the following command:
• RHEL 7.x/8.x, CentOs 7.x/8.x, and Amazon Linux 2
$ sudo yum install glx-utils
• Ubuntu 18.x/20.x
$ sudo apt install mesa-utils
• SUSE Linux Enterprise 12.x/15.x
$ sudo zypper in Mesa-demo-x
Verify OpenGL software rendering
On non-GPU Linux servers, OpenGL is only supported in software rendering mode using the Mesa drivers. If you're using a non-GPU Linux server and intend to use OpenGL, ensure that the Mesa drivers are installed and properly configured on your Linux server.
Note
This applies to non-GPU Linux servers only.To verify that OpenGL software rendering is available
Make sure that the X server is running, and use the following command:
$ sudo DISPLAY=:0 XAUTHORITY=$(ps aux | grep "X.*\-auth" | grep -v grep | sed -n 's/.*-auth \([^ ]\+\).*/\1/p') glxinfo | grep -i "opengl.*version"
The following shows example output if OpenGL software rendering is available:
OpenGL core profile version string: 3.3 (Core Profile) Mesa 17.0.5 OpenGL core profile shading language version string: 3.30 OpenGL version string: 3.0 Mesa 17.0.5
OpenGL shading language version string: 1.30
OpenGL ES profile version string: OpenGL ES 3.0 Mesa 17.0.5
OpenGL ES profile shading language version string: OpenGL ES GLSL ES 3.00
Install GPU drivers for graphics instances
Topics
• Install and configure NVIDIA drivers (p. 17)
• Install and Configure AMD Drivers (p. 19)
Install and configure NVIDIA drivers
With Linux servers that have a dedicated NVIDIA GPU, ensure that the appropriate NVIDIA drivers are installed and properly configured. For instructions on how to install the NVIDIA drivers on an Amazon EC2 Linux instance, see Installing the NVIDIA Driver on Linux Servers in the Amazon EC2 User Guide for Linux Instances.
Linux
Note
• This applies to Linux servers with NVIDIA GPUs only.
• The GRID drivers support up to four 4K displays for each GPU installed. The gaming drivers support only one 4K display for each GPU installed.
After you installed the NVIDIA drivers on your Linux server, update the xorg.conf.
To generate an updated xorg.conf
1. Run the following command.sudo nvidia-xconfig --preserve-busid --enable-all-gpus
If you're using a G3 or G4 Amazon EC2 instance and you want to use a multi-monitor console session, include the --connected-monitor=DFP-0,DFP-1,DFP-2,DFP-3 parameter. This is as follows.
sudo nvidia-xconfig --preserve-busid --enable-all-gpus --connected- monitor=DFP-0,DFP-1,DFP-2,DFP-3
Note
Make sure that your server doesn't have the legacy /etc/X11/XF86Config file. If it does, nvidia-xconfig updates that configuration file instead of generating the required /etc/X11/xorg.conf file. Run the following command to remove the legacy XF86Config file:
sudo rm -rf /etc/X11/XF86Config*
2. Restart the X server for the changes to take effect.
• RHEL 7.x, CentOs 7.x, Amazon Linux 2, Ubuntu 18.x, and SUSE Linux Enterprise 12.x
$ sudo systemctl isolate multi-user.target
$ sudo systemctl isolate graphical.target
To verify that your NVIDIA GPU supports hardware-based video encoding
Make sure that it supports NVENC encoding and that it has compute capabilities greater than or equal to 3.0, or greater than or equal to 3.5 for Ubuntu 20.
To verify NVENC support, see the NVIDIA Video Encode and Decode GPU Support Matrix. To check the compute capabilities, see the NVIDIA Compute Capacility tables.
If your NVIDIA GPU doesn't support NVENC encoding or if it doesn't have the required compute capabilities, software-based video encoding is used.
To verify that OpenGL hardware rendering is available
Use the following command to ensure that the X server is running.
$ sudo DISPLAY=:0 XAUTHORITY=$(ps aux | grep "X.*\-auth" | grep -v grep | sed -n 's/.*-auth \([^ ]\+\).*/\1/p') glxinfo | grep -i "opengl.*version"
The following shows example output if OpenGL hardware rendering is available.
Linux
OpenGL core profile version string: 4.4.0 NVIDIA 390.75
OpenGL core profile shading language version string: 4.40 NVIDIA via Cg compiler
OpenGL version string: 4.6.0 NVIDIA 390.75
OpenGL shading language version string: 4.60 NVIDIA
OpenGL ES profile version string: OpenGL ES 3.2 NVIDIA 390.75
OpenGL ES profile shading language version string: OpenGL ES GLSL ES 3.20
Install and Configure AMD Drivers
An instance with an attached AMD GPU, such as a G4ad instance, must have the appropriate AMD driver installed. For instructions on how to install the AMD GPU drivers on a compatible Amazon EC2 instance, see Install AMD drivers on Linux instances.
For more information about Amazon EC2 G4ad instances, see the Deep dive on the new Amazon EC2 G4ad instances blog post.
Install XDummy driver for non-GPU instances
Topics
• Install and configure the XDummy driver (p. 19)
Install and configure the XDummy driver
To use console sessions on Linux servers that do not have a dedicated GPU, ensure that the Xdummy driver is installed and properly configured. The XDummy driver allows the X server to run with a virtual framebuffer when no real GPU is present.
Note
• This is not required if you intend to use virtual sessions.
• The XDummy driver is able to support only resolutions defined in its configuration.
To install the XDummy driver Run the following command:
• RHEL 7.x/8.x, CentOs 7.x/8.x, and Amazon Linux 2
$ sudo yum install xorg-x11-drv-dummy
• Ubuntu 18.x/20.x
$ sudo apt install xserver-xorg-video-dummy
• SUSE Linux Enterprise 12.x/15.x
$ sudo zypper in xf86-video-dummy
After you installed the XDummy drivers on your Linux server, update the xorg.conf.
To configure XDummy in xorg.conf
1. Open the /etc/X11/xorg.conf file with your preferred text editor.
2. Add the following sections to the configuration.
Linux
Section "Device"
Identifier "DummyDevice"
Driver "dummy"
Option "ConstantDPI" "true"
Option "IgnoreEDID" "true"
Option "NoDDC" "true"
VideoRam 2048000 EndSection
Section "Monitor"
Identifier "DummyMonitor"
HorizSync 5.0 - 1000.0 VertRefresh 5.0 - 200.0
Modeline "1920x1080" 23.53 1920 1952 2040 2072 1080 1106 1108 1135 Modeline "1600x900" 33.92 1600 1632 1760 1792 900 921 924 946 Modeline "1440x900" 30.66 1440 1472 1584 1616 900 921 924 946 ModeLine "1366x768" 72.00 1366 1414 1446 1494 768 771 777 803 Modeline "1280x800" 24.15 1280 1312 1400 1432 800 819 822 841 Modeline "1024x768" 18.71 1024 1056 1120 1152 768 786 789 807 EndSection
Section "Screen"
Identifier "DummyScreen"
Device "DummyDevice"
Monitor "DummyMonitor"
DefaultDepth 24 SubSection "Display"
Viewport 0 0 Depth 24
Modes "1920x1080" "1600x900" "1440x900" "1366x768" "1280x800" "1024x768"
virtual 1920 1080 EndSubSection
EndSection
Note
The configuration provided is an example. You can add more modes, and set a different virtual resolution. You can also configure more than one dummy monitor.3. Restart the X server for the changes to take effect.
• RHEL 7.x, CentOs 7.x, Amazon Linux 2, Ubuntu 18.x, and SUSE Linux Enterprise 12.x
$ sudo systemctl isolate multi-user.target
$ sudo systemctl isolate graphical.target
Install the NICE DCV Server on Linux
The NICE DCV server is installed using a series of RPM or .deb packages, depending on your host server's operating system. The packages install all required packages and their dependencies, and perform the required server configuration.
Note
You must be signed in as the root user to install the NICE DCV server.Linux
Install the NICE DCV Server
Amazon Linux 2 and RHEL/CentOS 7.x
The NICE DCV server is available for Amazon Linux 2, RHEL, and CentOS 7.x servers based on the 64- bit x86 and 64-bit ARM architectures.
Important
The nice-dcv-gl and nice-dcv-gltest packages aren't available for servers based on the 64-bit ARM architecture.
To install the NICE DCV server on Amazon Linux 2, RHEL 7.x, and CentOS 7.x
1. Launch and connect to the server that you intend to install the NICE DCV server.2. The NICE DCV server packages are digitally signed with a secure GPG signature. To allow the package manager to verify the package signature, you must import the NICE GPG key. To do so, open a terminal window and import the NICE GPG key.
$ sudo rpm --import https://d1uj6qtbmh3dt5.cloudfront.net/NICE-GPG-KEY
3. Download the packages from the NICE DCV download website. The RPM and deb packages are packaged into a .tgz archive. Make sure that you download the correct archive for your operating system.
• 64-bit x86
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/2022.0/Servers/nice- dcv-2022.0-11954-el7-x86_64.tgz
• 64-bit ARM
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/2022.0/Servers/nice- dcv-2022.0-11954-el7-aarch64.tgz
Tip
The latest packages page of the download website contains links that always point to the newest available version. You can use these links to automatically retrieve the newest NICE DCV packages.• 64-bit x86
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/nice-dcv-el7-x86_64.tgz
• 64-bit ARM
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/nice-dcv-el7-aarch64.tgz 4. Extract the contents of the .tgz archive and navigate into the extracted directory.
• 64-bit x86
$ tar -xvzf nice-dcv-2022.0-11954-el7-x86_64.tgz && cd nice-dcv-2022.0-11954-el7- x86_64
• 64-bit ARM
Linux
$ tar -xvzf nice-dcv-2022.0-11954-el7-aarch64.tgz && cd nice-dcv-2022.0-11954- el7-aarch64
5. Install the NICE DCV server.
• 64-bit x86
$ sudo yum install nice-dcv-server-2022.0.11954-1.el7.x86_64.rpm
• 64-bit ARM
$ sudo yum install nice-dcv-server-2022.0.11954-1.el7.aarch64.rpm
6. (Optional) To use the web client with NICE DCV version 2021.2 and later, install the nice-dcv- web-viewer package.
• 64-bit x86
$ sudo yum install nice-dcv-web-viewer-2022.0.11954-1.el7.x86_64.rpm
• 64-bit ARM
$ sudo yum install nice-dcv-web-viewer-2022.0.11954-1.el7.aarch64.rpm 7. (Optional) To use virtual sessions, install the nice-xdcv package.
• 64-bit x86
$ sudo yum install nice-xdcv-2022.0.424-1.el7.x86_64.rpm
• 64-bit ARM
$ sudo yum install nice-xdcv-2022.0.424-1.el7.aarch64.rpm
8. (Optional) If you plan to use GPU sharing, install the nice-dcv-gl package.
• 64-bit x86
$ sudo yum install nice-dcv-gl-2022.0.961-1.el7.x86_64.rpm
Note
You can optionally install the nice-dcv-gltest package. This package includes a simple OpenGL application that can be used to determine if your virtual sessions are properly configured to use hardware-based OpenGL.9. (Optional) If you plan to use NICE DCV with NICE EnginFrame, install the nice-dcv-simple- external-authenticator package.
• 64-bit x86
$ sudo yum install nice-dcv-simple-external- authenticator-2022.0.188-1.el7.x86_64.rpm
• 64-bit ARM
Linux
$ sudo yum install nice-dcv-simple-external- authenticator-2022.0.188-1.el7.aarch64.rpm
10. (Optional) To support specialized USB devices using USB remotization, install the DCV USB drivers.
To install the DCV USB drivers, you must have Dynamic Kernel Module Support (DKMS) installed on your server. Use the following commands to install DKMS.
DKMS can be installed from the Extra Packages for Enterprise Linux (EPEL) repository. Run the following command to enable the EPEL repository:
$ sudo yum install https://dl.fedoraproject.org/pub/epel/epel-release- latest-7.noarch.rpm
After you enabled the EPEL repository, run the following command to install DKMS:
$ sudo yum install dkms
After you installed DKMS, run the following command to install the DCV USB drivers:
$ sudo dcvusbdriverinstaller
11. (Optional) If you plan to support microphone redirection, verify that the pulseaudio-utils package is installed on your system. Use the following command to install it.
$ sudo yum install pulseaudio-utils
RHEL/CentOS 8.x
The NICE DCV server is available for RHEL and CentOS 8.x servers based on the 64-bit x86 and 64- bit ARM architectures.
Important
The nice-dcv-gl and nice-dcv-gltest packages aren't available for servers based on the 64-bit ARM architecture.
To install the NICE DCV server on RHEL 8.x or CentOS 8.x
1. Launch and connect to the server where you intend to install the NICE DCV server.
2. The NICE DCV server packages are digitally signed with a secure GPG signature. To allow the package manager to verify the package signature, you must import the NICE GPG key. To do so, open a terminal window and import the NICE GPG key.
$ sudo rpm --import https://d1uj6qtbmh3dt5.cloudfront.net/NICE-GPG-KEY
3. Download the packages from the NICE DCV download website. The RPM and deb packages are packaged into a .tgz archive. Make sure that you download the correct archive for your operating system.
• 64-bit x86
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/2022.0/Servers/nice- dcv-2022.0-11954-el8-x86_64.tgz
Linux
• 64-bit ARM
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/2022.0/Servers/nice- dcv-2022.0-11954-el8-aarch64.tgz
Tip
The latest packages page of the download website contains links that always point to the newest available version. You can use these links to automatically retrieve the newest NICE DCV packages.• 64-bit x86
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/nice-dcv-el8-x86_64.tgz
• 64-bit ARM
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/nice-dcv-el8-aarch64.tgz 4. Extract the contents of the .tgz archive and navigate into the extracted directory.
• 64-bit x86
$ tar -xvzf nice-dcv-2022.0-11954-el8-x86_64.tgz && cd nice-dcv-2022.0-11954-el8- x86_64
• 64-bit ARM
$ tar -xvzf nice-dcv-2022.0-11954-el8-aarch64.tgz && cd nice-dcv-2022.0-11954- el8-aarch64
5. Install the NICE DCV server.
• 64-bit x86
$ sudo yum install nice-dcv-server-2022.0.11954-1.el8.x86_64.rpm
• 64-bit ARM
$ sudo yum install nice-dcv-server-2022.0.11954-1.el8.aarch64.rpm
6. (Optional) If you plan to use the web client with NICE DCV version 2021.2 and later, install the nice-dcv-web-viewer package.
• 64-bit x86
$ sudo yum install nice-dcv-web-viewer-2022.0.11954-1.el8.x86_64.rpm
• 64-bit ARM
$ sudo yum install nice-dcv-web-server-2022.0.11954-1.el8.aarch64.rpm 7. (Optional) To use virtual sessions, install the nice-xdcv package.
• 64-bit x86
Linux
$ sudo yum install nice-xdcv-2022.0.424-1.el8.x86_64.rpm
• 64-bit ARM
$ sudo yum install nice-xdcv-2022.0.424-1.el8.aarch64.rpm
8. (Optional) If you plan to use GPU sharing, install the nice-dcv-gl package.
• 64-bit x86
$ sudo yum install nice-dcv-gl-2022.0.961-1.el8.x86_64.rpm
Note
You can optionally install the nice-dcv-gltest package. This package includes a simple OpenGL application that can be used to determine if your virtual sessions are properly configured to use hardware-based OpenGL.9. (Optional) If you plan to use NICE DCV with NICE EnginFrame, install the nice-dcv-simple- external-authenticator package.
• 64-bit x86
$ sudo yum install nice-dcv-simple-external- authenticator-2022.0.188-1.el8.x86_64.rpm
• 64-bit ARM
$ sudo yum install nice-dcv-simple-external- authenticator-2022.0.188-1.el8.aarch64.rpm
10. (Optional) If you plan to support specialized USB devices using USB remotization, install the DCV USB drivers.
To install the DCV USB drivers, you must have Dynamic Kernel Module Support (DKMS) installed on your server. Use the following commands to install DKMS.
DKMS can be installed from the Extra Packages for Enterprise Linux (EPEL) repository. Run the following command to enable the EPEL repository:
$ sudo yum install https://dl.fedoraproject.org/pub/epel/epel-release- latest-8.noarch.rpm
After you enabled the EPEL repository, run the following command to install DKMS:
$ sudo yum install dkms
After you installed DKMS, run the following command to install the DCV USB drivers:
$ sudo dcvusbdriverinstaller
11. (Optional) If you plan to support the microphone redirection, verify that the pulseaudio- utils package is installed on your system. Use the following command to install it.
$ sudo yum install pulseaudio-utils
Linux
SLES 12.x/15.x
The NICE DCV server is available for SUSE Linux Enterprise Server (SLES) 12.x/15.x servers based on the 64-bit x86 architecture only.
To install the NICE DCV server on SLES 12.x/15.x
1. Launch and connect to the server where you intend to install the NICE DCV server.
2. The NICE DCV server packages are digitally signed with a secure GPG signature. To allow the package manager to verify the package signature, you must import the NICE GPG key. To do so, open a terminal window and import the NICE GPG key.
$ sudo rpm --import https://d1uj6qtbmh3dt5.cloudfront.net/NICE-GPG-KEY
3. Download the packages from the NICE DCV download website. The RPM and deb packages are packaged into a .tgz archive. Make sure that you download the correct archive for your operating system.
• SLES 12.x
$ curl -O https://d1uj6qtbmh3dt5.cloudfront.net/2022.0/Servers/nice- dcv-2022.0-11954-sles12-x86_64.tgz
• SLES 15.x
$ curl -O https://d1uj6qtbmh3dt5.cloudfront.net/2022.0/Servers/nice- dcv-2022.0-11954-sles15-x86_64.tgz
Tip
The latest packages page of the download website contains links that always point to the newest available version. You can use these links to automatically retrieve the newest NICE DCV packages.• SLES 12.x
$ curl -O https://d1uj6qtbmh3dt5.cloudfront.net/nice-dcv-sles12-x86_64.tgz
• SLES 15.x
$ curl -O https://d1uj6qtbmh3dt5.cloudfront.net/nice-dcv-sles15-x86_64.tgz 4. Extract the contents of the .tgz archive and navigate into the extracted directory.
• SLES 12.x
$ tar -xvzf nice-dcv-2022.0-11954-sles12-x86_64.tgz && cd nice-dcv-2022.0-11954- sles12-x86_64
• SLES 15.x
$ tar -xvzf nice-dcv-2022.0-11954-sles15-x86_64.tgz && cd nice-dcv-2022.0-11954- sles15-x86_64
5. Install the NICE DCV server.
• SLES 12.x
Linux
$ sudo zypper install nice-dcv-server-2022.0.11954-1.sles12.x86_64.rpm
• SLES 15.x
$ sudo zypper install nice-dcv-server-2022.0.11954-1.sles15.x86_64.rpm
6. (Optional) If you plan to use the web client with NICE DCV version 2021.2 and later, install the nice-dcv-web-viewer package.
• SLES 12.x
$ sudo zypper install nice-dcv-web-viewer-2022.0.11954-1.sles12.x86_64.rpm
• SLES 15.x
$ sudo zypper install nice-dcv-web-viewer-2022.0.11954-1.sles15.x86_64.rpm 7. (Optional) To use virtual sessions, install the nice-xdcv package.
• SLES 12.x
$ sudo zypper install nice-xdcv-2022.0.424-1.sles12.x86_64.rpm
• SLES 15.x
$ sudo zypper install nice-xdcv-2022.0.424-1.sles15.x86_64.rpm 8. (Optional) If you plan to use GPU sharing, install the nice-dcv-gl package.
• SLES 12.x
$ sudo zypper install nice-dcv-gl-2022.0.961-1.sles12.x86_64.rpm
• SLES 15.x
$ sudo zypper install nice-dcv-gl-2022.0.961-1.sles15.x86_64.rpm
Note
You can optionally install the nice-dcv-gltest package. This package includes a simple OpenGL application that can be used to determine whether your virtual sessions are properly configured to use hardware-based OpenGL.
9. (Optional) If you plan to use NICE DCV with NICE EnginFrame, install the nice-dcv-simple- external-authenticator package.
• SLES 12.x
$ sudo zypper install nice-dcv-simple-external- authenticator-2022.0.188-1.sles12.x86_64.rpm
• SLES 15.x
$ sudo zypper install nice-dcv-simple-external- authenticator-2022.0.188-1.sles15.x86_64.rpm
Linux
10. (Optional) If you plan to support specialized USB devices using USB remotization, install the DCV USB drivers.
To install the DCV USB drivers, you must have Dynamic Kernel Module Support (DKMS) installed on your server. Use the following commands to install DKMS.
Run the following command to install DKMS:
• SLES 12.x
$ sudo zypper install http://download.opensuse.org/repositories/home:/Ximi1970:/
Dkms:/Staging/SLE_12_SP4/noarch/dkms-2.5-11.1.noarch.rpm
• SLES 15
Enable the PackageHub repository.
$ sudo SUSEConnect -p PackageHub/15/x86_64
Note
If you're using SLES 15 SP1 or SP2, replace 15 in the command above with either15.1 or 15.2.
Install DKMS.
$ sudo zypper refresh
$ sudo zypper install dkms
Install the kernel source.
$ sudo zypper install -y kernel-source
Reboot the instance.
$ sudo reboot
After you have installed DKMS, run the following command to install the DCV USB drivers:
$ sudo dcvusbdriverinstaller
11. (Optional) If you plan to support the microphone redirection, verify that the pulseaudio- utils package is installed on your system. Use the following command to install it.
$ sudo zypper install pulseaudio-utils
Ubuntu 18.04/20.04
The NICE DCV server is available for Ubuntu servers based on the 64-bit x86 and 64-bit ARM architectures.
Linux
Important
The nice-dcv-gl and nice-dcv-gltest packages aren't available for servers based on the 64-bit ARM architecture.
To install the NICE DCV server on Ubuntu 18.04/20.04
1. Launch and connect to the server where you intend to install the NICE DCV server.
2. The NICE DCV server packages are digitally signed with a secure GPG signature. To allow the package manager to verify the package signature, you must import the NICE GPG key. To do so, open a terminal window and import the NICE GPG key.
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/NICE-GPG-KEY
$ gpg --import NICE-GPG-KEY
3. Download the packages from the NICE DCV download website. The RPM and deb packages are packaged into a .tgz archive. Make sure that you download the correct archive for your operating system.
• Ubuntu 18.04 (64-bit x86)
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/2022.0/Servers/nice- dcv-2022.0-11954-ubuntu1804-x86_64.tgz
• Ubuntu 18.04 (64-bit ARM)
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/2022.0/Servers/nice- dcv-2022.0-11954-ubuntu1804-aarch64.tgz
• Ubuntu 20.04 (64-bit x86)
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/2022.0/Servers/nice- dcv-2022.0-11954-ubuntu2004-x86_64.tgz
Tip
The latest packages page of the download website contains links that always point to the newest available version. You can use these links to automatically retrieve the newest NICE DCV packages.• Ubuntu 18.04 (64-bit x86)
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/nice-dcv-ubuntu1804- x86_64.tgz
• Ubuntu 18.04 (64-bit ARM)
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/nice-dcv-ubuntu1804- aarch64.tgz
• Ubuntu 20.04 (64-bit x86)
$ wget https://d1uj6qtbmh3dt5.cloudfront.net/nice-dcv-ubuntu2004- x86_64.tgz
4. Extract the contents of the .tgz archive and navigate into the extracted directory.
Linux
• Ubuntu 18.04 (64-bit x86)
$ tar -xvzf nice-dcv-2022.0-11954-ubuntu1804-x86_64.tgz && cd nice- dcv-2022.0-11954-ubuntu1804-x86_64
• Ubuntu 18.04 (64-bit ARM)
$ tar -xvzf nice-dcv-2022.0-11954-ubuntu1804-arm64.tgz && cd nice- dcv-2022.0-11954-ubuntu1804-arm64
• Ubuntu 20.04 (64-bit x86)
$ tar -xvzf nice-dcv-2022.0-11954-ubuntu2004-x86_64.tgz && cd nice- dcv-2022.0-11954-ubuntu2004-x86_64
5. Install the NICE DCV server.
• Ubuntu 18.04 (64-bit x86)
$ sudo apt install ./nice-dcv-server_2022.0.11954-1_amd64.ubuntu1804.deb
• Ubuntu 18.04 (64-bit ARM)
$ sudo apt install ./nice-dcv-server_2022.0.11954-1_arm64.ubuntu1804.deb
• Ubuntu 20.04 (64-bit x86)
$ sudo apt install ./nice-dcv-server_2022.0.11954-1_amd64.ubuntu2004.deb
6. (Optional) If you plan to use the web client with NICE DCV version 2021.2 and later, install the nice-dcv-web-viewer package.
• Ubuntu 18.04 (64-bit x86)
$ sudo apt install ./nice-dcv-web-viewer_2022.0.11954-1_amd64.ubuntu1804.deb
• Ubuntu 18.04 (64-bit ARM)
$ sudo apt install ./nice-dcv-web-viewer_2022.0.11954-1_arm64.ubuntu1804.deb
• Ubuntu 20.04 (64-bit x86)
$ sudo apt install ./nice-dcv-web-viewer_2022.0.11954-1_amd64.ubuntu2004.deb 7. Add the dcv user to the video group.
$ sudo usermod -aG video dcv
8. (Optional) If you plan to use virtual sessions, install the nice-xdcv package.
• Ubuntu 18.04 (64-bit x86)
$ sudo apt install ./nice-xdcv_2022.0.424-1_amd64.ubuntu1804.deb
• Ubuntu 18.04 (64-bit ARM)
Linux
$ sudo apt install ./nice-xdcv_2022.0.424-1_arm64.ubuntu1804.deb
• Ubuntu 20.04 (64-bit x86)
$ sudo apt install ./nice-xdcv_2022.0.424-1_amd64.ubuntu2004.deb 9. (Optional) If you plan to use GPU sharing, install the nice-dcv-gl package.
• Ubuntu 18.04 (64-bit x86)
$ sudo apt install ./nice-dcv-gl_2022.0.961-1_amd64.ubuntu1804.deb
• Ubuntu 20.04 (64-bit x86)
$ sudo apt install ./nice-dcv-gl_2022.0.961-1_amd64.ubuntu2004.deb
Note
You can optionally install the nice-dcv-gltest package. This package includes a simple OpenGL application that can be used to determine if your virtual sessions are properly configured to use hardware-based OpenGL.10. (Optional) If you plan to use NICE DCV with NICE EnginFrame, install the nice-dcv-simple- external-authenticator package.
• Ubuntu 18.04 (64-bit x86)
$ sudo apt install ./nice-dcv-simple-external- authenticator_2022.0.188-1_amd64.ubuntu1804.deb
• Ubuntu 18.04 (64-bit ARM)
$ sudo apt install ./nice-dcv-simple-external- authenticator_2022.0.188-1_arm64.ubuntu1804.deb
• Ubuntu 20.04 (64-bit x86)
$ sudo apt install ./nice-dcv-simple-external- authenticator_2022.0.188-1_amd64.ubuntu2004.deb
11. (Optional) If you plan to support specialized USB devices using USB remotization, install the DCV USB drivers.
To install the DCV USB drivers, you must have Dynamic Kernel Module Support (DKMS) installed on your server. Use the following commands to install DKMS.
DKMS is available in the official Ubuntu repository. Run the following command to install DKMS:
$ sudo apt install dkms
After you installed DKMS, run the following command to install the DCV USB drivers:
$ sudo dcvusbdriverinstaller
12. (Optional) If you plan to support the microphone redirection, verify that the pulseaudio- utils package is installed on your system. Use the following command to install it.
Linux
$ sudo apt install pulseaudio-utils
Post-Installation checks
This topic provides some post-installation checks that you should perform after installing NICE DCV to ensure that your NICE DCV server is properly configured.
Contents
• Ensure the NICE DCV Server is reachable (p. 32)
• Ensure that the X server is accessible (p. 32)
• Verify that DCV GL is properly installed (p. 33)
• Verify the NICE DCV DEB package signature (p. 33)
Ensure the NICE DCV Server is reachable
By default, the NICE DCV server is configured to communicate over TCP port 8443. Ensure that the server is reachable over this port. If you have a firewall that prevents access over port 8443, you must change the port over which the NICE DCV server communicates. For more information, see Changing the NICE DCV Server TCP/UDP ports and listen address (p. 51).
Also, if you're setting up NICE DCV on an EC2 instance, create a security group. This is to enable access to the port over which the NICE DCV server communicates. For more information, see how to configure security groups on EC2.
Ensure that the X server is accessible
You must ensure that NICE DCV console and virtual sessions can access the X server.
Console Sessions
When the NICE DCV server is installed, a dcv user is created. Ensure that this user can access the X server.
To verify that the dcv user can access the X server Run the following command:
$ sudo DISPLAY=:0 XAUTHORITY=$(ps aux | grep "X.*\-auth" | grep -v grep | sed -n 's/.*-auth \([^ ]\+\).*/\1/p') xhost | grep "SI:localuser:dcv$"
If the command returns SI:localuser:dcv, the dcv user can access the X server.
If the command does not return SI:localuser:dcv, the dcv user doesn't have access to the X server.
Run the following commands to restart the X server:
• RHEL 7.x/8.x, CentOs 7.x/8.x, Amazon Linux 2, Ubuntu 18.x, and SUSE Linux Enterprise 12.x
$ sudo systemctl isolate multi-user.target
$ sudo systemctl isolate graphical.target
Linux
Virtual sessions
If you installed the DCV GL package, you must ensure that local users can access the X server. This ensures that OpenGL hardware acceleration works correctly with virtual sessions.
To verify that local users can access the X server Run the following command:
$ sudo DISPLAY=:0 XAUTHORITY=$(ps aux | grep "X.*\-auth" | grep -v grep | sed -n 's/.*-auth \([^ ]\+\).*/\1/p') xhost | grep "LOCAL:$"
If the command returns LOCAL:, local users can access the X server.
If the command doesn't return LOCAL:, local users don't have access to the X server. Run the following commands to restart the X server, and to disable and re-enable DCV GL:
• RHEL 7.x/8.x, CentOs 7.x/8x, Amazon Linux 2, Ubuntu 18.x, and SUSE Linux Enterprise 12.x
$ sudo systemctl isolate multi-user.target
$ sudo dcvgladmin disable
$ sudo dcvgladmin enable
$ sudo systemctl isolate graphical.target
Verify that DCV GL is properly installed
The dcvgldiag utility is automatically installed when you install the DCV GL package. You can use this utility to check that the Linux server configuration meets the DCV GL requirements.
To run the dcvgldiag utility Use the following command:
$ sudo dcvgldiag
The utility returns a list of warnings and errors, along with the possible solutions.
Verify the NICE DCV DEB package signature
After NICE DCV is installed, you can verify the signature on the Debian package (DEB). This verification process requires the use of GPG version 1.
To verify the DEB package signature Use the following command:
gpg1 --import NICE-GPG-KEY-SECRET
dpkg-sig --verify nice-dcv-server_2022.0.11954-1_amd64.deb