Skip to main content

VNC Remote

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 your 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 your remote device's operating system platform

② : Download the VNC Viewer installer

Install VNC Viewer​

After downloading the Windows version *.exe installer:

  • Run the installer

Run the VNC-Viewer-xxx.exe installer as administrator.

  • Software language

Select English language and click OK to continue.

  • Enter installation

Click Next to enter the installation program.

  • Accept agreement

Check the License agreement and click Next to continue.

  • Installation path

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

  • Start 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

VNC Viewer Interface

Using VNC (On the Board)​

Install VNC Server​

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

radxa@device$
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@device$
vncpasswd
tip

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

After completing the password setup, 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@device$
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 DESKTOP_SESSION=plasma
exec startplasma-x11

After editing the ~/.vnc/xstartup file, make it executable with the following command:

radxa@device$
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@device$
vncserver -localhost no

After successful startup, the terminal will display information including the VNC server's port number.

New Xtigervnc server \*\*\*:1 (radxa)' on port 5901 for display :1.
Use xtigervncviewer -SecurityTypes VncAuth -passwd /tmp/tigervnc.VQ4DfI/passwd :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@device$
vncserver -list

The terminal will display output similar to:

TigerVNC server sessions:

X DISPLAY # RFB PORT # RFB UNIX PATH PROCESS ID # SERVER
1 5901 3283 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@device$
vncserver -kill :1

After stopping the VNC server, the VNC Viewer 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 earlier

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

③ : Click OK to connect

VNC Black Screen

If you encounter a black screen when connecting via VNC, check if the system's auto-login feature is enabled. If it is, try disabling the auto-login option.