nixpkgs/nixos/modules/services/monitoring/rustdesk-server.nix
2024-06-14 02:41:42 -04:00

109 lines
3.2 KiB
Nix

{ lib, pkgs, config, ... }:
let
TCPPorts = [21115 21116 21117 21118 21119];
UDPPorts = [21116];
in {
options.services.rustdesk-server = with lib; with types; {
enable = mkEnableOption "RustDesk, a remote access and remote control software, allowing maintenance of computers and other devices";
package = mkPackageOption pkgs "rustdesk-server" {};
openFirewall = mkOption {
type = types.bool;
default = false;
description = ''
Open the connection ports.
TCP (${lib.concatStringsSep ", " (map toString TCPPorts)})
UDP (${lib.concatStringsSep ", " (map toString UDPPorts)})
'';
};
relayIP = mkOption {
type = str;
description = ''
The public facing IP of the RustDesk relay.
'';
};
extraSignalArgs = mkOption {
type = listOf str;
default = [];
example = [ "-k" "_" ];
description = ''
A list of extra command line arguments to pass to the `hbbs` process.
'';
};
extraRelayArgs = mkOption {
type = listOf str;
default = [];
example = [ "-k" "_" ];
description = ''
A list of extra command line arguments to pass to the `hbbr` process.
'';
};
};
config = let
cfg = config.services.rustdesk-server;
serviceDefaults = {
enable = true;
requiredBy = [ "rustdesk.target" ];
serviceConfig = {
Slice = "system-rustdesk.slice";
User = "rustdesk";
Group = "rustdesk";
DynamicUser = "yes";
Environment = [];
WorkingDirectory = "/var/lib/rustdesk";
StateDirectory = "rustdesk";
StateDirectoryMode = "0750";
LockPersonality = true;
PrivateDevices = true;
PrivateMounts = true;
PrivateUsers = true;
ProtectClock = true;
ProtectControlGroups = true;
ProtectHome = true;
ProtectHostname = true;
ProtectKernelLogs = true;
ProtectKernelModules = true;
ProtectKernelTunables = true;
ProtectProc = "invisible";
RestrictNamespaces = true;
};
};
in lib.mkIf cfg.enable {
users.users.rustdesk = {
description = "System user for RustDesk";
isSystemUser = true;
group = "rustdesk";
};
users.groups.rustdesk = {};
networking.firewall.allowedTCPPorts = lib.mkIf cfg.openFirewall TCPPorts;
networking.firewall.allowedUDPPorts = lib.mkIf cfg.openFirewall UDPPorts;
systemd.slices.system-rustdesk = {
enable = true;
description = "Slice designed to contain RustDesk Signal & RustDesk Relay";
};
systemd.targets.rustdesk = {
enable = true;
description = "Target designed to group RustDesk Signal & RustDesk Relay";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
};
systemd.services.rustdesk-signal = lib.mkMerge [ serviceDefaults {
serviceConfig.ExecStart = "${cfg.package}/bin/hbbs -r ${cfg.relayIP} ${lib.escapeShellArgs cfg.extraSignalArgs}";
} ];
systemd.services.rustdesk-relay = lib.mkMerge [ serviceDefaults {
serviceConfig.ExecStart = "${cfg.package}/bin/hbbr ${lib.escapeShellArgs cfg.extraRelayArgs}";
} ];
};
meta.maintainers = with lib.maintainers; [ ppom ];
}