peritia/Nyx-Modules
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: pretty up Module description

Browse source
This commit is contained in:
Peritia 2025-09-22 16:28:29 +02:00
parent 37b85877bb
commit 9fa4c3177d
1 changed files with 16 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

35
Modules/System/Service/vnc-server.nix
View file

@ -1,22 +1,22 @@
# nyx-module/system/service/vnc.nix # TigerVNC Multi-Session Server Module
# #
# Provides: # This module provides:
# - TigerVNC multi-session server as a systemd service # - A systemd service for running a TigerVNC multi-session server
# - Desktop session (.desktop file) for the chosen environment
# - Automatic password hashing at build time (via `vncpasswd -f`) # - Automatic password hashing at build time (via `vncpasswd -f`)
# - Optional firewall rule opening for chosen display port # - Desktop session registration (.desktop file) for the chosen environment
# - Optional firewall opening for the configured display port
# #
# Options: # Configuration Options:
# enable → Enable the VNC server service # enable – Enable the VNC server service (boolean)
# user → System user that owns and runs the VNC server # user – System user that owns and runs the VNC server (string)
# password → Plaintext password (hashed during build) # password – Plaintext password (hashed at build time; first 8 chars significant)
# displayNumber → X display number (e.g. :1 => TCP 5901) # displayNumber – X display number (e.g. `1` → :1 → TCP port 5901)
# openFirewall → Open firewall for the corresponding TCP port # openFirewall – Open the firewall for the selected display port (boolean)
# session → Name of the desktop session (xfce, plasma, etc.) # session – Name of the desktop session (e.g. "xfce", "plasma")
# geometry → Screen resolution (e.g. 1920x1080) # geometry – Default screen resolution (e.g. "1920x1080")
# sessionCommand→ Command to start the X session # sessionCommand – Command to start the X session (full path)
# #
# Example: # Example Usage:
# nyx-module.system.service.vnc = { # nyx-module.system.service.vnc = {
# enable = true; # enable = true;
# user = "myuser"; # user = "myuser";
@ -25,10 +25,7 @@
# geometry = "1280x800"; # geometry = "1280x800";
# }; # };
# #
# After enabling, run:
# sudo nixos-rebuild switch
# sudo systemctl enable --now vncserver
#
{ {
config, config,
pkgs, pkgs,