TurboVNC

https://turbovnc.org/Documentation/
Admin
TurboVNC is a high-performance VNC server and client for Linux and Unix systems, optimized for...
Tokens:13,548
Snippets:272
Trust Score:8.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install UltraVNC Repeater

Source: https://turbovnc.org/Documentation/UltraVNCRepeater

Commands to build, install, and start the UltraVNC Repeater service on a Linux host.

```bash
cd uvncrep017ws
make install
useradd -d /etc/uvnc -s /sbin/nologin uvncrep
service uvncrepeater start
```

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

### Install Ubuntu Desktop Environments

Source: https://turbovnc.org/Documentation/Compatibility32?action=print

Commands to install various desktop environments on Ubuntu systems.

```bash
sudo apt install xubuntu-desktop
```

```bash
sudo apt install ubuntu-desktop
```

```bash
sudo apt install ubuntu-mate-desktop
```

```bash
sudo apt install xfce4
```

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

### Install MATE Desktop Environment

Source: https://turbovnc.org/Documentation/Compatibility32?action=print

Commands to install the MATE desktop environment on various Linux distributions.

```bash
sudo dnf group install mate-desktop
```

```bash
sudo pkg install mate
```

```bash
sudo yum groupinstall MATE
```

```bash
sudo zypper -n in patterns-mate-mate
```

```bash
sudo apt install ubuntu-mate-desktop
```

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

### Install Xfce Desktop Environment

Source: https://turbovnc.org/Documentation/Compatibility32?action=print

Commands to install the Xfce desktop environment on various Linux distributions.

```bash
sudo dnf group install xfce-desktop
```

```bash
sudo pkg install xfce
```

```bash
sudo yum groupinstall Xfce
```

```bash
sudo dnf group install Xfce
```

```bash
sudo zypper install -t pattern xfce
```

```bash
sudo apt install xfce4
```

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

### Install MATE Desktop Environment

Source: https://turbovnc.org/Documentation/Compatibility30?action=print

Use this command to install the complete Ubuntu MATE desktop environment. This is recommended for a non-compositing window manager.

```bash
sudo apt install ubuntu-mate-desktop
```

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

### Install GNOME Desktop Environment

Source: https://turbovnc.org/Documentation/Compatibility32?action=print

Commands to install the GNOME desktop environment on various Linux distributions.

```bash
sudo dnf group install gnome-desktop
```

```bash
sudo yum groupinstall GNOME
```

```bash
sudo zypper in -t pattern gnome_basic gnome gnome_x11
```

```bash
sudo apt install ubuntu-desktop
```

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

### Install KDE Desktop Environment

Source: https://turbovnc.org/Documentation/Compatibility32?action=print

Commands to install the KDE desktop environment on various Linux distributions.

```bash
sudo yum groupinstall KDE
```

```bash
sudo zypper install -t pattern kde kde_plasma
```

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

### Install Xfce Desktop Environment

Source: https://turbovnc.org/Documentation/Compatibility30?action=print

Use this command to install the complete Ubuntu Xfce desktop environment. This is recommended for a non-compositing window manager.

```bash
sudo apt install xfce4
```

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

### Install UltraVNC Mirror Driver

Source: https://turbovnc.org/Documentation/UltraVNC?action=print

Commands to navigate to the driver directory and execute the installation script from an administrator command prompt.

```batch
cd driver/vista64
```

```batch
install.bat
```

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

### Install Ubuntu Desktop (GNOME)

Source: https://turbovnc.org/Documentation/Compatibility30?action=print

Use this command to install the Ubuntu desktop environment, which typically includes GNOME. This may require VirtualGL for optimal performance with compositing effects.

```bash
sudo apt install ubuntu-desktop
```

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

### Install GNOME Classic Session

Source: https://turbovnc.org/Documentation/Compatibility32?action=print

Commands to install the GNOME classic session on various Linux distributions.

```bash
sudo dnf install gnome-classic-session
```

```bash
sudo yum install gnome-classic-session
```

```bash
sudo zypper install gnome-shell-classic
```

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

### Install OATH PAM module on Ubuntu

Source: https://turbovnc.org/Documentation/TOTP

Installs the libpam-oath package on Ubuntu 12.04 LTS and newer using apt-get.

```bash
sudo apt-get install libpam-oath
```

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

### Install OATH PAM module on Fedora

Source: https://turbovnc.org/Documentation/TOTP

Installs the pam_oath package on recent Fedora releases using dnf.

```bash
sudo dnf install pam_oath
```

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

### Install OATH PAM module

Source: https://turbovnc.org/Documentation/TOTP?action=print

Commands to install the required PAM OATH module on various Linux distributions.

```bash
sudo dnf install pam_oath
```

```bash
sudo yum install pam_oath
```

```bash
sudo apt-get install libpam-oath
```

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

### Create Application Launch Script

Source: https://turbovnc.org/Documentation/ApplicationIsolation?action=print

Bash script to start OpenBox, launch the target application, and terminate the session upon application exit.

```bash
#!/bin/bash
openbox-session & PID=$!
{application}
kill $PID
```

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

### Configure /etc/users.oath

Source: https://turbovnc.org/Documentation/TOTP

Example format for the /etc/users.oath file, mapping users to their TOTP secret keys. Adjust the algorithm (e.g., HOTP/T30) based on the TOTP application used.

```text
HOTP/T30 {user1} - {secret1}
...
HOTP/T30 {userN} - {secretN}

```

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

### Install OATH PAM module on RHEL/CentOS

Source: https://turbovnc.org/Documentation/TOTP

Installs the pam_oath package on RHEL/CentOS 6 and newer after enabling the EPEL repository.

```bash
sudo yum install pam_oath
```

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

### View TurboVNC Server Man Pages

Source: https://turbovnc.org/Documentation/Documentation

Use this command to view the man pages for the TurboVNC server components. Ensure the TurboVNC installation path is correctly set.

```bash
man -M /opt/TurboVNC/man vncserver
```

```bash
man -M /opt/TurboVNC/man Xvnc
```

```bash
man -M /opt/TurboVNC/man vncconnect
```

```bash
man -M /opt/TurboVNC/man vncpasswd
```

```bash
man -M /opt/TurboVNC/man tvncconfig
```

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

### Access TurboVNC Server Manual Pages

Source: https://turbovnc.org/Documentation/Documentation?action=print

Use these commands to view the manual pages for TurboVNC server components when installed in the default /opt/TurboVNC directory.

```bash
    man -M /opt/TurboVNC/man vncserver
    man -M /opt/TurboVNC/man Xvnc
    man -M /opt/TurboVNC/man vncconnect
    man -M /opt/TurboVNC/man vncpasswd
    man -M /opt/TurboVNC/man tvncconfig
```

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

### Build Mesa for Software OpenGL

Source: https://turbovnc.org/Documentation/Mesa

Build Mesa with Xlib GLX support and a software rasterizer. Install to a custom prefix. Ensure the lib directory is added to LD_LIBRARY_PATH before running 3D applications.

```bash
cd Mesa-*
autoreconf -fiv
./configure --enable-xlib-glx --disable-dri --disable-egl --disable-gbm --with-gallium-drivers=swrast --prefix=$HOME/mesa
make install
```

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

### OpenBox Menu Configuration

Source: https://turbovnc.org/Documentation/ApplicationIsolation

This XML snippet configures the OpenBox menu for a minimal setup, including exit and log out options. It is used to replace the default menu in /etc/xdg/openbox/menu.xml.

```xml
<?xml version="1.0" encoding="UTF-8"?>

<openbox_menu xmlns="http://openbox.org/3.4/menu">

<menu id="root-menu" label="Openbox 3">
  <separator label="Openbox"/>
  <item label="Exit">
    <action name="Exit">
      <prompt>yes</prompt>
    </action>
  </item>
  <separator/>
  <item label="Log Out">
    <action name="SessionLogout">
      <prompt>yes</prompt>
    </action>
  </item>
</menu>

</openbox_menu>

```

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

### Display TurboVNC Viewer Help

Source: https://turbovnc.org/Documentation/Documentation?action=print

Run these commands to list all supported command-line options and parameters for the TurboVNC Viewer.

```bash
    /opt/TurboVNC/bin/vncviewer -?
```

```batch
    c:\Program Files\TurboVNC\vncviewer.bat -?
```

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

### Configure TurboVNC PAM for Ubuntu

Source: https://turbovnc.org/Documentation/TOTP

Sets up the /etc/pam.d/turbovnc file for Ubuntu systems, requiring pam_oath for authentication.

```pam
auth requisite pam_oath.so usersfile=/etc/users.oath

```

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

### Configure TurboVNC PAM for RHEL/Fedora

Source: https://turbovnc.org/Documentation/TOTP

Sets up the /etc/pam.d/turbovnc file for RHEL/Fedora systems, requiring pam_oath for authentication.

```pam
#%PAM-1.0
auth requisite pam_oath.so usersfile=/etc/users.oath
account include system-auth
password include system-auth
session include system-auth

```

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

### Display TurboVNC Viewer Options (Un*x)

Source: https://turbovnc.org/Documentation/Documentation

Run this command on Un*x systems to display all supported command-line options and parameters for the TurboVNC Viewer.

```bash
/opt/TurboVNC/bin/vncviewer -?
```

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

### Enable llvmpipe Driver (Mesa 11 and earlier)

Source: https://turbovnc.org/Documentation/Mesa

Create a symbolic link to enable the llvmpipe driver for Mesa versions 11 and earlier. This driver uses LLVM IR for improved performance over the pure Xlib driver.

```bash
cd $HOME/mesa/lib
ln -fs libGL.so.1.5.0 libGL.so.1
```

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

### Enable VirtualGL with vncserver

Source: https://turbovnc.org/Documentation/Compatibility30?action=print

Pass the '-vgl' flag to the vncserver command to enable VirtualGL, which improves the performance of compositing window managers.

```bash
/opt/TurboVNC/bin/vncserver -vgl
```

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

### Display TurboVNC Viewer Options (Windows)

Source: https://turbovnc.org/Documentation/Documentation

Execute this command on Windows systems to show all available command-line options and parameters for the TurboVNC Viewer.

```batch
c:\Program Files\TurboVNC\vncviewer.bat -?
```

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

### Enable VirtualGL in turbovncserver.conf

Source: https://turbovnc.org/Documentation/Compatibility30?action=print

Set the '$useVGL' variable to 1 in the TurboVNC server configuration file to enable VirtualGL. This can be done globally in /etc/turbovncserver.conf or per-user in ~/.vnc/turbovncserver.conf.

```bash
$useVGL=1;
```

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

### Configure TurboVNC Performance

Source: https://turbovnc.org/Documentation/Compatibility32?action=print

Settings for enabling VirtualGL or DRI3 to improve performance of compositing window managers.

```bash
$useVGL=1;
```

```bash
-vgl
```

```bash
-drinode _path-to-DRM-render-node_
```

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

### Initiate TurboVNC Server Connection to Repeater

Source: https://turbovnc.org/Documentation/UltraVNCRepeater

Use this command on the VNC server machine to initiate an outbound connection to the UltraVNC Repeater. Ensure the VNC display number, unique session ID, and dispatch machine hostname/IP are correctly specified.

```bash
/opt/TurboVNC/bin/vncconnect -display {my_vnc_display_number} -id {unique_session_id} {my_dispatch_machine}
```

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

### Configure UltraVNC Repeater

Source: https://turbovnc.org/Documentation/UltraVNCRepeater

Configuration setting for the repeater port in the initialization file.

```ini
viewerport=5900
```

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

### Link OATH PAM module for RHEL/CentOS 6

Source: https://turbovnc.org/Documentation/TOTP?action=print

Create a symbolic link for the OATH PAM module in the security directory.

```bash
sudo ln -fs /usr/lib64/security/pam_oath.so /lib64/security/
```

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

### Configure /etc/users.oath

Source: https://turbovnc.org/Documentation/TOTP?action=print

Format for the user secret keys file.

```text
HOTP/T30 {user1} - {secret1}
...
HOTP/T30 {userN} - {secretN}
```

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

### Configure /etc/pam.d/turbovnc

Source: https://turbovnc.org/Documentation/TOTP?action=print

PAM configuration content for TurboVNC authentication.

```text
#%PAM-1.0
auth requisite pam_oath.so usersfile=/etc/users.oath
account include system-auth
password include system-auth
session include system-auth
```

```text
auth requisite pam_oath.so usersfile=/etc/users.oath
```

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

### Set permissions for /etc/pam.d/turbovnc

Source: https://turbovnc.org/Documentation/TOTP?action=print

Commands to secure the TurboVNC PAM configuration file.

```bash
sudo chown root:root /etc/pam.d/turbovnc
sudo chmod 644 /etc/pam.d/turbovnc
```

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

### Launch TurboVNC with Application Isolation Script

Source: https://turbovnc.org/Documentation/ApplicationIsolation

This command launches a TurboVNC server session using a custom script for xstartup. It uses either -fg or -autokill to manage the session's foreground/background status and ensure it exits when the application does.

```bash
/opt/TurboVNC/bin/vncserver -xstartup {script} [-fg|-autokill]
```

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

### Set permissions for /etc/users.oath

Source: https://turbovnc.org/Documentation/TOTP?action=print

Commands to secure the user secrets file.

```bash
sudo chown root:root /etc/users.oath
sudo chmod 600 /etc/users.oath
```

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

### Grant setuid permissions to Xvnc

Source: https://turbovnc.org/Documentation/TOTP?action=print

Allow Xvnc to read the users.oath file.

```bash
sudo chmod u+s /opt/TurboVNC/bin/Xvnc
```

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

### Cross-Compile 32-bit Mesa on x86-64

Source: https://turbovnc.org/Documentation/Mesa?action=print

Configuration flags for cross-compiling 32-bit Mesa, with or without LLVM support.

```bash
--host i686-pc-linux-gnu CFLAGS='-O3 -m32' CXXFLAGS='-O3 -m32' LDFLAGS='-m32 -L/usr/lib/llvm'
```

```bash
--host i686-pc-linux-gnu CFLAGS='-O3 -m32' CXXFLAGS='-O3 -m32' LDFLAGS=-m32 --disable-gallium-llvm
```

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

### Configure Mesa for Older Linux Distros

Source: https://turbovnc.org/Documentation/Mesa

Configure Mesa for older systems like RHEL 5, using the xlib driver and swrast gallium driver. This is necessary when newer build tools are unavailable.

```bash
configure --with-driver=xlib --with-gallium-drivers=swrast --prefix=$HOME/mesa
```

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

### Application Launch Script for OpenBox

Source: https://turbovnc.org/Documentation/ApplicationIsolation

This bash script launches an application within the OpenBox session and ensures that the OpenBox session is terminated when the application exits. Assumes the application will block until it is closed.

```bash
#!/bin/bash
openbox-session & PID=$!
{application}
kill $PID

```

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

### Cross-Compile 32-bit Mesa with LLVM

Source: https://turbovnc.org/Documentation/Mesa

Configure Mesa for cross-compilation of a 32-bit version on x86-64 systems when a 32-bit LLVM development package is available. Sets host, CFLAGS, CXXFLAGS, and LDFLAGS.

```bash
--host i686-pc-linux-gnu CFLAGS='-O3 -m32' CXXFLAGS='-O3 -m32' LDFLAGS='-m32 -L/usr/lib/llvm'
```

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

### Generate user secret key

Source: https://turbovnc.org/Documentation/TOTP?action=print

Generate a unique secret key for a user.

```bash
head -10 /dev/urandom | md5sum | cut -b 1-30
```

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

### Determine Base32 secret key

Source: https://turbovnc.org/Documentation/TOTP?action=print

Convert the secret key to Base32 format for use with authenticator apps.

```bash
oathtool --totp -v {secret}
```

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

### Cross-Compile 32-bit Mesa without LLVM

Source: https://turbovnc.org/Documentation/Mesa

Configure Mesa for cross-compilation of a 32-bit version on x86-64 systems when a 32-bit LLVM development package is not available. Disables gallium-llvm.

```bash
--host i686-pc-linux-gnu CFLAGS='-O3 -m32' CXXFLAGS='-O3 -m32' LDFLAGS=-m32 --disable-gallium-llvm
```
Tokens:
Raw