Added optional env variable: SCRIPT_TORRENT_DONE_FILENAME

scalerow commented 1 year ago

[x ] I have read the contributing guideline and understand that I have made the correct modifications

Description:

Optional env variable that sets script-torrent-done-filename and enables script-torrent-done-enabled :

New envirnonment variable : SCRIPT_TORRENT_DONE_FILENAME

Benefits of this PR and context:

It would be usefull with easier access to script-torrent-done-filename through this env variable, as that would simplify automation.

Considering the some usecases and challanges you can run into when torrenting:

It's not uncommon for torrents to come packaged into several files - this causes problems with importing to other services like sonarr and radarr, running a script to unpack on download-complete would be helpfull.
When using transmission without any connected services some might find it usefull to run a script for cleanup, moving the file elsewhere etc.

How Has This Been Tested?

Manual testing:

Running on headless Ubuntu Server 23.04, Docker 24.0.4, Docker Compose 2.19.1.
Built image according to your "Building image locally" howto.
Deployed using compose script both with and without the new env variable, and verified the results in settings.json.
Currently running "live" on my server.

Source / References:

LinuxServer-CI commented 1 year ago

I am a bot, here are the test results for this PR: https://ci-tests.linuxserver.io/lspipepr/transmission/4.0.3-r3-pkg-32f1d1ed-dev-3757bca6c47e4058897245bfa728e1d85331ec41-pr-253/index.html https://ci-tests.linuxserver.io/lspipepr/transmission/4.0.3-r3-pkg-32f1d1ed-dev-3757bca6c47e4058897245bfa728e1d85331ec41-pr-253/shellcheck-result.xml	Tag	Passed
amd64-4.0.3-r3-pkg-32f1d1ed-dev-3757bca6c47e4058897245bfa728e1d85331ec41-pr-253	✅
arm64v8-4.0.3-r3-pkg-32f1d1ed-dev-3757bca6c47e4058897245bfa728e1d85331ec41-pr-253	✅

aptalca commented 1 year ago

Why not just set it in the config file? It's user configurable

scalerow commented 1 year ago

Why not just set it in the config file? It's user configurable

I would argue it’s more convenient and automation friendly, beeing able to set it once with ease in f.ex a compose script, without having to worry about extra files/resources than necessary. Furthermore, since I suspect a lot of people are using Transmission paired with Radarr/Sonarr, which cannot import divided rars, I think it makes sense to resolve the issue before import, hence making it as obvious and convenient as possible!

The best solution would in my opinion to be able to choose to extract it as a feature - but that’s a feature request for another repo I think?

I might not be right, but that’s my reasoning :)

scalerow commented 1 year ago

Should I abort this PR, or leave it up?

LinuxServer-CI commented 1 year ago

This pull request has been automatically marked as stale because it has not had recent activity. This might be due to missing feedback from OP. It will be closed if no further activity occurs. Thank you for your contributions.

drizuid commented 10 months ago

Should I abort this PR, or leave it up?

Sorry for the delays in getting back to you, our backlog is quite big. We are not fans of having a ton of envvars as for the majority of our userbase, it's simply too confusing for them and poses a support nightmare for us. We will not merge this in, however, thank you for your time and effort spent creating this PR, testing it, and providing your input! While we're not accepting this PR, we still appreciate those who put in the effort!

github-actions[bot] commented 9 months ago

This pull request is locked due to inactivity

linuxserver / docker-transmission