KASM-3747 Document systemd auto-start in README

This commit is contained in:
Dmitry Maksyoma 2025-03-20 19:29:10 +13:00
parent 82a5d5170e
commit b516070da4
No known key found for this signature in database

View file

@ -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`.