RealVNC

https://help.realvnc.com/
Admin
RealVNC is a remote desktop software platform that enables secure access and control of computers...
Tokens:118,620
Snippets:2,026
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install Xorg dummy driver on Ubuntu

Source: https://help.realvnc.com/hc/en-us/articles/360003474752-Configuring-RealVNC-Server-s-Virtual-Mode-to-use-SystemXorg-mode

Use this command to install the required dummy video driver on Ubuntu systems.

```bash
sudo apt install xserver-xorg-video-dummy
```

--------------------------------

### Install libappindicator on Ubuntu

Source: https://help.realvnc.com/hc/en-us/articles/33729254825245-Why-does-the-RealVNC-Server-notification-icon-not-appear-on-Linux

Use this command to install the required library on Ubuntu-based systems.

```bash
sudo apt install libappindicator3-1
```

--------------------------------

### Configure and Start RealVNC Server in Virtual Mode

Source: https://help.realvnc.com/hc/en-us/articles/360002253818-Scripting-Deployment-and-Start-up-on-Linux

Set user permissions, define desktop geometries, and start the server instance.

```bash
# echo 'Permissions=:f,dev.acme.com\\johndoe:d,janedoe:v' | tee -a ~/.vnc/config.d/Xvnc
# echo 'RandR=1280x800,800x600,1024x768,1200x900,1280x720,1800x1024' | tee -a ~/.vnc/config.d/Xvnc
vncserver-virtual
```

--------------------------------

### Example connection output

Source: https://help.realvnc.com/hc/en-us/articles/360004324217-Beginner-s-guide-to-Virtual-Mode

Example of the output provided by VNC Server indicating the connection details for the new session.

```text
New desktop is SERVER1:1 (10.10.17.84:1)
```

--------------------------------

### Start RealVNC Server at Boot

Source: https://help.realvnc.com/hc/en-us/articles/360002253218-Starting-and-Stopping-RealVNC-Connect

Commands to enable RealVNC Server to start automatically at system boot.

```bash
systemctl enable vncserver-x11-serviced.service #systemd
```

```bash
update-rc.d vncserver-x11-serviced defaults #initd
```

```bash
systemctl enable vncserver-virtuald.service #systemd
```

```bash
update-rc.d vncserver-virtuald defaults #initd
```

--------------------------------

### RealVNC Configuration File Format Example

Source: https://help.realvnc.com/hc/en-us/articles/360002253878-Configuring-RealVNC-Connect-Using-Parameters

Example of the expected format for RealVNC configuration files, including comments and parameter definitions.

```text
#This is a comment
Desktop=Build machine
Encryption=AlwaysOn
Authentication=SystemAuth
RsaPrivateKeyFile=$HOME/secure/vnc
Permissions=admin:f,vncusers:d,guests:v
```

--------------------------------

### Install Xorg dummy driver on Red Hat / CentOS

Source: https://help.realvnc.com/hc/en-us/articles/360003474752-Configuring-RealVNC-Server-s-Virtual-Mode-to-use-SystemXorg-mode

Use this command to install the required dummy video driver on RHEL, CentOS, or Rocky Linux systems.

```bash
sudo yum install xorg-x11-drv-dummy
```

--------------------------------

### Install RealVNC Server on Windows via Command Line

Source: https://help.realvnc.com/hc/en-us/articles/37161415112733-Deploying-Viewers-and-Servers-with-local-certificates

Use these commands to perform a new installation or update an existing RealVNC Server instance on Windows.

```bash
msiexec /i <vnc-server>.msi /qn JOINOPC=<your-join-token> PARAMS="OPCHOST=https://your-opc-host,OPCCERTS=C:\path\to\OPC.pem"
```

```bash
msiexec /i <vnc-server>.msi /qn
```

--------------------------------

### Starting Xvnc via Command Line

Source: https://help.realvnc.com/hc/en-us/articles/360002253918-Configuring-Xvnc-Using-X-Options

Shows how to pass X options directly to the Xvnc process using the vncserver-virtual command.

```bash
vncserver-virtual -xinerama -logo
```

--------------------------------

### Install haveged entropy generator

Source: https://help.realvnc.com/hc/en-us/articles/360021693151-RealVNC-Server-does-not-start-on-Raspberry-Pi-unless-a-mouse-keyboard-are-connected

Install the haveged package to provide sufficient entropy for RealVNC Server to start automatically.

```bash
sudo apt install haveged
```

--------------------------------

### Example Xvnc Configuration File Format

Source: https://help.realvnc.com/hc/en-us/articles/360002253918-Configuring-Xvnc-Using-X-Options

Demonstrates the syntax for Xvnc configuration files, where each option is on a new line and comments are supported.

```text
_#This is a comment_
-dumbSched
+kb
-core
+xinerama
nologo
```

--------------------------------

### RealVNC Connect Setup App checksum data

Source: https://help.realvnc.com/hc/en-us/articles/27252822630301-SHA256-checksums-for-RealVNC-Connect-v8

Reference values for verifying RealVNC Connect Setup App installers.

```text
Windows
```

```text
3.4.0
```

```text
630e20979447ce44c38aae67e03e98590e3e8b1c45faae13e32c0fb0633ca32e 
```

```text
RealVNC-Connect-Installer-3.4.0-Windows.exe
```

```text
macOS
```

```text
3.4.0
```

```text
6c2b1fa8fb159266f8d9e4c4e70a0140014098bf2dadae15ccd1b7d95f36146e
```

```text
RealVNC-Connect-Installer-3.4.0-MacOSX-universal.zip
```

```text
Linux x64
```

```text
3.4.0
```

```text
c6b50d4dadcac9e231f6cfe9253610a69280681b464a38f4acc51aac8735db55
```

```text
RealVNC-Connect-Installer-3.4.0-Linux-x64.tar.gz
```

--------------------------------

### Prepare System for RealVNC Server in Virtual Mode

Source: https://help.realvnc.com/hc/en-us/articles/360002253818-Scripting-Deployment-and-Start-up-on-Linux

Install the X11 dummy driver and enable the system Xorg configuration.

```bash
sudo apt install xserver-xorg-video-dummy
# sudo yum install xorg-x11-drv-dummy
sudo vncinitconfig --enable-system-xorg
```

--------------------------------

### Configure RealVNC Printer Driver GUID

Source: https://help.realvnc.com/hc/en-us/articles/360002250657-Deploying-and-Licensing-RealVNC-Connect-using-Windows-MSIs

The GUID required for configuring the printer driver installation policy in Group Policy Management Editor.

```text
4658ee7e-f050-11d1-b6bd-00c04fa372a7
```

--------------------------------

### Generate Configuration and Startup Files

Source: https://help.realvnc.com/hc/en-us/articles/360002253838-Hosting-RealVNC-Server-for-Linux-on-a-Network-Share

Commands to generate the necessary configuration and startup scripts for virtual desktops.

```bash
vncinitconfig -config
```

```bash
vncinitconfig -xstartup
```

--------------------------------

### Manually start vncserver-virtuald

Source: https://help.realvnc.com/hc/en-us/articles/360002310717-vncserver-virtuald-man-page

Commands to start the daemon manually depending on the init system.

```bash
systemctl start vncserver-virtuald.service
```

```bash
/etc/init.d/vncserver-virtuald start
```

```bash
service vncserver-virtuald start
```

--------------------------------

### Enable vncserver-virtuald at boot

Source: https://help.realvnc.com/hc/en-us/articles/360002310717-vncserver-virtuald-man-page

Commands to configure the daemon to start automatically at system boot.

```bash
systemctl enable vncserver-virtuald.service
```

```bash
update-rc.d vncserver-virtuald defaults
```

```bash
chkconfig --add vncserver-virtuald
```

--------------------------------

### Include common PAM configurations

Source: https://help.realvnc.com/hc/en-us/articles/360002250217-Setting-up-Interactive-System-Authentication

Examples for referencing existing system-wide PAM configurations in vncserver.custom for Debian and Red Hat-compatible systems.

```text
@include common-auth
@include common-account
@include common-session
```

```text
auth      include    password-auth
account   include    password-auth
session   include    password-auth
```

--------------------------------

### Install RealVNC Viewer deb package

Source: https://help.realvnc.com/hc/en-us/articles/4406469872657-How-do-I-use-RealVNC-Viewer-on-a-Chromebook

Installs the downloaded RealVNC Viewer debian package.

```bash
sudo apt install ./VNC-Viewer-Latest-Linux-x64.deb
```

--------------------------------

### Configure PAM for Debian-compatible systems

Source: https://help.realvnc.com/hc/en-us/articles/360002250217-Setting-up-Interactive-System-Authentication

Example configuration for /etc/pam.d/vncserver.custom requiring standard system authentication followed by a TOTP code.

```text
#First, mandate standard system authentication
auth required pam_unix.so
#Second, require a TOTP code
auth required pam_google_authenticator.so
```

--------------------------------

### Install GNOME desktop environment

Source: https://help.realvnc.com/hc/en-us/articles/4406469872657-How-do-I-use-RealVNC-Viewer-on-a-Chromebook

Installs the GNOME software and package kit required for GUI applications.

```bash
sudo apt-get install gnome-software gnome-packagekit -y
```

--------------------------------

### List desktop session startup commands

Source: https://help.realvnc.com/hc/en-us/articles/360003474792-Why-does-RealVNC-Server-in-Virtual-Mode-on-Linux-appear-to-hang-show-a-gray-screen-or-not-start-at-all

Use this command to identify the execution strings for installed desktop environments.

```bash
grep Exec= /usr/share/xsessions/*.desktop
```

--------------------------------

### Install RealVNC Dummy Driver

Source: https://help.realvnc.com/hc/en-us/articles/360016058212-How-do-I-adjust-the-screen-resolution-of-a-virtual-desktop-under-Linux

Commands to compile and install the RealVNC dummy driver from source on Linux distributions.

```bash
sudo apt install git # Ubuntu  
sudo yum install git # RedHat / CentOS  
  
cd ~  
git clone https://github.com/RealVNC/xf86-video-vnc  
cd xf86-video-vnc  
sudo ./buildAndInstall
```

--------------------------------

### Install RealVNC Server

Source: https://help.realvnc.com/hc/en-us/articles/360002253818-Scripting-Deployment-and-Start-up-on-Linux

Commands to install the downloaded RealVNC Server package on Debian or Red Hat-compatible systems.

```bash
############# Install RealVNC Server #############
# Install RealVNC Server on a Debian-compatible system (assuming download file named as above):
sudo apt install -y ./VNC.deb
# Install RealVNC Server on a Red Hat-compatible system:
# sudo yum install -y VNC.rpm
```

--------------------------------

### Install libappindicator on RHEL/Rocky Linux

Source: https://help.realvnc.com/hc/en-us/articles/33729254825245-Why-does-the-RealVNC-Server-notification-icon-not-appear-on-Linux

Use this command to install the required library on RHEL or Rocky Linux systems.

```bash
sudo yum install libappindicator-gtk3
```

--------------------------------

### Configure RealVNC Server via Command Line

Source: https://help.realvnc.com/hc/en-us/articles/360002253878-Configuring-RealVNC-Connect-Using-Parameters

Pass parameters directly to the executable at start-up to configure a specific instance.

```bash
vncserver-x11 -Desktop="Debug machine" -Authentication=VncAuth
```

--------------------------------

### Inspecting Configuration via Grep

Source: https://help.realvnc.com/hc/en-us/articles/360002253878-Configuring-RealVNC-Connect-Using-Parameters

Example of searching for specific parameter values within configuration files.

```bash
# grep AuthTimeout /etc/vnc/config.d/common.custom /etc/vnc/policy.d/vncserver-x11   
/etc/vnc/policy.d/vncserver-x11:#AuthTimeout=900
```

--------------------------------

### Install RealVNC Server via RPM

Source: https://help.realvnc.com/hc/en-us/articles/360002253198-Installing-and-Removing-RealVNC-Connect-Advanced-users

Use the rpm utility to install the RealVNC Server package with administrative privileges.

```bash
rpm -U <VNC-Server>.rpm
```
Tokens:
Raw