diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/torrent')
8 files changed, 80 insertions, 80 deletions
diff --git a/nixpkgs/nixos/modules/services/torrent/deluge.nix b/nixpkgs/nixos/modules/services/torrent/deluge.nix index 632d8aa98aa2..90573fea57b3 100644 --- a/nixpkgs/nixos/modules/services/torrent/deluge.nix +++ b/nixpkgs/nixos/modules/services/torrent/deluge.nix @@ -37,12 +37,12 @@ in { options = { services = { deluge = { - enable = mkEnableOption (lib.mdDoc "Deluge daemon"); + enable = mkEnableOption "Deluge daemon"; openFilesLimit = mkOption { default = openFilesLimit; type = types.either types.int types.str; - description = lib.mdDoc '' + description = '' Number of files to allow deluged to open. ''; }; @@ -60,7 +60,7 @@ in { listen_ports = [ ${toString listenPortsDefault} ]; } ''; - description = lib.mdDoc '' + description = '' Deluge core configuration for the core.conf file. Only has an effect when {option}`services.deluge.declarative` is set to `true`. String values must be quoted, integer and @@ -73,7 +73,7 @@ in { declarative = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to use a declarative deluge configuration. Only if set to `true`, the options {option}`services.deluge.config`, @@ -86,7 +86,7 @@ in { openFirewall = mkOption { default = false; type = types.bool; - description = lib.mdDoc '' + description = '' Whether to open the firewall for the ports in {option}`services.deluge.config.listen_ports`. It only takes effet if {option}`services.deluge.declarative` is set to @@ -102,7 +102,7 @@ in { dataDir = mkOption { type = types.path; default = "/var/lib/deluge"; - description = lib.mdDoc '' + description = '' The directory where deluge will create files. ''; }; @@ -110,7 +110,7 @@ in { authFile = mkOption { type = types.path; example = "/run/keys/deluge-auth"; - description = lib.mdDoc '' + description = '' The file managing the authentication for deluge, the format of this file is straightforward, each line contains a username:password:level tuple in plaintext. It only has an effect @@ -124,7 +124,7 @@ in { user = mkOption { type = types.str; default = "deluge"; - description = lib.mdDoc '' + description = '' User account under which deluge runs. ''; }; @@ -132,7 +132,7 @@ in { group = mkOption { type = types.str; default = "deluge"; - description = lib.mdDoc '' + description = '' Group under which deluge runs. ''; }; @@ -140,7 +140,7 @@ in { extraPackages = mkOption { type = types.listOf types.package; default = []; - description = lib.mdDoc '' + description = '' Extra packages available at runtime to enable Deluge's plugins. For example, extraction utilities are required for the built-in "Extractor" plugin. This always contains unzip, gnutar, xz and bzip2. @@ -151,12 +151,12 @@ in { }; deluge.web = { - enable = mkEnableOption (lib.mdDoc "Deluge Web daemon"); + enable = mkEnableOption "Deluge Web daemon"; port = mkOption { type = types.port; default = 8112; - description = lib.mdDoc '' + description = '' Deluge web UI port. ''; }; @@ -164,7 +164,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Open ports in the firewall for deluge web daemon ''; }; diff --git a/nixpkgs/nixos/modules/services/torrent/flexget.nix b/nixpkgs/nixos/modules/services/torrent/flexget.nix index bc06b34a1f9e..138e9781045c 100644 --- a/nixpkgs/nixos/modules/services/torrent/flexget.nix +++ b/nixpkgs/nixos/modules/services/torrent/flexget.nix @@ -14,7 +14,7 @@ let in { options = { services.flexget = { - enable = mkEnableOption (lib.mdDoc "FlexGet daemon"); + enable = mkEnableOption "FlexGet daemon"; package = mkPackageOption pkgs "flexget" {}; @@ -22,34 +22,34 @@ in { default = "deluge"; example = "some_user"; type = types.str; - description = lib.mdDoc "The user under which to run flexget."; + description = "The user under which to run flexget."; }; homeDir = mkOption { default = "/var/lib/deluge"; example = "/home/flexget"; type = types.path; - description = lib.mdDoc "Where files live."; + description = "Where files live."; }; interval = mkOption { default = "10m"; example = "1h"; type = types.str; - description = lib.mdDoc "When to perform a {command}`flexget` run. See {command}`man 7 systemd.time` for the format."; + description = "When to perform a {command}`flexget` run. See {command}`man 7 systemd.time` for the format."; }; systemScheduler = mkOption { default = true; example = false; type = types.bool; - description = lib.mdDoc "When true, execute the runs via the flexget-runner.timer. If false, you have to specify the settings yourself in the YML file."; + description = "When true, execute the runs via the flexget-runner.timer. If false, you have to specify the settings yourself in the YML file."; }; config = mkOption { default = ""; type = types.lines; - description = lib.mdDoc "The YAML configuration for FlexGet."; + description = "The YAML configuration for FlexGet."; }; }; }; diff --git a/nixpkgs/nixos/modules/services/torrent/magnetico.nix b/nixpkgs/nixos/modules/services/torrent/magnetico.nix index dc6b4e9aa734..8a5e9f309649 100644 --- a/nixpkgs/nixos/modules/services/torrent/magnetico.nix +++ b/nixpkgs/nixos/modules/services/torrent/magnetico.nix @@ -43,13 +43,13 @@ in { ###### interface options.services.magnetico = { - enable = mkEnableOption (lib.mdDoc "Magnetico, Bittorrent DHT crawler"); + enable = mkEnableOption "Magnetico, Bittorrent DHT crawler"; crawler.address = mkOption { type = types.str; default = "0.0.0.0"; example = "1.2.3.4"; - description = lib.mdDoc '' + description = '' Address to be used for indexing DHT nodes. ''; }; @@ -57,7 +57,7 @@ in { crawler.port = mkOption { type = types.port; default = 0; - description = lib.mdDoc '' + description = '' Port to be used for indexing DHT nodes. This port should be added to {option}`networking.firewall.allowedTCPPorts`. @@ -67,7 +67,7 @@ in { crawler.maxNeighbors = mkOption { type = types.ints.positive; default = 1000; - description = lib.mdDoc '' + description = '' Maximum number of simultaneous neighbors of an indexer. Be careful changing this number: high values can very easily cause your network to be congested or even crash @@ -78,7 +78,7 @@ in { crawler.maxLeeches = mkOption { type = types.ints.positive; default = 200; - description = lib.mdDoc '' + description = '' Maximum number of simultaneous leeches. ''; }; @@ -86,7 +86,7 @@ in { crawler.extraOptions = mkOption { type = types.listOf types.str; default = []; - description = lib.mdDoc '' + description = '' Extra command line arguments to pass to magneticod. ''; }; @@ -95,7 +95,7 @@ in { type = types.str; default = "localhost"; example = "1.2.3.4"; - description = lib.mdDoc '' + description = '' Address the web interface will listen to. ''; }; @@ -103,7 +103,7 @@ in { web.port = mkOption { type = types.port; default = 8080; - description = lib.mdDoc '' + description = '' Port the web interface will listen to. ''; }; @@ -116,7 +116,7 @@ in { myuser = "$2y$12$YE01LZ8jrbQbx6c0s2hdZO71dSjn2p/O9XsYJpz.5968yCysUgiaG"; } ''; - description = lib.mdDoc '' + description = '' The credentials to access the web interface, in case authentication is enabled, in the format `username:hash`. If unset no authentication will be required. @@ -139,7 +139,7 @@ in { web.credentialsFile = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc '' + description = '' The path to the file holding the credentials to access the web interface. If unset no authentication will be required. @@ -157,7 +157,7 @@ in { web.extraOptions = mkOption { type = types.listOf types.str; default = []; - description = lib.mdDoc '' + description = '' Extra command line arguments to pass to magneticow. ''; }; diff --git a/nixpkgs/nixos/modules/services/torrent/opentracker.nix b/nixpkgs/nixos/modules/services/torrent/opentracker.nix index 71852f24e55b..b30ea7e2377b 100644 --- a/nixpkgs/nixos/modules/services/torrent/opentracker.nix +++ b/nixpkgs/nixos/modules/services/torrent/opentracker.nix @@ -5,13 +5,13 @@ let cfg = config.services.opentracker; in { options.services.opentracker = { - enable = mkEnableOption (lib.mdDoc "opentracker"); + enable = mkEnableOption "opentracker"; package = mkPackageOption pkgs "opentracker" { }; extraOptions = mkOption { type = types.separatedString " "; - description = lib.mdDoc '' + description = '' Configuration Arguments for opentracker See https://erdgeist.org/arts/software/opentracker/ for all params ''; diff --git a/nixpkgs/nixos/modules/services/torrent/peerflix.nix b/nixpkgs/nixos/modules/services/torrent/peerflix.nix index ea74d0f8b9c4..821c829f6b4a 100644 --- a/nixpkgs/nixos/modules/services/torrent/peerflix.nix +++ b/nixpkgs/nixos/modules/services/torrent/peerflix.nix @@ -19,19 +19,19 @@ in { options.services.peerflix = { enable = mkOption { - description = lib.mdDoc "Whether to enable peerflix service."; + description = "Whether to enable peerflix service."; default = false; type = types.bool; }; stateDir = mkOption { - description = lib.mdDoc "Peerflix state directory."; + description = "Peerflix state directory."; default = "/var/lib/peerflix"; type = types.path; }; downloadDir = mkOption { - description = lib.mdDoc "Peerflix temporary download directory."; + description = "Peerflix temporary download directory."; default = "${cfg.stateDir}/torrents"; defaultText = literalExpression ''"''${config.${opt.stateDir}}/torrents"''; type = types.path; diff --git a/nixpkgs/nixos/modules/services/torrent/rtorrent.nix b/nixpkgs/nixos/modules/services/torrent/rtorrent.nix index 699f3be82a9d..009c2ffe0a5b 100644 --- a/nixpkgs/nixos/modules/services/torrent/rtorrent.nix +++ b/nixpkgs/nixos/modules/services/torrent/rtorrent.nix @@ -9,12 +9,12 @@ let in { options.services.rtorrent = { - enable = mkEnableOption (lib.mdDoc "rtorrent"); + enable = mkEnableOption "rtorrent"; dataDir = mkOption { type = types.str; default = "/var/lib/rtorrent"; - description = lib.mdDoc '' + description = '' The directory where rtorrent stores its data files. ''; }; @@ -23,7 +23,7 @@ in { type = types.str; default = "0750"; example = "0755"; - description = lib.mdDoc '' + description = '' Unix Permissions in octal on the rtorrent directory. ''; }; @@ -32,7 +32,7 @@ in { type = types.str; default = "${cfg.dataDir}/download"; defaultText = literalExpression ''"''${config.${opt.dataDir}}/download"''; - description = lib.mdDoc '' + description = '' Where to put downloaded files. ''; }; @@ -40,7 +40,7 @@ in { user = mkOption { type = types.str; default = "rtorrent"; - description = lib.mdDoc '' + description = '' User account under which rtorrent runs. ''; }; @@ -48,7 +48,7 @@ in { group = mkOption { type = types.str; default = "rtorrent"; - description = lib.mdDoc '' + description = '' Group under which rtorrent runs. ''; }; @@ -58,7 +58,7 @@ in { port = mkOption { type = types.port; default = 50000; - description = lib.mdDoc '' + description = '' The rtorrent port. ''; }; @@ -66,7 +66,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to open the firewall for the port in {option}`services.rtorrent.port`. ''; }; @@ -75,7 +75,7 @@ in { type = types.str; readOnly = true; default = "/run/rtorrent/rpc.sock"; - description = lib.mdDoc '' + description = '' RPC socket path. ''; }; @@ -83,7 +83,7 @@ in { configText = mkOption { type = types.lines; default = ""; - description = lib.mdDoc '' + description = '' The content of {file}`rtorrent.rc`. The [modernized configuration template](https://rtorrent-docs.readthedocs.io/en/latest/cookbook.html#modernized-configuration-template) with the values specified in this module will be prepended using mkBefore. You can use mkForce to overwrite the config completely. ''; }; diff --git a/nixpkgs/nixos/modules/services/torrent/torrentstream.nix b/nixpkgs/nixos/modules/services/torrent/torrentstream.nix index 27aad06130e3..9c0e6f85dc57 100644 --- a/nixpkgs/nixos/modules/services/torrent/torrentstream.nix +++ b/nixpkgs/nixos/modules/services/torrent/torrentstream.nix @@ -6,26 +6,26 @@ let in { options.services.torrentstream = { - enable = lib.mkEnableOption (lib.mdDoc "TorrentStream daemon"); + enable = lib.mkEnableOption "TorrentStream daemon"; package = lib.mkPackageOption pkgs "torrentstream" { }; port = lib.mkOption { type = lib.types.port; default = 5082; - description = lib.mdDoc '' + description = '' TorrentStream port. ''; }; openFirewall = lib.mkOption { type = lib.types.bool; default = false; - description = lib.mdDoc '' + description = '' Open ports in the firewall for TorrentStream daemon. ''; }; address = lib.mkOption { type = lib.types.str; default = "0.0.0.0"; - description = lib.mdDoc '' + description = '' Address to listen on. ''; }; diff --git a/nixpkgs/nixos/modules/services/torrent/transmission.nix b/nixpkgs/nixos/modules/services/torrent/transmission.nix index a9fb123b981e..52b472631dcf 100644 --- a/nixpkgs/nixos/modules/services/torrent/transmission.nix +++ b/nixpkgs/nixos/modules/services/torrent/transmission.nix @@ -24,8 +24,8 @@ in ]; options = { services.transmission = { - enable = mkEnableOption (lib.mdDoc "transmission") // { - description = lib.mdDoc '' + enable = mkEnableOption "transmission" // { + description = '' Whether to enable the headless Transmission BitTorrent daemon. Transmission daemon can be controlled via the RPC interface using @@ -38,7 +38,7 @@ in }; settings = mkOption { - description = lib.mdDoc '' + description = '' Settings whose options overwrite fields in `.config/transmission-daemon/settings.json` (each time the service starts). @@ -53,13 +53,13 @@ in type = types.path; default = "${cfg.home}/${downloadsDir}"; defaultText = literalExpression ''"''${config.${opt.home}}/${downloadsDir}"''; - description = lib.mdDoc "Directory where to download torrents."; + description = "Directory where to download torrents."; }; options.incomplete-dir = mkOption { type = types.path; default = "${cfg.home}/${incompleteDir}"; defaultText = literalExpression ''"''${config.${opt.home}}/${incompleteDir}"''; - description = lib.mdDoc '' + description = '' When enabled with services.transmission.home [](#opt-services.transmission.settings.incomplete-dir-enabled), @@ -71,22 +71,22 @@ in options.incomplete-dir-enabled = mkOption { type = types.bool; default = true; - description = lib.mdDoc ""; + description = ""; }; options.message-level = mkOption { type = types.ints.between 0 6; default = 2; - description = lib.mdDoc "Set verbosity of transmission messages."; + description = "Set verbosity of transmission messages."; }; options.peer-port = mkOption { type = types.port; default = 51413; - description = lib.mdDoc "The peer port to listen for incoming connections."; + description = "The peer port to listen for incoming connections."; }; options.peer-port-random-high = mkOption { type = types.port; default = 65535; - description = lib.mdDoc '' + description = '' The maximum peer port to listen to for incoming connections when [](#opt-services.transmission.settings.peer-port-random-on-start) is enabled. ''; @@ -94,7 +94,7 @@ in options.peer-port-random-low = mkOption { type = types.port; default = 65535; - description = lib.mdDoc '' + description = '' The minimal peer port to listen to for incoming connections when [](#opt-services.transmission.settings.peer-port-random-on-start) is enabled. ''; @@ -102,13 +102,13 @@ in options.peer-port-random-on-start = mkOption { type = types.bool; default = false; - description = lib.mdDoc "Randomize the peer port."; + description = "Randomize the peer port."; }; options.rpc-bind-address = mkOption { type = types.str; default = "127.0.0.1"; example = "0.0.0.0"; - description = lib.mdDoc '' + description = '' Where to listen for RPC connections. Use `0.0.0.0` to listen on all interfaces. ''; @@ -116,12 +116,12 @@ in options.rpc-port = mkOption { type = types.port; default = 9091; - description = lib.mdDoc "The RPC port to listen to."; + description = "The RPC port to listen to."; }; options.script-torrent-done-enabled = mkOption { type = types.bool; default = false; - description = lib.mdDoc '' + description = '' Whether to run [](#opt-services.transmission.settings.script-torrent-done-filename) at torrent completion. @@ -130,12 +130,12 @@ in options.script-torrent-done-filename = mkOption { type = types.nullOr types.path; default = null; - description = lib.mdDoc "Executable to be run at torrent completion."; + description = "Executable to be run at torrent completion."; }; options.umask = mkOption { type = types.int; default = 2; - description = lib.mdDoc '' + description = '' 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 @@ -147,7 +147,7 @@ in options.utp-enabled = mkOption { type = types.bool; default = true; - description = lib.mdDoc '' + description = '' Whether to enable [Micro Transport Protocol (µTP)](https://en.wikipedia.org/wiki/Micro_Transport_Protocol). ''; }; @@ -155,19 +155,19 @@ in type = types.path; default = "${cfg.home}/${watchDir}"; defaultText = literalExpression ''"''${config.${opt.home}}/${watchDir}"''; - description = lib.mdDoc "Watch a directory for torrent files and add them to transmission."; + description = "Watch a directory for torrent files and add them to transmission."; }; options.watch-dir-enabled = mkOption { type = types.bool; default = false; - description = lib.mdDoc ''Whether to enable the + description = ''Whether to enable the [](#opt-services.transmission.settings.watch-dir). ''; }; options.trash-original-torrent-files = mkOption { type = types.bool; default = false; - description = lib.mdDoc ''Whether to delete torrents added from the + description = ''Whether to delete torrents added from the [](#opt-services.transmission.settings.watch-dir). ''; }; @@ -180,7 +180,7 @@ in type = with types; nullOr str; default = null; example = "770"; - description = lib.mdDoc '' + description = '' If not `null`, is used as the permissions set by `system.activationScripts.transmission-daemon` on the directories [](#opt-services.transmission.settings.download-dir), @@ -194,7 +194,7 @@ in home = mkOption { type = types.path; default = "/var/lib/transmission"; - description = lib.mdDoc '' + description = '' The directory where Transmission will create `${settingsDir}`. as well as `${downloadsDir}/` unless [](#opt-services.transmission.settings.download-dir) is changed, @@ -206,18 +206,18 @@ in user = mkOption { type = types.str; default = "transmission"; - description = lib.mdDoc "User account under which Transmission runs."; + description = "User account under which Transmission runs."; }; group = mkOption { type = types.str; default = "transmission"; - description = lib.mdDoc "Group account under which Transmission runs."; + description = "Group account under which Transmission runs."; }; credentialsFile = mkOption { type = types.path; - description = lib.mdDoc '' + description = '' 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`. @@ -230,17 +230,17 @@ in type = types.listOf types.str; default = []; example = [ "--log-debug" ]; - description = lib.mdDoc '' + description = '' Extra flags passed to the transmission command in the service definition. ''; }; - openPeerPorts = mkEnableOption (lib.mdDoc "opening of the peer port(s) in the firewall"); + openPeerPorts = mkEnableOption "opening of the peer port(s) in the firewall"; - openRPCPort = mkEnableOption (lib.mdDoc "opening of the RPC port in the firewall"); + openRPCPort = mkEnableOption "opening of the RPC port in the firewall"; - performanceNetParameters = mkEnableOption (lib.mdDoc "performance tweaks") // { - description = lib.mdDoc '' + performanceNetParameters = mkEnableOption "performance tweaks" // { + description = '' Whether to enable tweaking of kernel parameters to open many more connections at the same time. @@ -256,7 +256,7 @@ in type = types.nullOr types.path; default = null; example = "pkgs.flood-for-transmission"; - description = lib.mdDoc '' + description = '' 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 |