nixos/rkvm: init (f3ad4def) · Commits · nix / nixpkgs

nixos/modules/module-list.nix

+1 −0

Original line number	Diff line number	Diff line
		@@ -706,6 +706,7 @@
		./services/misc/ripple-data-api.nix
		./services/misc/rippled.nix
		./services/misc/rmfakecloud.nix
		./services/misc/rkvm.nix
		./services/misc/rshim.nix
		./services/misc/safeeyes.nix
		./services/misc/sdrplay.nix

nixos/modules/services/misc/rkvm.nix

0 → 100644

+164 −0

Original line number	Diff line number	Diff line
		{ options, config, pkgs, lib, ... }:

		with lib;
		let
		opt = options.services.rkvm;
		cfg = config.services.rkvm;
		toml = pkgs.formats.toml { };
		in
		{
		meta.maintainers = with maintainers; [ ckie ];

		options.services.rkvm = {
		enable = mkOption {
		default = cfg.server.enable \|\| cfg.client.enable;
		defaultText = literalExpression "config.${opt.server.enable} \|\| config.${opt.client.enable}";
		type = types.bool;
		description = mdDoc ''
		Whether to enable rkvm, a Virtual KVM switch for Linux machines.
		'';
		};

		package = mkPackageOption pkgs "rkvm" { };

		server = {
		enable = mkEnableOption "the rkvm server daemon (input transmitter)";

		settings = mkOption {
		type = types.submodule
		{
		freeformType = toml.type;
		options = {
		listen = mkOption {
		type = types.str;
		default = "0.0.0.0:5258";
		description = mdDoc ''
		An internet socket address to listen on, either IPv4 or IPv6.
		'';
		};

		switch-keys = mkOption {
		type = types.listOf types.str;
		default = [ "left-alt" "left-ctrl" ];
		description = mdDoc ''
		A key list specifying a host switch combination.

		_A list of key names is available in <https://github.com/htrefil/rkvm/blob/master/switch-keys.md>._
		'';
		};

		certificate = mkOption {
		type = types.path;
		default = "/etc/rkvm/certificate.pem";
		description = mdDoc ''
		TLS certificate path.

		::: {.note}
		This should be generated with {command}`rkvm-certificate-gen`.
		:::
		'';
		};

		key = mkOption {
		type = types.path;
		default = "/etc/rkvm/key.pem";
		description = mdDoc ''
		TLS key path.

		::: {.note}
		This should be generated with {command}`rkvm-certificate-gen`.
		:::
		'';
		};

		password = mkOption {
		type = types.str;
		description = mdDoc ''
		Shared secret token to authenticate the client.
		Make sure this matches your client's config.
		'';
		};
		};
		};

		default = { };
		description = mdDoc "Structured server daemon configuration";
		};
		};

		client = {
		enable = mkEnableOption "the rkvm client daemon (input receiver)";

		settings = mkOption {
		type = types.submodule
		{
		freeformType = toml.type;
		options = {
		server = mkOption {
		type = types.str;
		example = "192.168.0.123:5258";
		description = mdDoc ''
		An RKVM server's internet socket address, either IPv4 or IPv6.
		'';
		};

		certificate = mkOption {
		type = types.path;
		default = "/etc/rkvm/certificate.pem";
		description = mdDoc ''
		TLS ceritficate path.

		::: {.note}
		This should be generated with {command}`rkvm-certificate-gen`.
		:::
		'';
		};

		password = mkOption {
		type = types.str;
		description = mdDoc ''
		Shared secret token to authenticate the client.
		Make sure this matches your server's config.
		'';
		};
		};
		};

		default = {};
		description = mdDoc "Structured client daemon configuration";
		};
		};

		};

		config = mkIf cfg.enable {
		environment.systemPackages = [ cfg.package ];

		systemd.services =
		let
		mkBase = component: {
		description = "RKVM ${component}";
		wantedBy = [ "multi-user.target" ];
		after = {
		server = [ "network.target" ];
		client = [ "network-online.target" ];
		}.${component};
		wants = {
		server = [ ];
		client = [ "network-online.target" ];
		}.${component};
		serviceConfig = {
		ExecStart = "${cfg.package}/bin/rkvm-${component} ${toml.generate "rkvm-${component}.toml" cfg.${component}.settings}";
		Restart = "always";
		RestartSec = 5;
		Type = "simple";
		};
		};
		in
		{
		rkvm-server = mkIf cfg.server.enable (mkBase "server");
		rkvm-client = mkIf cfg.client.enable (mkBase "client");
		};
		};

		}

Admin message