blob: 23f69cd7e05059ec01ae50f2ecc432c3bd67cb56 (
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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
{
config,
lib,
pkgs,
...
}:
let
cfg = config.services.aria2;
homeDir = "/var/lib/aria2";
defaultRpcListenPort = 6800;
defaultDir = "${homeDir}/Downloads";
portRangesToString =
ranges:
lib.concatStringsSep "," (
map (x: if x.from == x.to then toString x.from else toString x.from + "-" + toString x.to) ranges
);
customToKeyValue = lib.generators.toKeyValue {
mkKeyValue = lib.generators.mkKeyValueDefault {
mkValueString =
v: if builtins.isList v then portRangesToString v else lib.generators.mkValueStringDefault { } v;
} "=";
};
in
{
imports = [
(lib.mkRemovedOptionModule [
"services"
"aria2"
"rpcSecret"
] "Use services.aria2.rpcSecretFile instead")
(lib.mkRemovedOptionModule [
"services"
"aria2"
"extraArguments"
] "Use services.aria2.settings instead")
(lib.mkRenamedOptionModule
[ "services" "aria2" "downloadDir" ]
[ "services" "aria2" "settings" "dir" ]
)
(lib.mkRenamedOptionModule
[ "services" "aria2" "listenPortRange" ]
[ "services" "aria2" "settings" "listen-port" ]
)
(lib.mkRenamedOptionModule
[ "services" "aria2" "rpcListenPort" ]
[ "services" "aria2" "settings" "rpc-listen-port" ]
)
];
options = {
services.aria2 = {
enable = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
Whether or not to enable the headless Aria2 daemon service.
Aria2 daemon can be controlled via the RPC interface using one of many
WebUIs (http://localhost:${toString defaultRpcListenPort}/ by default).
Targets are downloaded to `${defaultDir}` by default and are
accessible to users in the `aria2` group.
'';
};
openPorts = lib.mkOption {
type = lib.types.bool;
default = false;
description = ''
Open listen and RPC ports found in `settings.listen-port` and
`settings.rpc-listen-port` options in the firewall.
'';
};
rpcSecretFile = lib.mkOption {
type = lib.types.path;
example = "/run/secrets/aria2-rpc-token.txt";
description = ''
A file containing the RPC secret authorization token.
Read <https://aria2.github.io/manual/en/html/aria2c.html#rpc-auth> to know how this option value is used.
'';
};
downloadDirPermission = lib.mkOption {
type = lib.types.str;
default = "0770";
description = ''
The permission for `settings.dir`.
The default is 0770, which denies access for users not in the `aria2`
group.
You may want to adjust `serviceUMask` as well, which further restricts
the file permission for newly created files (i.e. the downloads).
'';
};
serviceUMask = lib.mkOption {
type = lib.types.str;
default = "0022";
example = "0002";
description = ''
The file mode creation mask for Aria2 service.
The default is 0022 for compatibility reason, as this is the default
used by systemd. However, this results in file permission 0644 for new
files, and denies `aria2` group member from modifying the file.
You may want to set this value to `0002` so you can manage the file
more easily.
'';
};
settings = lib.mkOption {
description = ''
Generates the {file}`aria2.conf` file. Refer to [the documentation][0] for
all possible settings.
[0]: <https://aria2.github.io/manual/en/html/aria2c.html#synopsis>
'';
default = { };
type = lib.types.submodule {
freeformType =
with lib.types;
attrsOf (oneOf [
bool
int
float
singleLineStr
]);
options = {
save-session = lib.mkOption {
type = lib.types.singleLineStr;
default = "${homeDir}/aria2.session";
description = "Save error/unfinished downloads to FILE on exit.";
};
dir = lib.mkOption {
type = lib.types.singleLineStr;
default = defaultDir;
description = "Directory to store downloaded files.";
};
conf-path = lib.mkOption {
type = lib.types.singleLineStr;
default = "${homeDir}/aria2.conf";
description = "Configuration file path.";
};
enable-rpc = lib.mkOption {
type = lib.types.bool;
default = true;
description = "Enable JSON-RPC/XML-RPC server.";
};
listen-port = lib.mkOption {
type = with lib.types; listOf (attrsOf port);
default = [
{
from = 6881;
to = 6999;
}
];
description = "Set UDP listening port range used by DHT(IPv4, IPv6) and UDP tracker.";
};
rpc-listen-port = lib.mkOption {
type = lib.types.port;
default = defaultRpcListenPort;
description = "Specify a port number for JSON-RPC/XML-RPC server to listen to. Possible Values: 1024-65535";
};
};
};
};
};
};
config = lib.mkIf cfg.enable {
assertions = [
{
assertion = cfg.settings.enable-rpc;
message = "RPC has to be enabled, the default module option takes care of that.";
}
{
assertion = !(cfg.settings ? rpc-secret);
message = "Set the RPC secret through services.aria2.rpcSecretFile so it will not end up in the world-readable nix store.";
}
];
# Need to open ports for proper functioning
networking.firewall = lib.mkIf cfg.openPorts {
allowedUDPPortRanges = config.services.aria2.settings.listen-port;
allowedTCPPorts = [ config.services.aria2.settings.rpc-listen-port ];
};
users.users.aria2 = {
group = "aria2";
uid = config.ids.uids.aria2;
description = "aria2 user";
home = homeDir;
createHome = false;
};
users.groups.aria2.gid = config.ids.gids.aria2;
systemd.tmpfiles.rules = [
"d '${homeDir}' 0770 aria2 aria2 - -"
"d '${config.services.aria2.settings.dir}' ${config.services.aria2.downloadDirPermission} aria2 aria2 - -"
];
systemd.services.aria2 = {
description = "aria2 Service";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
preStart = ''
if [[ ! -e "${cfg.settings.save-session}" ]]
then
touch "${cfg.settings.save-session}"
fi
cp -f "${pkgs.writeText "aria2.conf" (customToKeyValue cfg.settings)}" "${cfg.settings.conf-path}"
chmod +w "${cfg.settings.conf-path}"
echo "rpc-secret=$(cat "$CREDENTIALS_DIRECTORY/rpcSecretFile")" >> "${cfg.settings.conf-path}"
'';
serviceConfig = {
Restart = "on-abort";
ExecStart = "${pkgs.aria2}/bin/aria2c --conf-path=${cfg.settings.conf-path}";
ExecReload = "${pkgs.coreutils}/bin/kill -HUP $MAINPID";
User = "aria2";
Group = "aria2";
LoadCredential = "rpcSecretFile:${cfg.rpcSecretFile}";
UMask = cfg.serviceUMask;
};
};
};
meta.maintainers = [ lib.maintainers.timhae ];
}
|
