blob: faeb5065030805ef9612956a7544414354af4fbd (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
{
config,
lib,
pkgs,
...
}:
let
inherit (lib)
getExe
maintainers
mkEnableOption
mkIf
mkOption
mkPackageOption
;
inherit (lib.types)
bool
path
port
str
submodule
;
cfg = config.services.qui;
stateDir = "/var/lib/qui";
configFormat = pkgs.formats.toml { };
configFile = configFormat.generate "qui.toml" cfg.settings;
in
{
options = {
services.qui = {
enable = mkEnableOption "qui";
package = mkPackageOption pkgs "qui" { };
user = mkOption {
type = str;
default = "qui";
description = "User to run qui as.";
};
group = mkOption {
type = str;
default = "qui";
example = "torrents";
description = "Group to run qui as.";
};
openFirewall = mkOption {
type = bool;
default = false;
description = "Whether or not to open ports in the firewall for qui.";
};
secretFile = mkOption {
type = path;
example = "/run/secrets/qui-session.txt";
description = ''
Path to a file that contains the session secret. The session secret
can be generated with `openssl rand -hex 32`.
'';
};
settings = mkOption {
default = { };
example = {
port = 7777;
logLevel = "DEBUG";
metricsEnabled = true;
};
type = submodule {
freeformType = configFormat.type;
options = {
host = mkOption {
type = str;
default = "127.0.0.1";
description = "The host address qui listens on.";
};
port = mkOption {
type = port;
default = 7476;
description = "The port qui listens on.";
};
};
};
description = ''
qui configuration options.
Refer to the [template config](https://github.com/autobrr/qui/blob/main/internal/config/config.go)
in the source code for the available options.
The documentation contains the available [environment variables](https://getqui.com/docs/configuration/environment/),
this can be used to get an overview.
'';
};
};
};
config = mkIf cfg.enable {
assertions = [
{
assertion = !(cfg.settings ? sessionSecret);
message = ''
Session secrets should not be passed via settings, as
these are stored in the world-readable nix store.
Use the secretFile option instead.'';
}
];
systemd.services.qui = {
description = "qui: alternative qBittorrent webUI";
after = [ "network-online.target" ];
wants = [ "network-online.target" ];
wantedBy = [ "multi-user.target" ];
serviceConfig = {
Type = "simple";
User = cfg.user;
Group = cfg.group;
LoadCredential = "sessionSecret:${cfg.secretFile}";
Environment = [ "QUI__SESSION_SECRET_FILE=%d/sessionSecret" ];
StateDirectory = "qui";
ExecStartPre = ''
${pkgs.coreutils}/bin/install -m 600 '${configFile}' '%S/qui/config.toml'
'';
ExecStart = "${getExe cfg.package} serve --config-dir %S/qui";
Restart = "on-failure";
# Based on qbittorrent and nemorosa hardening settings
# Similar to what systemd hardening helper suggests
CapabilityBoundingSet = "";
LockPersonality = true;
MemoryDenyWriteExecute = true;
NoNewPrivileges = true;
PrivateDevices = true;
PrivateNetwork = false;
PrivateTmp = true;
PrivateUsers = true;
ProcSubset = "pid";
ProtectClock = true;
ProtectControlGroups = true;
ProtectHome = "yes";
ProtectHostname = true;
ProtectKernelLogs = true;
ProtectKernelModules = true;
ProtectKernelTunables = true;
ProtectProc = "invisible";
# This should allow for hardlinking to torrent client files
ProtectSystem = "full";
RemoveIPC = true;
RestrictAddressFamilies = [
"AF_INET"
"AF_INET6"
"AF_NETLINK"
"AF_UNIX"
];
RestrictNamespaces = true;
RestrictRealtime = true;
RestrictSUIDSGID = true;
SystemCallArchitectures = "native";
SystemCallFilter = [ "@system-service" ];
};
};
networking.firewall = mkIf cfg.openFirewall {
allowedTCPPorts = [ cfg.settings.port ];
};
users = {
users = mkIf (cfg.user == "qui") {
qui = {
group = cfg.group;
description = "qui user";
isSystemUser = true;
home = stateDir;
};
};
groups = mkIf (cfg.group == "qui") {
qui = { };
};
};
};
meta.maintainers = with maintainers; [ undefined-landmark ];
}
|
