Create qbittorrent-nox service by camilosampedro · Pull Request #279716 · NixOS/nixpkgs

camilosampedro · 2024-01-09T00:11:18Z

Description of changes

The qbittorrent-nox package already exists, which is a headless version of qbittorrent (Only accessible via web). It being a headless service makes it a good candidate for being configured via services.* options, so I opened this PR for adding some basic configurations for it to run as a Systemd service.

This is my first contribution to the project, so I will greatly appreciate any comments and suggestions!

Things done

Add a 👍 reaction to pull requests you find important.

Currently there is a qbittorrent-nox package, but no configurations to make it a systemd service. I placed several basic options for this service, which should be good enough to start using the service.

These are required for setting a gid and uid for the systemd unit

To be able to use it

camilosampedro · 2024-01-14T22:06:17Z

I was able to test it on a clean install inside of a QEMU VM

The thing I couldn't do is to run the review command. The whole VM seems to crash when I run:

nix-shell -p nixpkgs-review --run "nixpkgs-review pr 279716"

This crashes the VM even when running it without sudo permissions. I wonder if this is a bug and if there's anything to do about it.

ambroisie

What about a downloadDir? Is there any specific setup necessary there?

ambroisie · 2024-01-29T15:49:26Z

nixos/modules/misc/ids.nix

      rstudio-server = 324;
      localtimed = 325;
      automatic-timezoned = 326;
+      qbittorrent-nox = 327;


This shouldn't be done anymore, you should use (in order of preference):

systemd's DynamicUser (potentially with User if you need a named user)

users.users.<name>.

Given the usual approach for HTPC/seedbox services, using users.users is probably the way to go.

ambroisie · 2024-01-29T15:50:08Z

nixos/modules/misc/ids.nix

      rstudio-server = 324;
      localtimed = 325;
      automatic-timezoned = 326;
+      qbittorrent-nox = 327;


Same note as the uid.

ambroisie · 2024-01-29T15:52:18Z

nixos/modules/services/torrent/qbittorrent-nox.nix

+in {
+  options = {
+    services = {
+      qbittorrent-nox = {


I would instead name it qbittorent, add a package option, and use qbittorent-nox as the default package.

ambroisie · 2024-01-29T15:53:11Z

nixos/modules/services/torrent/qbittorrent-nox.nix

+  options = {
+    services = {
+      qbittorrent-nox = {
+        enable = mkEnableOption (lib.mdDoc "qbittorrent-nox daemon");


Related to my proposition to rename the module:

Suggested change

enable = mkEnableOption (lib.mdDoc "qbittorrent-nox daemon");

enable = mkEnableOption (lib.mdDoc "qBittorent daemon");

ambroisie · 2024-01-29T15:54:16Z

nixos/modules/services/torrent/qbittorrent-nox.nix

+            description = lib.mdDoc ''
+              qbittorrent-nox web UI port.
+            '';


Suggested change

description = lib.mdDoc ''

qbittorrent-nox web UI port.

'';

description = lib.mdDoc "qBittorent web UI port"';

ambroisie · 2024-01-29T16:01:15Z

nixos/modules/services/torrent/qbittorrent-nox.nix

+    systemd.services.qbittorrent-nox = {
+      after = [ "network.target" "local-fs.target" "network-online.target" "nss-lookup.target" ];
+      wantedBy = [ "multi-user.target" ];
+      path = [ cfg.package ];


Not needed, better served by systemd's service hardening options.

ambroisie · 2024-01-29T16:01:34Z

nixos/modules/services/torrent/qbittorrent-nox.nix

+        PrivateTmp = "false";
+        TimeoutStopSec = 1800;
+      };
+      # preStart = preStart;


ambroisie · 2024-01-29T16:01:52Z

nixos/modules/services/torrent/qbittorrent-nox.nix

+      })
+    ];
+
+    environment.systemPackages = [ cfg.package ];


ambroisie · 2024-01-29T16:02:35Z

nixos/modules/services/torrent/qbittorrent-nox.nix

+    users.users = mkIf (cfg.user == "qbittorrent") {
+      qbittorrent = {
+        group = cfg.group;
+        uid = config.ids.uids.qbittorrent-nox;


As explained, please refrain from adding more uid/gid values to NixOS.

Suggested change

uid = config.ids.uids.qbittorrent-nox;

ambroisie · 2024-01-29T16:02:57Z

nixos/modules/services/torrent/qbittorrent-nox.nix

+
+    users.groups = mkIf (cfg.group == "qbittorrent") {
+      qbittorrent = {
+        gid = config.ids.gids.qbittorrent-nox;


Same remark as for uid.

Suggested change

gid = config.ids.gids.qbittorrent-nox;

ambroisie · 2024-01-29T16:05:12Z

I'm also unsure whether we still need to use lib.mdDoc (maybe for backporting? I will have to check).

I would also argue that with lib; over the whole file is over-reaching. I'd be fine with using it in the options = ... block though.

fsnkty · 2024-02-06T07:52:29Z

nixos/modules/services/torrent/qbittorrent-nox.nix

@@ -0,0 +1,141 @@
+{ config, lib, pkgs, ... }:
+
+with lib;


you should avoid this kind of use of with to address #208242 for this module.

use inherits where you find yourself excessively reusing lib.foo

fsnkty · 2024-02-06T07:55:21Z

nixos/modules/services/torrent/qbittorrent-nox.nix

+          };
+        };
+
+        dataDir = mkOption {


is a dataDir true here for qbit, profiles seems to be the way it manages itself, a profilesdir commandline option is available.

fsnkty · 2024-02-06T07:57:01Z

nixos/modules/services/torrent/qbittorrent-nox.nix

+        ExecStart = ''
+          ${cfg.package}/bin/qbittorrent-nox \
+            --profile=${cfg.dataDir} \
+            --webui-port=${toString cfg.web.port} \


neither port options should be done with the command line options, qbittorrent has a configuration file we can define these in, we know where its state will be after all

fsnkty · 2024-02-06T08:06:24Z

seems i should have looked harder before i started on this, see master...nu-nu-ko:nixpkgs:init-nixos-qbittorrent
differences between our work now are

qBittorrent.conf options thanks to gendeepINI ( thanks eclairevoyant )
I'm missing openFirewall ( i want to include in config values here )
I'm missing a type for the configs options.
I'm missing any tests and docs additions.
I apply much more service hardening. ( the rw paths will obviously need to become as set in the service options / the defaults. ) for a exposure level of 1.1

I'll draft my own PR if I can get openFirewall and rw paths setting done in an acceptable way myself.
open to however you may want to work with this or not, would love to have the config options available with nix instead of expecting the user to write a file out themselves etc.

as reference for how my module can be used right now i have a working use case in my systems repo here

would also appreciate your insight as another current qbit user / someone who wants a service module for it.
as well as testing on aarch-64

camilosampedro · 2024-02-08T00:20:19Z

@nu-nu-ko Thank you for working on those changes, and sorry I've been absent these past days.

I'd be ok with you opening your PR, using that as the actual PR that introduces this service, and I can help testing it on my machine.

Let me know and I'll close this PR.

fsnkty · 2024-02-11T03:18:46Z

I've created #287923 with the current issues listed, I have only somewhat addressed the read write directorys and open ports issues as defaults should be filled in properly.

please ensure that PR has the same goal and functionality as you do here before closing anything, thank you.

camilosampedro · 2024-02-17T00:03:10Z

@nu-nu-ko Your PR seems to be following my goal. I'll be doing some tests and commenting on that PR. I'll close this PR for now

camilosampedro added 4 commits January 9, 2024 08:59

nixos/qbittorrent-nox: init module

71095c7

Currently there is a qbittorrent-nox package, but no configurations to make it a systemd service. I placed several basic options for this service, which should be good enough to start using the service.

nixos/qbittorrent-nox: add uids and gids

23fc6ca

These are required for setting a gid and uid for the systemd unit

nixos/qbittorrent-nox: add qbittorrent-nox to modules list

0c52251

To be able to use it

nixos/qbittorrent-nox: add tests for qbittorrent-nox

0e29d0e

github-actions bot added 6.topic: nixos Issues or PRs affecting NixOS modules, or package usability issues specific to NixOS 8.has: module (update) This PR changes an existing module in `nixos/` labels Jan 9, 2024

nixos/qbittorrent-nox: cleanup unused variables

793e454

NixOSInfra added the 12.first-time contribution This PR is the author's first one; please be gentle! label Jan 9, 2024

ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 1-10 This PR causes between 1 and 10 packages to rebuild on Linux. labels Jan 9, 2024

h7x4 added 8.has: module (new) This PR adds a module in `nixos/` 8.has: tests This PR has tests labels Jan 9, 2024

Merge branch 'NixOS:master' into create-qbittorrent-nox-service

55ee8e5

nixos/qbittorrent-nox: add service to 24.05 release-notes

a3926f6

camilosampedro changed the title ~~Create qbittorrent nox service~~ Create qbittorrent-nox service Jan 14, 2024

github-actions bot added 8.has: documentation This PR adds or changes documentation 8.has: changelog This PR adds or changes release notes labels Jan 14, 2024

camilosampedro marked this pull request as ready for review January 14, 2024 22:25

camilosampedro marked this pull request as draft January 14, 2024 22:28

nixos/qbittorrent-nox: reword 24.05 release-notes entry

d19093d

camilosampedro marked this pull request as ready for review January 14, 2024 23:00

ambroisie requested changes Jan 29, 2024

View reviewed changes

fsnkty reviewed Feb 6, 2024

View reviewed changes

camilosampedro closed this Feb 17, 2024

fsnkty mentioned this pull request Feb 17, 2024

nixos/qbittorrent: init #287923

Merged

19 tasks

	enable = mkEnableOption (lib.mdDoc "qbittorrent-nox daemon");
	enable = mkEnableOption (lib.mdDoc "qBittorent daemon");

Uh oh!

Conversation

camilosampedro commented Jan 9, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description of changes

Things done

Uh oh!

camilosampedro commented Jan 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ambroisie left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ambroisie commented Jan 29, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fsnkty commented Feb 6, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

camilosampedro commented Feb 8, 2024

Uh oh!

fsnkty commented Feb 11, 2024

Uh oh!

camilosampedro commented Feb 17, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

camilosampedro commented Jan 9, 2024 •

edited

Loading

camilosampedro commented Jan 14, 2024 •

edited

Loading

fsnkty commented Feb 6, 2024 •

edited

Loading