Files
nixarr/nixarr/jellyseerr/default.nix
T
2025-06-03 14:41:33 +02:00

264 lines
7.4 KiB
Nix

{
config,
lib,
pkgs,
...
}:
with lib; let
cfg = config.nixarr.jellyseerr;
globals = config.util-nixarr.globals;
nixarr = config.nixarr;
port = 5055;
in {
options.nixarr.jellyseerr = {
enable = mkOption {
type = types.bool;
default = false;
example = true;
description = ''
Whether or not to enable the Jellyseerr service.
'';
};
package = mkPackageOption pkgs "jellyseerr" {};
stateDir = mkOption {
type = types.path;
default = "${nixarr.stateDir}/jellyseerr";
defaultText = literalExpression ''"''${nixarr.stateDir}/jellyseerr"'';
example = "/nixarr/.state/jellyseerr";
description = ''
The location of the state directory for the Jellyseerr service.
> **Warning:** Setting this to any path, where the subpath is not
> owned by root, will fail! For example:
>
> ```nix
> stateDir = /home/user/nixarr/.state/jellyseerr
> ```
>
> Is not supported, because `/home/user` is owned by `user`.
'';
};
port = mkOption {
type = types.port;
default = port;
example = 12345;
description = "Jellyseerr web-UI port.";
};
openFirewall = mkOption {
type = types.bool;
defaultText = literalExpression ''!nixarr.jellyseerr.vpn.enable'';
default = !cfg.vpn.enable;
example = true;
description = "Open firewall for Jellyseerr";
};
vpn.enable = mkOption {
type = types.bool;
default = false;
example = true;
description = ''
**Required options:** [`nixarr.vpn.enable`](#nixarr.vpn.enable)
**Conflicting options:** [`nixarr.jellyseerr.expose.https.enable`](#nixarr.jellyseerr.expose.https.enable)
Route Jellyseerr traffic through the VPN.
'';
};
expose = {
https = {
enable = mkOption {
type = types.bool;
default = false;
example = true;
description = ''
**Required options:**
- [`nixarr.jellyseerr.expose.https.acmeMail`](#nixarr.jellyseerr.expose.https.acmemail)
- [`nixarr.jellyseerr.expose.https.domainName`](#nixarr.jellyseerr.expose.https.domainname)
**Conflicting options:** [`nixarr.jellyseerr.vpn.enable`](#nixarr.jellyseerr.vpn.enable)
Expose the Jellyseerr web service to the internet with https support,
allowing anyone to access it.
> **Warning:** Do _not_ enable this without setting up Jellyseerr
> authentication through localhost first!
'';
};
upnp.enable = mkEnableOption "UPNP to try to open ports 80 and 443 on your router.";
domainName = mkOption {
type = types.nullOr types.str;
default = null;
example = "jellyseerr.example.com";
description = "The domain name to host Jellyseerr on.";
};
acmeMail = mkOption {
type = types.nullOr types.str;
default = null;
example = "mail@example.com";
description = "The ACME mail required for the letsencrypt bot.";
};
};
};
};
config = mkIf (nixarr.enable && cfg.enable) {
assertions = [
{
assertion = cfg.vpn.enable -> nixarr.vpn.enable;
message = ''
The nixarr.jellyseerr.vpn.enable option requires the
nixarr.vpn.enable option to be set, but it was not.
'';
}
{
assertion = !(cfg.vpn.enable && cfg.expose.https.enable);
message = ''
The nixarr.jellyseerr.vpn.enable option conflicts with the
nixarr.jellyseerr.expose.https.enable option. You cannot set both.
'';
}
{
assertion =
cfg.expose.https.enable
-> (
(cfg.expose.https.domainName != null)
&& (cfg.expose.https.acmeMail != null)
);
message = ''
The nixarr.jellyseerr.expose.https.enable option requires the
following options to be set, but one of them were not:
- nixarr.jellyseerr.expose.https.domainName
- nixarr.jellyseerr.expose.https.acmeMail
'';
}
];
systemd.tmpfiles.rules = [
"d '${cfg.stateDir}' 0700 ${globals.jellyseerr.user} root - -"
];
systemd.services.jellyseerr = {
description = "Jellyseerr, a requests manager for Jellyfin";
after = ["network.target"];
wantedBy = ["multi-user.target"];
environment = {
PORT = toString cfg.port;
CONFIG_DIRECTORY = cfg.stateDir;
};
serviceConfig = {
Type = "exec";
StateDirectory = "jellyseerr";
DynamicUser = false;
User = globals.jellyseerr.user;
Group = globals.jellyseerr.group;
ExecStart = lib.getExe cfg.package;
Restart = "on-failure";
# Security
ProtectHome = true;
PrivateTmp = true;
PrivateDevices = true;
ProtectHostname = true;
ProtectClock = true;
ProtectKernelTunables = true;
ProtectKernelModules = true;
ProtectKernelLogs = true;
ProtectControlGroups = true;
NoNewPrivileges = true;
RestrictRealtime = true;
RestrictSUIDSGID = true;
RemoveIPC = true;
PrivateMounts = true;
ProtectSystem = "strict";
ReadWritePaths = [cfg.stateDir];
};
};
users = {
groups.${globals.jellyseerr.group}.gid = globals.gids.${globals.jellyseerr.group};
users.${globals.jellyseerr.user} = {
isSystemUser = true;
group = globals.jellyseerr.group;
uid = globals.uids.${globals.jellyseerr.user};
};
};
networking.firewall = mkIf cfg.expose.https.enable {
allowedTCPPorts = [80 443];
};
util-nixarr.upnp = mkIf cfg.expose.https.upnp.enable {
enable = true;
openTcpPorts = [80 443];
};
services.nginx = mkMerge [
(mkIf (cfg.expose.https.enable || cfg.vpn.enable) {
enable = true;
recommendedTlsSettings = true;
recommendedOptimisation = true;
recommendedGzipSettings = true;
})
(mkIf cfg.expose.https.enable {
virtualHosts."${builtins.replaceStrings ["\n"] [""] cfg.expose.https.domainName}" = {
enableACME = true;
forceSSL = true;
locations."/" = {
recommendedProxySettings = true;
proxyWebsockets = true;
proxyPass = "http://127.0.0.1:${builtins.toString cfg.port}";
};
};
})
(mkIf cfg.vpn.enable {
virtualHosts."127.0.0.1:${builtins.toString cfg.port}" = {
listen = [
{
addr = "0.0.0.0";
port = cfg.port;
}
];
locations."/" = {
recommendedProxySettings = true;
proxyWebsockets = true;
proxyPass = "http://192.168.15.1:${builtins.toString cfg.port}";
};
};
})
];
security.acme = mkIf cfg.expose.https.enable {
acceptTerms = true;
defaults.email = cfg.expose.https.acmeMail;
};
# Enable and specify VPN namespace to confine service in.
systemd.services.jellyseerr.vpnConfinement = mkIf cfg.vpn.enable {
enable = true;
vpnNamespace = "wg";
};
# Port mappings
vpnNamespaces.wg = mkIf cfg.vpn.enable {
portMappings = [
{
from = cfg.port;
to = cfg.port;
}
];
};
};
}