View source for How to setup x11vnc server

[[How to setup x11vnc server/zh|查看中文]]

== Scope of this document ==
* Ubuntu Focal Desktop system on RK3399/RK3568/RK3588 platforms
* Debian Bullseye Desktop system on RK3588 platform
* For FriendlyDesktop on RK3399 platform, refer to [[How to setup VNC server on NanoPC-T4|How to setup VNC server on NanoPC-T4]]

== Step 1: Install x11vnc ==
<syntaxhighlight lang="bash">
sudo apt update
sudo apt-get install x11vnc net-tools
</syntaxhighlight>

== Step 2: Set password ==
<syntaxhighlight lang="bash">
su pi
x11vnc -storepasswd
</syntaxhighlight>

== Step 3: Create .Xauthority ==
<syntaxhighlight lang="bash">
touch /home/pi/.Xauthority
xauth add :0 . `mcookie`
</syntaxhighlight>

== Step 4: Configure automatic desktop login ==
=== For Ubuntu Focal Desktop ===
Create directory and file
<syntaxhighlight lang="bash">
sudo mkdir /etc/sddm.conf.d
sudo vim /etc/sddm.conf.d/autologin
</syntaxhighlight>
Content of autologin file:
<syntaxhighlight lang="ini">
[Autologin]
User=pi
Session=lxqt.desktop
Relogin=false
</syntaxhighlight>
Restart.

=== For Debian Bullseye Desktop ===
By default, automatic login is enabled. Check configuration with the following file:
<syntaxhighlight lang="bash">
$ grep autologin-user /etc/lightdm/lightdm.conf
# autologin-user = User to log in with by default (overrides autologin-guest)
# autologin-user-timeout = Number of seconds to wait before loading default user
autologin-user=pi
autologin-user-timeout=0
</syntaxhighlight>

== Step 5: Run x11vnc at startup ==
Create file /etc/systemd/system/x11vnc.service
<syntaxhighlight lang="ini">
sudo vim /etc/systemd/system/x11vnc.service
</syntaxhighlight>
Content of x11vnc.service:
<syntaxhighlight lang="ini">
[Unit]
Description=Start x11vnc at startup.
After=network-online.target

[Service]
Type=simple
ExecStart=/usr/bin/x11vnc -display :0 -auth /home/pi/.Xauthority -rfbauth /home/pi/.vnc/passwd -rfbport 5900 -forever -loop -noxdamage -repeat -shared -capslock -nomodtweak
User=pi
Group=pi
WorkingDirectory=/home/pi
ExecStop=/bin/kill -TERM $MAINPID
ExecReload=/bin/kill -HUP $MAINPID
KillMode=control-group
Restart=on-failure
Environment=DISPLAY=:0
Environment=XAUTHORITY=/home/pi/.Xauthority

[Install]
WantedBy=graphical.target
</syntaxhighlight>
Enable systemd service
<syntaxhighlight lang="bash">
sudo systemctl daemon-reload
sudo systemctl restart x11vnc.service
</syntaxhighlight>

== Step 6: Access from a computer ==
Use VNC client to access the following address:<br />
Board IP:5900