2020-04-24 23:36:52 +00:00
|
|
|
{ config, lib, pkgs, ... }:
|
|
|
|
|
|
|
|
with lib;
|
|
|
|
|
|
|
|
let
|
|
|
|
cfg = config.services.syncplay;
|
|
|
|
|
|
|
|
cmdArgs =
|
|
|
|
[ "--port" cfg.port ]
|
|
|
|
++ optionals (cfg.salt != null) [ "--salt" cfg.salt ]
|
2023-05-24 13:37:59 +00:00
|
|
|
++ optionals (cfg.certDir != null) [ "--tls" cfg.certDir ]
|
|
|
|
++ cfg.extraArgs;
|
2020-04-24 23:36:52 +00:00
|
|
|
|
|
|
|
in
|
|
|
|
{
|
|
|
|
options = {
|
|
|
|
services.syncplay = {
|
|
|
|
enable = mkOption {
|
|
|
|
type = types.bool;
|
|
|
|
default = false;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc "If enabled, start the Syncplay server.";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
port = mkOption {
|
2021-08-11 14:56:57 +00:00
|
|
|
type = types.port;
|
2020-04-24 23:36:52 +00:00
|
|
|
default = 8999;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
TCP port to bind to.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
salt = mkOption {
|
|
|
|
type = types.nullOr types.str;
|
|
|
|
default = null;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
Salt to allow room operator passwords generated by this server
|
2023-05-24 13:37:59 +00:00
|
|
|
instance to still work when the server is restarted. The salt will be
|
|
|
|
readable in the nix store and the processlist. If this is not
|
|
|
|
intended use `saltFile` instead. Mutually exclusive with
|
|
|
|
<option>services.syncplay.saltFile</option>.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
saltFile = mkOption {
|
|
|
|
type = types.nullOr types.path;
|
|
|
|
default = null;
|
|
|
|
description = lib.mdDoc ''
|
|
|
|
Path to the file that contains the server salt. This allows room
|
|
|
|
operator passwords generated by this server instance to still work
|
|
|
|
when the server is restarted. `null`, the server doesn't load the
|
|
|
|
salt from a file. Mutually exclusive with
|
|
|
|
<option>services.syncplay.salt</option>.
|
2020-04-24 23:36:52 +00:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
certDir = mkOption {
|
|
|
|
type = types.nullOr types.path;
|
|
|
|
default = null;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
TLS certificates directory to use for encryption. See
|
2022-08-12 12:06:08 +00:00
|
|
|
<https://github.com/Syncplay/syncplay/wiki/TLS-support>.
|
2020-04-24 23:36:52 +00:00
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2023-05-24 13:37:59 +00:00
|
|
|
extraArgs = mkOption {
|
|
|
|
type = types.listOf types.str;
|
|
|
|
default = [ ];
|
|
|
|
description = lib.mdDoc ''
|
|
|
|
Additional arguments to be passed to the service.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
2020-04-24 23:36:52 +00:00
|
|
|
user = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "nobody";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
User to use when running Syncplay.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
group = mkOption {
|
|
|
|
type = types.str;
|
|
|
|
default = "nogroup";
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2020-04-24 23:36:52 +00:00
|
|
|
Group to use when running Syncplay.
|
|
|
|
'';
|
|
|
|
};
|
2022-04-03 18:54:34 +00:00
|
|
|
|
|
|
|
passwordFile = mkOption {
|
|
|
|
type = types.nullOr types.path;
|
|
|
|
default = null;
|
2022-08-12 12:06:08 +00:00
|
|
|
description = lib.mdDoc ''
|
2022-04-03 18:54:34 +00:00
|
|
|
Path to the file that contains the server password. If
|
2022-08-12 12:06:08 +00:00
|
|
|
`null`, the server doesn't require a password.
|
2022-04-03 18:54:34 +00:00
|
|
|
'';
|
|
|
|
};
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
config = mkIf cfg.enable {
|
2023-05-24 13:37:59 +00:00
|
|
|
assertions = [
|
|
|
|
{
|
|
|
|
assertion = cfg.salt == null || cfg.saltFile == null;
|
|
|
|
message = "services.syncplay.salt and services.syncplay.saltFile are mutually exclusive.";
|
|
|
|
}
|
|
|
|
];
|
2020-04-24 23:36:52 +00:00
|
|
|
systemd.services.syncplay = {
|
|
|
|
description = "Syncplay Service";
|
2023-05-24 13:37:59 +00:00
|
|
|
wantedBy = [ "multi-user.target" ];
|
|
|
|
after = [ "network-online.target" ];
|
2020-04-24 23:36:52 +00:00
|
|
|
|
|
|
|
serviceConfig = {
|
|
|
|
User = cfg.user;
|
|
|
|
Group = cfg.group;
|
2023-05-24 13:37:59 +00:00
|
|
|
LoadCredential = lib.optional (cfg.passwordFile != null) "password:${cfg.passwordFile}"
|
|
|
|
++ lib.optional (cfg.saltFile != null) "salt:${cfg.saltFile}";
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
2022-04-03 18:54:34 +00:00
|
|
|
|
|
|
|
script = ''
|
|
|
|
${lib.optionalString (cfg.passwordFile != null) ''
|
|
|
|
export SYNCPLAY_PASSWORD=$(cat "''${CREDENTIALS_DIRECTORY}/password")
|
|
|
|
''}
|
2023-05-24 13:37:59 +00:00
|
|
|
${lib.optionalString (cfg.saltFile != null) ''
|
|
|
|
export SYNCPLAY_SALT=$(cat "''${CREDENTIALS_DIRECTORY}/salt")
|
|
|
|
''}
|
2022-04-27 09:35:20 +00:00
|
|
|
exec ${pkgs.syncplay-nogui}/bin/syncplay-server ${escapeShellArgs cmdArgs}
|
2022-04-03 18:54:34 +00:00
|
|
|
'';
|
2020-04-24 23:36:52 +00:00
|
|
|
};
|
|
|
|
};
|
|
|
|
}
|