Transmission: Difference between revisions

Latest revision as of 00:06, 28 February 2024

This article or section needs expansion.

Reason: This article is a stub. (Discuss in Talk:Transmission#)
Please consult the pedia article metapage for guidelines on contributing.

Installation

Install by adding transmission_4-qt or transmission_4-gtk to your packages list

environment.systemPackages = with pkgs; [ transmission_4-qt ];

environment.systemPackages = with pkgs; [ transmission_4-gtk ];

If you want to configure the settings declaratively with within configuration.nix, you will have to instead install transmission-qt or transmission-gtk. Do note that this is using version 3.0.0 instead of version 4.

environment.systemPackages = with pkgs; [ transmission-qt ];

environment.systemPackages = with pkgs; [ transmission-gtk ];

Service configuration

You can declaratively change the settings via Nix by modifying services.transmission.settings. View the documentation for more info. Like the previous section has said before, you'll have to use the nixpkgs transmission-gtk or transmission-qt for this to work.

Example:

services.transmission.settings = {
  download-dir = "${config.services.transmission.home}/Downloads";
};

Password-protected RPC

The default method of editing the configuration and restarting the daemon will not work because of the way the configuration is handled. It is however possible to once set it in clear in the settings, and then copy the generated hash to the setting, removing the in-clear copy from the configuration.

Example: allow remote access

To control the daemon remotely, put the following lines in your /etc/nixos/configuration.nix:

services.transmission = { 
    enable = true; #Enable transmission daemon
    openRPCPort = true; #Open firewall for RPC
    settings = { #Override default settings
      rpc-bind-address = "0.0.0.0"; #Bind to own IP
      rpc-whitelist = "127.0.0.1,10.0.0.1"; #Whitelist your remote machine (10.0.0.1 in this example)
    };
  };

@@ Line 1: / Line 1: @@
 {{expansion}}
+== Installation ==
+Install by adding transmission_4-qt or transmission_4-gtk to your packages list
+<syntaxHighlight lang=nix>
+environment.systemPackages = with pkgs; [ transmission_4-qt ];
+</syntaxHighlight>
+<syntaxHighlight lang=nix>
+environment.systemPackages = with pkgs; [ transmission_4-gtk ];
+</syntaxHighlight>
+If you want to configure the settings declaratively with within configuration.nix, you will have to instead install transmission-qt or transmission-gtk. Do note that this is using version 3.0.0 instead of version 4.
+<syntaxHighlight lang=nix>
+environment.systemPackages = with pkgs; [ transmission-qt ];
+</syntaxHighlight>
+<syntaxHighlight lang=nix>
+environment.systemPackages = with pkgs; [ transmission-gtk ];
+</syntaxHighlight>
 == Service configuration ==
+You can declaratively change the settings via Nix by modifying <code>services.transmission.settings</code>. [https://search.nixos.org/options?channel=23.11&from=0&size=50&sort=relevance&type=packages&query=transmission.settings View the documentation for more info]. Like the previous section has said before, you'll have to use the nixpkgs transmission-gtk or transmission-qt for this to work.
-Changes to the configuration in the interface will not persist when the application is re-launched. <code>services.transmission.settings</code> is reset each time the service restarts.
+Example:
+<syntaxHighlight lang=nix>
+services.transmission.settings = {
+  download-dir = "${config.services.transmission.home}/Downloads";
+};
-<blockquote>
+</syntaxHighlight>
-Attribute set whos[e] fields overwrites fields in settings.json (each
-time the service starts). String values must be quoted, integer and
-boolean values must not.
-</blockquote>
-<cite>[https://github.com/NixOS/nixpkgs/blob/dd705fb45fd17c078522dedb76ee710ed4d3af4b/nixos/modules/services/torrent/transmission.nix#L64:L71 <nixpkgs>/nixos/modules/services/torrent/transmission.nix]</cite>
-To persist changes, edit them, look at the <code>[services.transmission.home]/.config/transmission-daemon/settings.json</code> file generated for the setting keys and their values, and save them to <code>services.transmission.settings</code>
 === Password-protected RPC ===
 The default method of editing the configuration and restarting the daemon will '''not work''' because of the way the configuration is handled. It is however possible to once set it in clear in the settings, and then copy the generated hash to the setting, removing the in-clear copy from the configuration.
+=== Example: allow remote access ===
+To control the daemon remotely, put the following lines in your <code>/etc/nixos/configuration.nix</code>:
+<syntaxhighlight lang=nix>
+services.transmission = {
+    enable = true; #Enable transmission daemon
+    openRPCPort = true; #Open firewall for RPC
+    settings = { #Override default settings
+      rpc-bind-address = "0.0.0.0"; #Bind to own IP
+      rpc-whitelist = "127.0.0.1,10.0.0.1"; #Whitelist your remote machine (10.0.0.1 in this example)
+    };
+  };
+</syntaxhighlight>
+[[Category: Applications]]