App Submission: qBittorrent #468

ASOwnerYT · 2023-03-26T03:01:58Z

App Submission

App name

qBittorrent

256x256 SVG icon

https://upload.wikimedia.org/wikipedia/commons/6/66/New_qBittorrent_Logo.svg

Gallery images

I don't have screenshot of the default web UI yet, for now here's a good screenshot of VueTorrent which I plan to include:

I have tested my app on:

This reverts commit 9bd6be5.

This reverts commit 731cfb5.

nmfretz · 2023-03-27T03:21:53Z

Thanks for submitting qBittorrent @ASOwnerYT! Ping me whenever you are ready for me to take a look at it.

ASOwnerYT · 2023-03-27T20:28:04Z

It's almost ready for review, I'd just like to add more screenshots and include the VueTorrent webUI

qbittorrent/umbrel-app.yml

Let's try Hotio's container again Remove HostHeaderValidation fix Change port to 8081 Revert "Change port to 8081" This reverts commit f29309c.

This reverts commit 0458804.

This reverts commit 32ec810.

ASOwnerYT · 2023-04-05T08:40:25Z

@nmfretz It's ready for review now. On my server it works well, only issue I have is I haven't found a way for the password to be automatically generated and shown in Umbrel, the default password is adminadmin which isn't ideal.

nmfretz · 2023-04-26T04:19:16Z

Thanks @ASOwnerYT. Sorry for the delay. Will review soon.

ASOwnerYT · 2023-05-07T01:28:45Z

Just wondering, is there any update on this? Thanks

nmfretz · 2023-05-08T04:33:04Z

@ASOwnerYT, sorry again for my delay in reviewing this. I am hoping to get to this early this week.

nmfretz

Thanks again for this @ASOwnerYT, really great work! I have left a review below. Once we get through relevant changes I can start testing.

On my server it works well, only issue I have is I haven't found a way for the password to be automatically generated and shown in Umbrel, the default password is adminadmin which isn't ideal.

This should be fine. A user can change the default user/password to custom ones through the app UI after they install the app. I checked and there is no way to set the default password from an environment variable.

I see that you started trying to use the hotio image that comes bundled with the alternative VueTorrent UI. What made you switch to the linuxserver image? Do you need any help troubleshooting?

nmfretz · 2023-05-10T18:45:52Z

qbittorrent/docker-compose.yml

+      - ${APP_DATA_DIR}/data/config:/config
+      - ${UMBREL_ROOT}/data/storage/downloads:/downloads
+    ports:
+      - 8094:8094


This can be removed. The app proxy and Docker's internal dns resolver will handle this.

nmfretz · 2023-05-10T18:46:47Z

qbittorrent/umbrel-app.yml

+dependencies: []
+repo: https://github.com/qBittorrent/qBittorrent
+support: https://github.com/qBittorrent/qBittorrent/issues
+port: 8080


This can be any free port that no other app is using on Umbrel. It does not have to be the same as the one the frontend web-ui is served from. Umbrel makes your app accessible at http://umbrel.local:<port>. The port that you assign to APP_PORT in the docker-compose.yml tells our App Proxy what container-port your app's frontend is found at. In this instance, qBittorrent's web-ui uses container-port 8094, so that is what you assign to APP_PORT.

We can't use port 8080 because that is used by the Lightning Node app, so there would be a clash.

You can; however, actually use port: 8094 if you want. I think the reason you were getting a port binding error when you tried this is because you bind 8094:8094 in the server container here so there is a clash.

I see that you started trying to use the hotio image that comes bundled with the alternative VueTorrent UI. What made you switch to the linuxserver image? Do you need any help troubleshooting?

Yes, the linuxserver image works as expected but the hotio image gets stuck on this error

Thanks for this link. I just tried and got it working. See here

nmfretz · 2023-05-10T19:25:37Z

qbittorrent/data/config/qBittorrent/qBittorrent.conf

+[AutoRun]
+enabled=false
+program=
+
+[BitTorrent]
+Session\DefaultSavePath=/downloads/complete
+Session\Port=6881
+Session\QueueingSystemEnabled=true
+Session\TempPath=/downloads/incomplete/
+
+[LegalNotice]
+Accepted=true
+
+[Meta]
+MigrationVersion=4
+
+[Network]
+Cookies=@Invalid()
+PortForwardingEnabled=false
+
+[Preferences]
+Connection\PortRangeMin=6881
+Connection\UPnP=false
+Downloads\SavePath=/downloads/complete
+Downloads\TempPath=/downloads/incomplete/
+WebUI\Address=*
+WebUI\Port=8094
+WebUI\ServerDomains=*
+WebUI\HostHeaderValidation=false


If this is just the default qBittorent.conf then I think we can remove this as it will be generated when the app is installed. I see you have created this bind: - ${APP_DATA_DIR}/data/config:/config so it will be persisted across app restarts and updates.

If we can delete this file, then you can also delete the qBittorrent directory that the config file is saved in and, instead, place an empty .gitkeep file in data/config so that this empty directory is included in the repo.

This config is needed as a workaround for an error that was preventing me from using the WebUI, and also to set the default download path to the "downloads/complete" folder instead of the "downloads" folder.

pinging @lukechilds for his thoughts here as well.

I see, thanks. Do you recall what the specific error was? I just tested removing this file and installing the app, and I can access the WebUI.

A default qBittorrent.conf is generated automatically that looks like this, with the save path set to /downloads/ instead of /downloads/complete/ as you note.

[AutoRun] enabled=false program= [BitTorrent] Session\DefaultSavePath=/downloads/ Session\Port=6881 Session\QueueingSystemEnabled=true Session\TempPath=/downloads/incomplete/ [LegalNotice] Accepted=true [Meta] MigrationVersion=4 [Network] PortForwardingEnabled=false [Preferences] Connection\PortRangeMin=6881 Connection\UPnP=false Downloads\SavePath=/downloads/ Downloads\TempPath=/downloads/incomplete/ WebUI\Address=* WebUI\Port=8094 WebUI\ServerDomains=*

Is the reason you want to set the downloads path to /downloads/complete/ so that qBittorrent mimics Transmission's default behaviour? The other torrent app SimpleTorrent does not mimic this and instead saves files to /downloads and I'm assuming future torrent apps will have their own default behaviours.

I do actually like the idea of torrents being saved in /downloads/complete/, but I'm hesitant to include a qBittorent.conf in the repo because it will introduce complexity down the road if an app update requires us to change this file. Existing users who update their app won't get changes we make to this default file unless we add some finicky logic and we would need to be careful not to overwrite any custom changes users have made. Plus it is nice for the qBittorrent application itself to generate a config for us without any mistakes and then users can change the config from the UI (save to `/downloads/complete/' etc..).

nmfretz · 2023-05-10T19:29:42Z

qbittorrent/docker-compose.yml

+      PROXY_AUTH_ADD: "false"
+
+  server:
+    image: linuxserver/qbittorrent:4.5.2


We need to include the multi-arch digest for this Docker image to make sure that everyone installing this app gets the exact same version of the image. To get the digest you can run:
docker pull linuxserver/qbittorrent:4.5.2
and the digest will be printed in the output.

nmfretz · 2023-05-10T19:40:13Z

qbittorrent/umbrel-app.yml

+  The qBittorrent project aims to provide an open-source software alternative to µTorrent.
+
+  Additionally, qBittorrent runs and provides the same features on all major platforms (FreeBSD, Linux, macOS, OS/2, Windows).
+
+  Bittorrent is based on the Qt toolkit and libtorrent-rasterbar library.
+
+  ⚠️ qBittorrent downloads torrents over the Clearnet, not Tor.


For the description section, a single blank newline between paragraphs places text on their own lines, like this:

but two blank newlines are needed between paragraphs to separate the lines with whitespace.

The qBittorrent project aims to provide an open-source software alternative to µTorrent. <newline here> <newline here> Additionally, qBittorrent runs and provides the same features on all major platforms (FreeBSD, Linux, macOS, OS/2, Windows).

nmfretz · 2023-05-10T19:42:07Z

qbittorrent/umbrel-app.yml

+website: https://qbittorrent.org/
+dependencies: []
+repo: https://github.com/qBittorrent/qBittorrent
+support: https://github.com/qBittorrent/qBittorrent/issues


I also see this forum we could use here: https://forum.qbittorrent.org/. Have you come across other support networks for qBittorent?

In my opinion I think it might be best to stick with the Github issues page for this. Transmission has it set to their Github issues page too.

nmfretz · 2023-05-10T19:44:42Z

qbittorrent/umbrel-app.yml

+defaultPassword: "adminadmin"
+torOnly: false
+permissions:
+  - STORAGE_DOWNLOADS


You get to add yourself as submitter here! And also add a submission field with the url of this PR as the value.
See Thunderhub app for example:

umbrel-apps/thunderhub/umbrel-app.yml

Lines 38 to 39 in 91be883

submitter: Anthony Potdevin

submission: https://github.com/getumbrel/umbrel/pull/343

nmfretz · 2023-05-10T20:12:58Z

qbittorrent/umbrel-app.yml

+category: Networking
+name: qBittorrent
+version: "4.5.2"
+tagline: A fast, easy and free BitTorrent client


This is the tagline for Transmission>

We could use the tagline from https://www.qbittorrent.org/:
Free and reliable P2P Bittorrent client

…into qbittorrent

ASOwnerYT · 2023-05-10T22:59:28Z

@nmfretz I've made all the changes you suggested, it should be ready for testing now

nmfretz · 2023-05-11T17:31:44Z

Thanks @ASOwnerYT, it is working great! Very nice work. I have responded here with some thoughts on the default qBittorrent.conf file.

nmfretz · 2023-05-11T18:16:38Z

Yes, the linuxserver image works as expected but the hotio image gets stuck on hotio/qbittorrent#14 (comment)

If you're still interested in using the hotio image so that users have the ability to switch to the VueTorrent UI, here is the set-up that worked for me just now https://github.com/nmfretz/umbrel-apps-fork/tree/qbittorrent-hotio/qbittorrent.

nmfretz · 2023-05-22T16:55:01Z

@ASOwnerYT are you okay if we use the hotio image and get this out the door? It's working quite well.

ASOwnerYT · 2023-05-22T19:53:18Z

Of course! The hotio image will probably be better.

nmfretz · 2023-05-23T00:38:13Z

Excellent. I'll get the icon and gallery images made up.

nmfretz · 2023-05-30T11:48:22Z

Thanks again for bringing qBittorent to Umbrel @ASOwnerYT! Going live to the app store now 🚀

ASOwnerYT added 7 commits March 25, 2023 20:23

Add qBittorrent

8a41747

Potential fix for port 8080 in use?

6843656

Fix some issues

d681dc4

Switch to hotio's container

731cfb5

Fix port and try removing config

9bd6be5

Revert "Fix port and try removing config"

e756fae

This reverts commit 9bd6be5.

Revert "Switch to hotio's container"

040716f

This reverts commit 731cfb5.

ASOwnerYT mentioned this pull request Mar 27, 2023

Application Request: qBittorrent #328

Closed

ASOwnerYT added 2 commits March 31, 2023 10:22

Merge branch 'getumbrel:master' into qbittorrent

8472f07

Disable proxy auth

6cdb2b4

sashazykov reviewed Apr 3, 2023

View reviewed changes

qbittorrent/umbrel-app.yml Outdated Show resolved Hide resolved

nvm ima just use the linuxserver container

0458804

Let's try Hotio's container again Remove HostHeaderValidation fix Change port to 8081 Revert "Change port to 8081" This reverts commit f29309c.

ASOwnerYT force-pushed the qbittorrent branch from a4cdb01 to 0458804 Compare April 5, 2023 08:23

ASOwnerYT added 3 commits April 5, 2023 20:23

Revert "nvm ima just use the linuxserver container"

512b77f

This reverts commit 0458804.

Change port to 8094

32ec810

Revert "Change port to 8094"

3fe2d2a

This reverts commit 32ec810.

ASOwnerYT marked this pull request as ready for review April 5, 2023 08:37

Merge branch 'getumbrel:master' into qbittorrent

288dd59

nmfretz reviewed May 10, 2023

View reviewed changes

ASOwnerYT added 3 commits May 11, 2023 10:25

Merge branch 'getumbrel:master' into qbittorrent

4e046e6

Add changes based on feedback

22273b3

Merge branch 'qbittorrent' of https://github.com/ASOwnerYT/umbrel-apps …

4986478

…into qbittorrent

nmfretz added 2 commits May 25, 2023 22:35

refactor to using hotio image

8e22fa7

update description

9cf2ae9

nmfretz mentioned this pull request May 29, 2023

Add qbittorrent app getumbrel/umbrel#1501

Closed

tweak description

d27155f

nmfretz closed this May 30, 2023

nmfretz reopened this May 30, 2023

nmfretz merged commit 4949d76 into getumbrel:master May 30, 2023

ASOwnerYT deleted the qbittorrent branch May 30, 2023 21:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

App Submission: qBittorrent #468

App Submission: qBittorrent #468

ASOwnerYT commented Mar 26, 2023 •

edited

nmfretz commented Mar 27, 2023

ASOwnerYT commented Mar 27, 2023

ASOwnerYT commented Apr 5, 2023

nmfretz commented Apr 26, 2023

ASOwnerYT commented May 7, 2023

nmfretz commented May 8, 2023

nmfretz left a comment

nmfretz May 10, 2023

nmfretz May 10, 2023 •

edited

ASOwnerYT May 10, 2023

nmfretz May 11, 2023

nmfretz May 10, 2023

ASOwnerYT May 10, 2023

nmfretz May 11, 2023

nmfretz May 10, 2023

nmfretz May 10, 2023

nmfretz May 10, 2023

ASOwnerYT May 10, 2023

nmfretz May 10, 2023

nmfretz May 10, 2023

ASOwnerYT commented May 10, 2023

nmfretz commented May 11, 2023

nmfretz commented May 11, 2023

nmfretz commented May 22, 2023

ASOwnerYT commented May 22, 2023

nmfretz commented May 23, 2023

nmfretz commented May 30, 2023

	submitter: Anthony Potdevin
	submission: https://github.com/getumbrel/umbrel/pull/343

App Submission: qBittorrent #468

App Submission: qBittorrent #468

Conversation

ASOwnerYT commented Mar 26, 2023 • edited

App Submission

App name

256x256 SVG icon

Gallery images

I have tested my app on:

nmfretz commented Mar 27, 2023

ASOwnerYT commented Mar 27, 2023

ASOwnerYT commented Apr 5, 2023

nmfretz commented Apr 26, 2023

ASOwnerYT commented May 7, 2023

nmfretz commented May 8, 2023

nmfretz left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nmfretz May 10, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ASOwnerYT commented May 10, 2023

nmfretz commented May 11, 2023

nmfretz commented May 11, 2023

nmfretz commented May 22, 2023

ASOwnerYT commented May 22, 2023

nmfretz commented May 23, 2023

nmfretz commented May 30, 2023

ASOwnerYT commented Mar 26, 2023 •

edited

nmfretz May 10, 2023 •

edited