nixpkgs/nixos/modules/services/web-apps/komga.nix
éclairevoyant 5abcff7ab1
nixos/komga: fix settings option and default
Use freeform submodule to make default visible in search and
prevent the warning about the old option format being used.
See https://github.com/NixOS/nixpkgs/pull/345594#issuecomment-2506816155
2025-01-12 10:03:33 -05:00

170 lines
4.2 KiB
Nix

{
config,
pkgs,
lib,
...
}:
let
cfg = config.services.komga;
inherit (lib) mkOption mkEnableOption maintainers;
inherit (lib.types)
port
str
bool
submodule
;
settingsFormat = pkgs.formats.yaml { };
in
{
imports = [
(lib.mkRenamedOptionModule
[
"services"
"komga"
"port"
]
[
"services"
"komga"
"settings"
"server"
"port"
]
)
];
options = {
services.komga = {
enable = mkEnableOption "Komga, a free and open source comics/mangas media server";
user = mkOption {
type = str;
default = "komga";
description = "User account under which Komga runs.";
};
group = mkOption {
type = str;
default = "komga";
description = "Group under which Komga runs.";
};
stateDir = mkOption {
type = str;
default = "/var/lib/komga";
description = "State and configuration directory Komga will use.";
};
settings = lib.mkOption {
type = submodule {
freeformType = settingsFormat.type;
options.server.port = mkOption {
type = port;
description = "The port that Komga will listen on.";
default = 8080;
};
};
description = ''
Komga configuration.
See [documentation](https://komga.org/docs/installation/configuration).
'';
};
openFirewall = mkOption {
type = bool;
default = false;
description = "Whether to open the firewall for the port in {option}`services.komga.settings.server.port`.";
};
};
};
config =
let
inherit (lib) mkIf getExe;
in
mkIf cfg.enable {
assertions = [
{
assertion = (cfg.settings.komga.config-dir or cfg.stateDir) == cfg.stateDir;
message = "You must use the `services.komga.stateDir` option to properly configure `komga.config-dir`.";
}
];
networking.firewall.allowedTCPPorts = mkIf cfg.openFirewall [ cfg.settings.server.port ];
users.groups = mkIf (cfg.group == "komga") { komga = { }; };
users.users = mkIf (cfg.user == "komga") {
komga = {
group = cfg.group;
home = cfg.stateDir;
description = "Komga Daemon user";
isSystemUser = true;
};
};
systemd.tmpfiles.settings."10-komga" = {
${cfg.stateDir}.d = {
inherit (cfg) user group;
};
"${cfg.stateDir}/application.yml"."L+" = {
argument = builtins.toString (settingsFormat.generate "application.yml" cfg.settings);
};
};
systemd.services.komga = {
environment = {
KOMGA_CONFIGDIR = cfg.stateDir;
};
description = "Komga is a free and open source comics/mangas media server";
wantedBy = [ "multi-user.target" ];
wants = [ "network-online.target" ];
after = [ "network-online.target" ];
serviceConfig = {
User = cfg.user;
Group = cfg.group;
Type = "simple";
Restart = "on-failure";
ExecStart = getExe pkgs.komga;
StateDirectory = mkIf (cfg.stateDir == "/var/lib/komga") "komga";
RemoveIPC = true;
NoNewPrivileges = true;
CapabilityBoundingSet = "";
SystemCallFilter = [ "@system-service" ];
ProtectSystem = "full";
PrivateTmp = true;
ProtectProc = "invisible";
ProtectClock = true;
ProcSubset = "pid";
PrivateUsers = true;
PrivateDevices = true;
ProtectHostname = true;
ProtectKernelTunables = true;
RestrictAddressFamilies = [
"AF_INET"
"AF_INET6"
"AF_NETLINK"
];
LockPersonality = true;
RestrictNamespaces = true;
ProtectKernelLogs = true;
ProtectControlGroups = true;
ProtectKernelModules = true;
SystemCallArchitectures = "native";
RestrictSUIDSGID = true;
RestrictRealtime = true;
};
};
};
meta.maintainers = with maintainers; [ govanify ];
}