配置适用于 ArchLinux KDE 桌面环境的 KasmVNC

安装基于 X11 的 KDE 桌面环境#

https://wiki.archlinux.org/title/KDE
https://archlinux.org/news/plasma-640-will-need-manual-intervention-if-you-are-on-x11/

1
sudo pacman -S plasma-meta plasma-x11-session konsole dolphin pipewire

安装 KasmVNC#

使用 AUR 安装

1
yay -S kasmvncserver-bin openssl-1.1

生成初始配置

1
kasmvncserver

选择手动设置密码 (键入选项 1)
完成后, 会出现文件 ~/.kasmpasswd

配置 KasmVNC#

https://kasmweb.com/kasmvnc/docs/1.0.0/configuration.html

修改如下位置的配置文件

1
/etc/kasmvnc/kasmvnc.yaml

如下配置文件会在 59000 端口开启外部可访问的 WebVNC

1
network:
2
  protocol: http
3
  interface: 0.0.0.0
4
  websocket_port: 59000
5
  use_ipv4: true
6
  use_ipv6: true
7
  udp:
8
    public_ip: auto
9
    port: auto
10
    payload_size: auto
11
    stun_server: auto
12
  ssl:
13
    pem_certificate: /etc/ssl/certs/ssl-cert-snakeoil.pem
14
    pem_key: /etc/ssl/private/ssl-cert-snakeoil.key
15
    require_ssl: false

当 network.ssl.require_ssl 为 false 时允许 HTTP 访问, 但是仍需要指定同级配置下的 pem_key 与 pem_certificate

要使用 openssl 生成 key 与 certificate, 请使用如下命令生成有效期 90 天的 RSA 4096bit 证书至默认位置:

1
sudo openssl req -x509 -nodes -days 90 -newkey rsa:4096 \
2
  -keyout /etc/ssl/private/ssl-cert-snakeoil.key \
3
  -out /etc/ssl/certs/ssl-cert-snakeoil.pem \
4
  -subj "/C=CN/ST=Default/L=Default/O=KasmVNC/CN=${HOST:default-host}"
5

6
sudo chmod 644 /etc/ssl/certs/ssl-cert-snakeoil.pem
7
sudo chmod 600 /etc/ssl/private/ssl-cert-snakeoil.key

SEE ALSO#
要使 Caddy 反向代理忽略 TLS 证书有效性, 请使用:
1
reverse_proxy https://<url> {
2
    transport http {
3
        tls_insecure_skip_verify
4
    }
5
}

配置 VNC 启动脚本#

打开如下位置脚本文件

1
~/.vnc/xstartup

写入如下脚本内容

1
#!/bin/bash
2
unset DBUS_SESSION_BUS_ADDRESS
3
unset SESSION_MANAGER
4

5
export XDG_RUNTIME_DIR="/run/user/$(id -u)"
6
mkdir -p "$XDG_RUNTIME_DIR"
7
chmod 700 "$XDG_RUNTIME_DIR"
8

9
export KWIN_COMPOSE=O2  # use OpenGL 2 as render, change it in need
10
export XDG_CURRENT_DESKTOP="KDE"
11

12
launch_session() {
13
    pipewire &
14
    pipewire-pulse &
15
    wireplumber &
16

17
    exec startplasma-x11
18
}
19

20
export -f launch_session
21

22
# launch with dbus
23
exec dbus-run-session bash -c launch_session

尝试运行#

运行如下命令后, 会在上方配置的 network.websocket_port 端口启动位于 X11 的 DISPLAY 0 的 WebVNC

1
kasmvncserver :0

如果该命令较长时间未能成功, 或显示 Failed to get public IP, please specify it with -publicIP 字样, 请修改配置文件的 network.udp.public_ip 字段, 或在启动 kasmvncserver 时使用 -publicIP <public-ipaddr> 指定公网 IP 地址 (没有者尝试填写内网地址)

经测试: 位于反向代理后的 KasmVNC 将 network.udp.public_ip 字段配置为内网地址是通过反向代理访问的

使用 systemd 开机自启动服务#

以免用户服务在 SSH 终止后退出

1
loginctl enable-linger lovemilk

写入如下位置文件 (文件(夹)不存在就创建)

1
~/.config/systemd/user/kasmvnc.service

1
[Unit]
2
Description=KasmVNC Service for <username>
3
After=network.target
4

5
[Service]
6
Type=simple
7

8
Environment="XDG_SESSION_TYPE=x11"
9
Environment="XDG_CURRENT_DESKTOP=KDE"
10
ExecStart=/usr/bin/bash -c "/usr/bin/kasmvncserver :0 -fg"
11

12
Restart=on-failure
13
RestartSec=5
14

15
[Install]
16
WantedBy=default.target

使 Systemd 刷新出该服务

1
systemctl --user daemon-reload

启用并启动该服务

1
systemctl --user enable --now kasmvnc.service