From b516070da41507b3f80bdbb96aa0952ee3176f02 Mon Sep 17 00:00:00 2001 From: Dmitry Maksyoma Date: Thu, 20 Mar 2025 19:29:10 +1300 Subject: [PATCH] KASM-3747 Document systemd auto-start in README --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 4f89163..88239de 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ sudo dnf localinstall ./kasmvncserver_*.rpm sudo usermod -a -G kasmvnc-cert $USER ``` + ## Getting Started The following examples provide basic usage of KasmVNC with the tools provided. For full documentation on all the utilities and the runtime environment, see our [KasmVNC Documentation](https://www.kasmweb.com/kasmvnc/docs/latest/index.html) @@ -70,6 +71,21 @@ vncserver -list vncserver -kill :2 ``` +### Optional systemd auto-start on boot +```sh +# Optionally use systemd to start KasmVNC on boot. +sudo reboot # Needed for systemd to pick up $USER's ssl-cert or kasmvnc-cert group +systemctl --user enable kasmvncserver@:1 # :1 is Xorg DISPLAY number. +systemctl --user start kasmvncserver@:1 + +# You can run multiple KasmVNC instances via systemd by passing a different +# DISPLAY number: +# systemctl --user enable kasmvncserver@:2 +# systemctl --user start kasmvncserver@:2 +# systemctl --user enable kasmvncserver@:3 +# systemctl --user start kasmvncserver@:3 +``` + ## Configuration KasmVNC is configured via YAML based configurations. The server level configuration is at `/etc/kasmvnc/kasmvnc.yaml`. Edits to this file apply to all users. Individual users can override server global configurations by specifying them in their configuration file at `~/.vnc/kasmvnc.yaml`.