Skip to main content

VNC Login

Prerequisites

For VNC remote access, both devices must be on the same local network, and the target device must have the VNC service enabled.

Usage Notes

VNC remote control is suitable for systems with a graphical interface. If the system doesn't have a graphical desktop, we recommend using SSH for remote control instead.

Using VNC (Remote Device)

Download VNC Viewer

You need to install VNC Viewer software on the remote device to control the board.

Visit the RealVNC official website to download the VNC Viewer installer.

① : Select the operating system platform of your remote device

② : Download the VNC Viewer installer

Install VNC Viewer

After downloading the Windows *.exe installer:

  • Run the Installer

Run the VNC-Viewer-<version>.exe installer as administrator.

  • Select Language

Choose English as the language and click OK to proceed.

  • Start Installation

Click Next to begin the installation process.

  • Accept License Agreement

Check the I accept the terms in the License Agreement option and click Next to continue.

  • Choose Installation Folder

It's recommended to use the default installation path. Click Next to continue.

  • Begin Installation

Click Install to start the installation.

  • Complete Installation

Click Finish to complete the installation.

Run VNC Viewer

After installation, open the VNC Viewer software. You can choose to use VNC Viewer without logging into an account.

VNC Viewer Interface

Using VNC (Board)

Install VNC Server

Run the following commands in the board's terminal to install the VNC server:

radxa@airbox$
sudo apt update
sudo apt install tigervnc-standalone-server tigervnc-common -y

Set VNC Remote Password

Run the following command in the board's terminal to set the VNC remote password:

radxa@airbox$
vncpasswd
tip

The password and confirmation won't be displayed on screen. When prompted to create a view-only password, select n (no).

After setting the password, you'll see output similar to:

Password:
Verify:
Would you like to enter a view-only password (y/n)? n
A view-only password is not used

Configure VNC Startup File

Edit the ~/.vnc/xstartup file on the board:

radxa@airbox$
sudo vi ~/.vnc/xstartup

Modify the ~/.vnc/xstartup file with the following content:

#!/bin/sh

unset SESSION_MANAGER
unset DBUS_SESSION_BUS_ADDRESS

export XDG_SESSION_TYPE=x11
export XDG_CURRENT_DESKTOP=ubuntu:GNOME
export GNOME_SHELL_SESSION_MODE=ubuntu

exec gnome-session --session=ubuntu > ~/.vnc/gnome-startup.log 2>&1

After editing the ~/.vnc/xstartup file, you need to make it executable:

radxa@airbox$
sudo chmod +x ~/.vnc/xstartup

Start VNC Server

Run the following command in the board's terminal to start the VNC server. The -localhost no parameter allows remote access.

radxa@airbox$
vncserver -localhost no

After successful startup, the terminal will display output similar to the following, showing the VNC server's port number:

/usr/bin/xauth:  file /home/radxa/.Xauthority does not exist

New Xtigervnc server 'airbox:1 (radxa)' on port 5901 for display :1.
Use xtigervncviewer -SecurityTypes VncAuth,TLSVnc -passwd /tmp/tigervnc.9lBgyh/passwd airbox:1 to connect to the VNC server.

Check VNC Server Status

Run the following command in the board's terminal to check the VNC server status:

radxa@airbox$
vncserver -list

The terminal will display output similar to:

TigerVNC server sessions:

X DISPLAY # RFB PORT # RFB UNIX PATH PROCESS ID # SERVER
1 5901 8900 Xtigervnc

Stop VNC Server

To stop the VNC server, run the following command in the board's terminal. The :1 in the command represents the VNC server's display number:

radxa@airbox$
vncserver -kill :1

After stopping the VNC server, the VNC Viewer software will automatically disconnect.

VNC Remote Login

On another device, open the VNC Viewer software and connect to the board using its IP address and port number.

① Enter the board's IP address and port number

② Click Connect to address ··· to connect to the board

① Enter the VNC remote password you set

② Check the Remember password option to save the password for future logins

③ Click OK to connect

Upon successful login, you'll see the system's desktop environment.

    You need to be logged into GitHub to post a comment. If you are already logged in, please ignore this message.

    Radxa-docs © 2026 by Radxa Computer (Shenzhen) Co.,Ltd. is licensed under CC BY 4.0