Skip to main content

VNC Remote

Remote login refers to remotely controlling the motherboard through the network. This tutorial only covers VNC remote control methods within a local network.

Users without a display can use the Serial Port Debugging method to run the following commands to configure VNC remote login.

tip

VNC remote control is suitable for systems with a graphical interface. If the system does not have a graphical desktop, we recommend using SSH remote control.

Using VNC (Windows / Linux)

Download VNC Viewer

We need to install VNC Viewer software on the remote device (PC) to control the motherboard.

Go to the RealVNC website to download the VNC Viewer installation package for your system platform.

Install VNC Viewer

After downloading the Windows version of the *.exe installation package:

  • Run the installer

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

  • Software language

Select English language and click OK to proceed.

  • Start installation

Click Next to start the installation program.

  • Accept license

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

  • Installation path

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

  • Start installation

Click Install to begin the installation.

  • Complete installation

Click Finish to complete the installation.

Run VNC Viewer

After installation, open the VNC Viewer software. Users can choose to use VNC Viewer without logging in.

VNC Viewer Interface

Using VNC (Radxa ROCK 4D)

Install VNC Server

Run the following commands in the Radxa ROCK 4D terminal to install the VNC server:

radxa@radxa-rock-4d$
sudo apt update
sudo apt install tigervnc-standalone-server tigervnc-common -y

Set VNC Remote Password

Run the following command in the ROCK 4D terminal to set the VNC remote password:

radxa@radxa-rock-4d$
vncpasswd
tip

The password and confirmation will not be displayed on the screen. When prompted to create a view-only password, choose n (no).

After setting the password, the system will display similar information:

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 ROCK 4D:

radxa@radxa-rock-4d$
sudo vi ~/.vnc/xstartup

Modify the contents of the ~/.vnc/xstartup file to:

radxa@radxa-rock-4d$
#!/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:

radxa@radxa-rock-4d$
sudo chmod +x ~/.vnc/xstartup

Start VNC Server

Run the following command in the ROCK 4D terminal to start the VNC server. Use the -localhost no parameter to allow remote access.

radxa@radxa-rock-4d$
vncserver -localhost no

After successful startup, the terminal will display information similar to this, indicating the VNC server's port number:

New Xtigervnc server 'rock-4d-spi: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

To check the status of the VNC server, run the following command in the ROCK 4D terminal:

radxa@radxa-rock-4d$
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 ROCK 4D terminal. The :1 in the command represents the VNC server's display number.

radxa@radxa-rock-4d$
vncserver -kill :1

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

VNC Remote Login

Open the VNC Viewer software on another device and connect to the ROCK 4D using its IP address and port number.

① Enter the ROCK 4D's IP address and port number

② Click Connect to address ··· to connect to ROCK 4D

① Enter the VNC remote password

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

③ Click OK to connect

Successful VNC Remote Login