8.nix-darwin/modules/services/synergy/default.nix
Emily 7877cba5f5 launchd: move userLaunchd to system activation
I’m not *completely* certain that this handles user agents
correctly. There is a deprecated command, `launchctl asuser`, that
executes a command in the Mach bootstrap context of another user`.
<https://scriptingosx.com/2020/08/running-a-command-as-another-user/>
claims that this is required when loading and unloading user agents,
but I haven’t tested this. Our current launchd agent logic is pretty
weird and broken already anyway, so unless this actively regresses
things I’d lean towards keeping it like this until we can move
over entirely to `launchctl bootstrap`/`launchctl kickstart`, which
aren’t deprecated and can address individual users directly. Someone
should definitely test it more extensively than I have, though.
2025-05-16 16:29:17 +01:00

153 lines
4.9 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.synergy;
in
{
options = {
services.synergy = {
package = mkOption {
default = pkgs.synergy;
defaultText = "pkgs.synergy";
type = types.package;
description = "The package used for the synergy client and server.";
};
client = {
enable = mkOption {
default = false;
type = types.bool;
description = ''
Whether to enable the Synergy client (receive keyboard and mouse events from a Synergy server).
'';
};
screenName = mkOption {
default = "";
type = types.str;
description = ''
Use the given name instead of the hostname to identify
ourselves to the server.
'';
};
serverAddress = mkOption {
type = types.str;
description = ''
The server address is of the form: [hostname][:port]. The
hostname must be the address or hostname of the server. The
port overrides the default port, 24800.
'';
};
autoStart = mkOption {
default = true;
type = types.bool;
description = "Whether the Synergy client should be started automatically.";
};
tls = {
enable = mkEnableOption ''
Whether TLS encryption should be used.
Using this requires a TLS certificate that can be
generated by starting the Synergy GUI once and entering
a valid product key'';
cert = mkOption {
type = types.nullOr types.str;
default = null;
example = "~/.synergy/SSL/Synergy.pem";
description = "The TLS certificate to use for encryption.";
};
};
};
server = {
enable = mkOption {
default = false;
type = types.bool;
description = ''
Whether to enable the Synergy server (send keyboard and mouse events).
'';
};
configFile = mkOption {
default = "/etc/synergy-server.conf";
type = types.str;
description = "The Synergy server configuration file.";
};
screenName = mkOption {
default = "";
type = types.str;
description = ''
Use the given name instead of the hostname to identify
this screen in the configuration.
'';
};
address = mkOption {
default = "";
type = types.str;
description = "Address on which to listen for clients.";
};
autoStart = mkOption {
default = true;
type = types.bool;
description = "Whether the Synergy server should be started automatically.";
};
tls = {
enable = mkEnableOption ''
Whether TLS encryption should be used.
Using this requires a TLS certificate that can be
generated by starting the Synergy GUI once and entering
a valid product key'';
cert = mkOption {
type = types.nullOr types.str;
default = null;
example = "~/.synergy/SSL/Synergy.pem";
description = "The TLS certificate to use for encryption.";
};
};
};
};
};
config = mkMerge [
(mkIf cfg.client.enable {
launchd.user.agents."synergy-client" = {
path = [ config.environment.systemPath ];
serviceConfig.ProgramArguments = [
"${cfg.package}/bin/synergyc" "-f"
] ++ optionals (cfg.client.tls.enable) [ "--enable-crypto" ]
++ optionals (cfg.client.tls.cert != null) [ "--tls-cert" cfg.client.tls.cert ]
++ optionals (cfg.client.screenName != "") [ "-n" cfg.client.screenName ]
++ [
cfg.client.serverAddress
];
serviceConfig.KeepAlive = true;
serviceConfig.RunAtLoad = cfg.client.autoStart;
serviceConfig.ProcessType = "Interactive";
managedBy = "services.synergy.client.enable";
};
})
(mkIf cfg.server.enable {
launchd.user.agents."synergy-server" = {
path = [ config.environment.systemPath ];
serviceConfig.ProgramArguments = [
"${cfg.package}/bin/synergys" "-c" "${cfg.server.configFile}" "-f"
] ++ optionals (cfg.server.tls.enable) [ "--enable-crypto" ]
++ optionals (cfg.server.tls.cert != null) [ "--tls-cert" cfg.server.tls.cert ]
++ optionals (cfg.server.screenName != "") [ "-n" cfg.server.screenName ]
++ optionals (cfg.server.address != "") [ "-a" cfg.server.address ];
serviceConfig.KeepAlive = true;
serviceConfig.RunAtLoad = cfg.server.autoStart;
serviceConfig.ProcessType = "Interactive";
managedBy = "services.synergy.server.enable";
};
})
];
}