VNC Login
Parts of this guide are based on contributions from the community user YeWenXuan. Thanks!
Notes
VNC remote login requires both devices to be on the same LAN and the target device to have a graphical desktop environment. VNC must be enabled on both devices.
Controller (PC)
Download VNC Viewer
Install VNC Viewer on the controller device to control the board.
Download the VNC Viewer installer from the official RealVNC website.
① : Select the operating system platform of the controller device
② : Download the VNC Viewer installer
Install VNC Viewer
- Windows
- Linux
After downloading the Windows *.exe installer:
- Run the installer
Run the VNC-Viewer-<version>.exe installer as an administrator.
- Language
Select English and click OK to continue.
- Start installation
Click Next to continue.
- Accept the license
Check I accept the terms in the License Agreement, then click Next.
- Installation path
We recommend using the default installation path, then click Next.
- Install
Click Install to start the installation.
- Finish
Click Finish to complete the installation.
After downloading the Linux *.deb package, run the following command in a terminal to install VNC Viewer:
sudo dpkg -i VNC-Viewer-<version>.deb
Launch VNC Viewer
After installation, open VNC Viewer. You can use VNC Viewer without signing in.
VNC Viewer interface
Target (Board)
Install the VNC Server
Run the following commands on the board to install the VNC server:
sudo apt update
sudo apt install -y tigervnc-standalone-server tigervnc-tools dbus-x11 tigervnc-common
Set a VNC Password
Run the following command on the board to set a VNC password:
vncpasswd
The password and confirmation will not be shown on screen. When asked whether to create a view-only password, choose n (No).
After setting the password, you will see output similar to the following:
Password:
Verify:
Would you like to enter a view-only password (y/n)? n
A view-only password is not used
Configure the VNC Startup Script
Edit the ~/.vnc/xstartup file on the board:
sudo vi ~/.vnc/xstartup
Replace the contents of ~/.vnc/xstartup with the following:
- x11
- gnome
#!/bin/sh
unset SESSION_MANAGER
unset DBUS_SESSION_BUS_ADDRESS
export XDG_SESSION_TYPE=x11
export DESKTOP_SESSION=plasma
exec startplasma-x11
#!/bin/sh
unset SESSION_MANAGER
unset DBUS_SESSION_BUS_ADDRESS
unset XDG_RUNTIME_DIR
if command -v dbus-launch >/dev/null 2>&1; then
eval "$(dbus-launch --sh-syntax --exit-with-session)"
fi
export XDG_SESSION_TYPE=x11
export DESKTOP_SESSION=ubuntu
exec gnome-session
After editing ~/.vnc/xstartup, make it executable:
sudo chmod +x ~/.vnc/xstartup
Start the VNC Server
Run the following command on the board to start the VNC server. The -localhost no option allows remote access.
vncserver -localhost no
After a successful start, the terminal will print output similar to the following, which includes the VNC server port.
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 on the board to check the VNC server status:
vncserver -list
The terminal will output something like this:
TigerVNC server sessions:
X DISPLAY # RFB PORT # RFB UNIX PATH PROCESS ID # SERVER
1 5901 3283 Xtigervnc
Stop the VNC Server
Run the following command on the board to stop the VNC server. In the command, :1 is the display number.
vncserver -kill :1
After the VNC server is stopped, VNC Viewer will disconnect automatically.
VNC Remote Login
Open VNC Viewer on another device and connect using the board's IP address and port.
① : Enter the board's IP address and port
② : Click Connect to address ··· to connect to the board
① : Enter the VNC password
② : Check Remember password to save the password for next time
③ : Click OK to connect
If the VNC session shows a black screen, check whether auto-login is enabled. If it is enabled, disable auto-login.