the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
132 lines
3.8 KiB
Nix
132 lines
3.8 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.aria2;
|
|
|
|
homeDir = "/var/lib/aria2";
|
|
|
|
settingsDir = "${homeDir}";
|
|
sessionFile = "${homeDir}/aria2.session";
|
|
downloadDir = "${homeDir}/Downloads";
|
|
|
|
rangesToStringList = map (x: builtins.toString x.from +"-"+ builtins.toString x.to);
|
|
|
|
settingsFile = pkgs.writeText "aria2.conf"
|
|
''
|
|
dir=${cfg.downloadDir}
|
|
listen-port=${concatStringsSep "," (rangesToStringList cfg.listenPortRange)}
|
|
rpc-listen-port=${toString cfg.rpcListenPort}
|
|
rpc-secret=${cfg.rpcSecret}
|
|
'';
|
|
|
|
in
|
|
{
|
|
options = {
|
|
services.aria2 = {
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Whether or not to enable the headless Aria2 daemon service.
|
|
|
|
Aria2 daemon can be controlled via the RPC interface using
|
|
one of many WebUI (http://localhost:6800/ by default).
|
|
|
|
Targets are downloaded to ${downloadDir} by default and are
|
|
accessible to users in the "aria2" group.
|
|
'';
|
|
};
|
|
openPorts = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc ''
|
|
Open listen and RPC ports found in listenPortRange and rpcListenPort
|
|
options in the firewall.
|
|
'';
|
|
};
|
|
downloadDir = mkOption {
|
|
type = types.path;
|
|
default = downloadDir;
|
|
description = lib.mdDoc ''
|
|
Directory to store downloaded files.
|
|
'';
|
|
};
|
|
listenPortRange = mkOption {
|
|
type = types.listOf types.attrs;
|
|
default = [ { from = 6881; to = 6999; } ];
|
|
description = lib.mdDoc ''
|
|
Set UDP listening port range used by DHT(IPv4, IPv6) and UDP tracker.
|
|
'';
|
|
};
|
|
rpcListenPort = mkOption {
|
|
type = types.int;
|
|
default = 6800;
|
|
description = lib.mdDoc "Specify a port number for JSON-RPC/XML-RPC server to listen to. Possible Values: 1024-65535";
|
|
};
|
|
rpcSecret = mkOption {
|
|
type = types.str;
|
|
default = "aria2rpc";
|
|
description = lib.mdDoc ''
|
|
Set RPC secret authorization token.
|
|
Read https://aria2.github.io/manual/en/html/aria2c.html#rpc-auth to know how this option value is used.
|
|
'';
|
|
};
|
|
extraArguments = mkOption {
|
|
type = types.separatedString " ";
|
|
example = "--rpc-listen-all --remote-time=true";
|
|
default = "";
|
|
description = lib.mdDoc ''
|
|
Additional arguments to be passed to Aria2.
|
|
'';
|
|
};
|
|
};
|
|
};
|
|
|
|
config = mkIf cfg.enable {
|
|
|
|
# Need to open ports for proper functioning
|
|
networking.firewall = mkIf cfg.openPorts {
|
|
allowedUDPPortRanges = config.services.aria2.listenPortRange;
|
|
allowedTCPPorts = [ config.services.aria2.rpcListenPort ];
|
|
};
|
|
|
|
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.downloadDir}' 0770 aria2 aria2 - -"
|
|
];
|
|
|
|
systemd.services.aria2 = {
|
|
description = "aria2 Service";
|
|
after = [ "network.target" ];
|
|
wantedBy = [ "multi-user.target" ];
|
|
preStart = ''
|
|
if [[ ! -e "${sessionFile}" ]]
|
|
then
|
|
touch "${sessionFile}"
|
|
fi
|
|
cp -f "${settingsFile}" "${settingsDir}/aria2.conf"
|
|
'';
|
|
|
|
serviceConfig = {
|
|
Restart = "on-abort";
|
|
ExecStart = "${pkgs.aria2}/bin/aria2c --enable-rpc --conf-path=${settingsDir}/aria2.conf ${config.services.aria2.extraArguments} --save-session=${sessionFile}";
|
|
ExecReload = "${pkgs.coreutils}/bin/kill -HUP $MAINPID";
|
|
User = "aria2";
|
|
Group = "aria2";
|
|
};
|
|
};
|
|
};
|
|
}
|