2023-08-10 07:59:29 +00:00
|
|
|
{ config, lib, pkgs, ... }:
|
|
|
|
|
|
|
|
let
|
|
|
|
cfg = config.services.eris-server;
|
|
|
|
stateDirectoryPath = "\${STATE_DIRECTORY}";
|
2024-01-13 08:15:51 +00:00
|
|
|
nullOrStr = with lib.types; nullOr str;
|
2023-08-10 07:59:29 +00:00
|
|
|
in {
|
|
|
|
|
|
|
|
options.services.eris-server = {
|
|
|
|
|
|
|
|
enable = lib.mkEnableOption "an ERIS server";
|
|
|
|
|
|
|
|
package = lib.mkOption {
|
|
|
|
type = lib.types.package;
|
|
|
|
default = pkgs.eris-go;
|
|
|
|
defaultText = lib.literalExpression "pkgs.eris-go";
|
|
|
|
description = "Package to use for the ERIS server.";
|
|
|
|
};
|
|
|
|
|
|
|
|
decode = lib.mkOption {
|
|
|
|
type = lib.types.bool;
|
|
|
|
default = false;
|
|
|
|
description = ''
|
|
|
|
Whether the HTTP service (when enabled) will decode ERIS content at /uri-res/N2R?urn:eris:.
|
|
|
|
Enabling this is recommended only for private or local-only servers.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
listenCoap = lib.mkOption {
|
2024-01-13 08:15:51 +00:00
|
|
|
type = nullOrStr;
|
2023-08-10 07:59:29 +00:00
|
|
|
default = ":5683";
|
|
|
|
example = "[::1]:5683";
|
|
|
|
description = ''
|
|
|
|
Server CoAP listen address. Listen on all IP addresses at port 5683 by default.
|
|
|
|
Please note that the server can service client requests for ERIS-blocks by
|
|
|
|
querying other clients connected to the server. Whether or not blocks are
|
|
|
|
relayed back to the server depends on client configuration but be aware this
|
|
|
|
may leak sensitive metadata and trigger network activity.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
listenHttp = lib.mkOption {
|
2024-01-13 08:15:51 +00:00
|
|
|
type = nullOrStr;
|
|
|
|
default = null;
|
2023-08-10 07:59:29 +00:00
|
|
|
example = "[::1]:8080";
|
|
|
|
description = "Server HTTP listen address. Do not listen by default.";
|
|
|
|
};
|
|
|
|
|
|
|
|
backends = lib.mkOption {
|
|
|
|
type = with lib.types; listOf str;
|
|
|
|
description = ''
|
|
|
|
List of backend URLs.
|
|
|
|
Add "get" and "put" as query elements to enable those operations.
|
|
|
|
'';
|
|
|
|
example = [
|
|
|
|
"bolt+file:///srv/eris.bolt?get&put"
|
|
|
|
"coap+tcp://eris.example.com:5683?get"
|
|
|
|
];
|
|
|
|
};
|
|
|
|
|
|
|
|
mountpoint = lib.mkOption {
|
2024-01-13 08:15:51 +00:00
|
|
|
type = nullOrStr;
|
|
|
|
default = null;
|
2023-08-10 07:59:29 +00:00
|
|
|
example = "/eris";
|
|
|
|
description = ''
|
|
|
|
Mountpoint for FUSE namespace that exposes "urn:eris:…" files.
|
|
|
|
'';
|
|
|
|
};
|
|
|
|
|
|
|
|
};
|
|
|
|
|
|
|
|
config = lib.mkIf cfg.enable {
|
2024-01-13 08:15:51 +00:00
|
|
|
assertions = [{
|
|
|
|
assertion = lib.strings.versionAtLeast cfg.package.version "20231219";
|
|
|
|
message =
|
|
|
|
"Version of `config.services.eris-server.package` is incompatible with this module";
|
|
|
|
}];
|
|
|
|
|
2023-08-10 07:59:29 +00:00
|
|
|
systemd.services.eris-server = let
|
2024-01-13 08:15:51 +00:00
|
|
|
cmd = "${cfg.package}/bin/eris-go server"
|
|
|
|
+ (lib.optionalString (cfg.listenCoap != null)
|
|
|
|
" --coap '${cfg.listenCoap}'")
|
|
|
|
+ (lib.optionalString (cfg.listenHttp != null)
|
|
|
|
" --http '${cfg.listenHttp}'")
|
|
|
|
+ (lib.optionalString cfg.decode " --decode")
|
|
|
|
+ (lib.optionalString (cfg.mountpoint != null)
|
|
|
|
" --mountpoint '${cfg.mountpoint}'");
|
2023-08-10 07:59:29 +00:00
|
|
|
in {
|
|
|
|
description = "ERIS block server";
|
|
|
|
after = [ "network.target" ];
|
|
|
|
wantedBy = [ "multi-user.target" ];
|
2024-01-13 08:15:51 +00:00
|
|
|
environment.ERIS_STORE_URL = toString cfg.backends;
|
|
|
|
script = lib.mkIf (cfg.mountpoint != null) ''
|
2023-08-10 07:59:29 +00:00
|
|
|
export PATH=${config.security.wrapperDir}:$PATH
|
|
|
|
${cmd}
|
|
|
|
'';
|
|
|
|
serviceConfig = let
|
2024-01-13 08:15:51 +00:00
|
|
|
umounter = lib.mkIf (cfg.mountpoint != null)
|
2023-08-10 07:59:29 +00:00
|
|
|
"-${config.security.wrapperDir}/fusermount -uz ${cfg.mountpoint}";
|
2024-01-13 08:15:51 +00:00
|
|
|
in if (cfg.mountpoint == null) then {
|
|
|
|
ExecStart = cmd;
|
|
|
|
} else
|
|
|
|
{
|
|
|
|
ExecStartPre = umounter;
|
|
|
|
ExecStopPost = umounter;
|
|
|
|
} // {
|
|
|
|
Restart = "always";
|
|
|
|
RestartSec = 20;
|
|
|
|
AmbientCapabilities = "CAP_NET_BIND_SERVICE";
|
|
|
|
};
|
2023-08-10 07:59:29 +00:00
|
|
|
};
|
|
|
|
};
|
|
|
|
|
|
|
|
meta.maintainers = with lib.maintainers; [ ehmry ];
|
|
|
|
}
|