Skip to content

Aria2

services.aria2.enable

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:6800/ by default).

Targets are downloaded to /var/lib/aria2/Downloads by default and are accessible to users in the aria2 group.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/aria2.nix

services.aria2.openPorts

Open listen and RPC ports found in settings.listen-port and settings.rpc-listen-port options in the firewall.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/aria2.nix

services.aria2.rpcSecretFile

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.

Type: path

Example

"/run/secrets/aria2-rpc-token.txt"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/aria2.nix

services.aria2.settings

Generates the aria2.conf file. Refer to the documentation for all possible settings.

Type: attribute set of (boolean or signed integer or floating point number or (optionally newline-terminated) single-line string)

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/aria2.nix

services.aria2.settings.conf-path

Configuration file path. Type: (optionally newline-terminated) single-line string

Default

"/var/lib/aria2/aria2.conf"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/aria2.nix

services.aria2.settings.dir

Directory to store downloaded files. Type: (optionally newline-terminated) single-line string

Default

"/var/lib/aria2/Downloads"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/aria2.nix

services.aria2.settings.enable-rpc

Enable JSON-RPC/XML-RPC server. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/aria2.nix

services.aria2.settings.listen-port

Set UDP listening port range used by DHT(IPv4, IPv6) and UDP tracker. Type: list of attribute set of 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

[{from = 6881;to = 6999;}]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/aria2.nix

services.aria2.settings.rpc-listen-port

Specify a port number for JSON-RPC/XML-RPC server to listen to. Possible Values: 1024-65535 Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

6800

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/aria2.nix

services.aria2.settings.save-session

Save error/unfinished downloads to FILE on exit. Type: (optionally newline-terminated) single-line string

Default

"/var/lib/aria2/aria2.session"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/networking/aria2.nix