Transmission

`services.transmission.credentialsFile`

Path to a JSON file to be merged with the settings. Useful to merge a file which is better kept out of the Nix store to set secret config parameters like rpc-password.

Type: path

Default

"/dev/null"

Example

"/var/lib/secrets/transmission/settings.json"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.downloadDirPermissions`

If not null, is used as the permissions set by system.activationScripts.transmission-daemon on the directories , . and . Note that you may also want to change .

Type: null or string

Default

null

Example

"770"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.enable`

Whether to enable the headless Transmission BitTorrent daemon.

Transmission daemon can be controlled via the RPC interface using transmission-remote, the WebUI (http://127.0.0.1:9091/ by default), or other clients like stig or tremc.

Torrents are downloaded to /Downloads by default and are accessible to users in the "transmission" group.

Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.extraFlags`

Extra flags passed to the transmission command in the service definition.

Type: list of string

Default

[ ]

Example

["--log-debug"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.group`

Group account under which Transmission runs. Type: string

Default

"transmission"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.home`

The directory where Transmission will create .config/transmission-daemon. as well as Downloads/ unless is changed, and .incomplete/ unless is changed.

Type: path

Default

"/var/lib/transmission"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.openFirewall`

Alias of {option}services.transmission.openPeerPorts. Type: boolean

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.openPeerPorts`

Whether to enable opening of the peer port(s) in the firewall. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.openRPCPort`

Whether to enable opening of the RPC port in the firewall. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.package`

The transmission package to use. Type: package

Default

pkgs.transmission_3

Example

pkgs.transmission_4

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.performanceNetParameters`

Whether to enable tweaking of kernel parameters to open many more connections at the same time.

Note that you may also want to increase peer-limit-global. And be aware that these settings are quite aggressive and might not suite your regular desktop use. For instance, SSH sessions may time out more easily.

Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings`

Settings whose options overwrite fields in .config/transmission-daemon/settings.json (each time the service starts).

See Transmission's Wiki for documentation of settings not explicitly covered by this module.

Type: JSON value

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.download-dir`

Directory where to download torrents. Type: path

Default

"${config.services.transmission.home}/Downloads"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.incomplete-dir`

When enabled with services.transmission.home , new torrents will download the files to this directory. When complete, the files will be moved to download-dir .

Type: path

Default

"${config.services.transmission.home}/.incomplete"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.incomplete-dir-enabled`

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.message-level`

Set verbosity of transmission messages. Type: integer between 0 and 6 (both inclusive)

Default

2

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.peer-port`

The peer port to listen for incoming connections. Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

51413

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.peer-port-random-high`

The maximum peer port to listen to for incoming connections when is enabled.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

65535

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.peer-port-random-low`

The minimal peer port to listen to for incoming connections when is enabled.

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

65535

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.peer-port-random-on-start`

Randomize the peer port. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.rpc-bind-address`

Where to listen for RPC connections. Use 0.0.0.0 to listen on all interfaces.

Type: string

Default

"127.0.0.1"

Example

"0.0.0.0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.rpc-port`

The RPC port to listen to. Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Default

9091

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.script-torrent-done-enabled`

Whether to run at torrent completion.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.script-torrent-done-filename`

Executable to be run at torrent completion. Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.trash-original-torrent-files`

Whether to delete torrents added from the .

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.umask`

Sets transmission's file mode creation mask. See the umask(2) manpage for more information. Users who want their saved torrents to be world-writable may want to set this value to 0. Bear in mind that the json markup language only accepts numbers in base 10, so the standard umask(2) octal notation "022" is written in settings.json as 18.

Type: signed integer

Default

2

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.utp-enabled`

Whether to enable Micro Transport Protocol (µTP).

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.watch-dir`

Watch a directory for torrent files and add them to transmission. Type: path

Default

"${config.services.transmission.home}/watchdir"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.settings.watch-dir-enabled`

Whether to enable the .

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.user`

User account under which Transmission runs. Type: string

Default

"transmission"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix

`services.transmission.webHome`

If not null, sets the value of the TRANSMISSION_WEB_HOME environment variable used by the service. Useful for overriding the web interface files, without overriding the transmission package and thus requiring rebuilding it locally. Use this if you want to use an alternative web interface, such as pkgs.flood-for-transmission.

Type: null or path

Default

null

Example

"pkgs.flood-for-transmission"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/torrent/transmission.nix