Docker deployment of tidal-dl-ng #341

Easel4932 · 2025-01-16T23:10:09Z

I created a simple Dockerfile starting from a Python Image to build a container with tidal-dl-ng installed and settings.json configured with ffmpeg path. Also modified the README.md in consequence to add instructions on how to build the container and how to run it, trying to make it as simple as possible. I hope this addition can be useful to some people and that this PR is done properly. Feel free to educate me on what to modify to do this better if needed :)

…DME.md to build and run a container that has tidal-dl-ng installed with ffmpeg and path setup in settings.json.

exislow · 2025-01-17T08:50:24Z

Great idea, thank you very much for this PR. To be honest: In my opinion it is not really efficient to keep a separate settings.json in this repository, since it get usually generated by this app on the very first start and you can modify it with tdn cfg -h. Do you mind to propose a proper solution in this case? Instead of copying the settings.json you could add commands to modify the settings within the Dockerfile for example.

…ned folder creation a bit as well as removed now-useless settings.json from the repo.

Easel4932 · 2025-01-17T14:07:33Z

I modified the Dockerfile to use tidal-dl-ng cli to configure ffpmeg and download path and removed the settings.json. You were right, this is much cleaner now.

exislow · 2025-01-20T09:27:35Z

Dockerfile

+RUN apt update 
+
+# Installing nano just in case one need to edit something in the container, installing ffmpeg for tidal-dl-ng
+RUN apt install -y nano ffmpeg


Why do you need to install nano? This container is hopefully stable and nobody needs to edit anything in it. I would not recommend to install nano to keep the container as small as possible.

Indeed it is useless, it is a leftover code, from when I was tinkering, that I forgot to remove. I changed the Dockerfile accordingly, thanks for pointing that out! I also wonder if the modifications I made in the README.md are fitting with the rest of it.

exislow

Great idea. Just some details needs to be tackled.

Dockerfile

exislow · 2025-01-20T09:29:54Z

Dockerfile

+RUN pip install --upgrade tidal-dl-ng
+
+# Creating a user appuser to group users
+RUN useradd -m -u 1000 -g users appuser 


Use -d </home/dir> to create the home directory.

exislow · 2025-01-20T09:31:58Z

Dockerfile

+USER appuser
+
+# Configuring ffmpeg and deownload path
+RUN tidal-dl-ng cfg path_binary_ffmpeg /usr/bin/ffmpeg


Would not it be better to use something like $(which ffmpeg) instead of hard coding the FFmpeg path?

exislow · 2025-01-20T09:33:07Z

Dockerfile

+
+# Configuring ffmpeg and deownload path
+RUN tidal-dl-ng cfg path_binary_ffmpeg /usr/bin/ffmpeg
+RUN tidal-dl-ng cfg download_base_path /home/appuser/music


Why don't you use variables (https://docs.docker.com/build/building/variables/) instead of path repetitions?

exislow · 2025-01-20T09:34:07Z

Dockerfile

Please avoid value repetition, like /home/appuser, appuser etc. and use variables instead (https://docs.docker.com/build/building/variables/)

exislow · 2025-01-20T09:35:37Z

README.md

It would definitely make sense to combine the two docker sections into one, otherwise it is confusing for non skilled users. What do you think?

Do you think making Docker its own section is best ? I'm afraid that the README.md would be repetitive with: pip installation then pip usage then docker installation then docker usage. If you have an idea on how to arrange better the README.md, please let me know, I will take those changes into account.

exislow · 2025-01-20T09:37:45Z

README.md

+### 🐋 Using the Docker image
+Simply create a music folder to mount to the container you will create, then run :
+```bash
+docker run -v "/path/to/host/music/folder:/home/appuser/music" -v tidal-dl-volume:/home/appuser/.config/tidal_dl_ng/ -it <container-image-name>:latest <command>


By <command> you mean any tdial-dl-ng command, do not you? May tdn <command> would be a better way to express it.

exislow · 2025-01-20T09:39:08Z

README.md

+
+⚠️ The folder from the host that you map in the container must exist, if Docker creates it it might be owned by ```root``` and tidal-dl-ng **will not have the rights** to write in this folder ⚠️
+
+💡 You can also run a bash shell if you want to tinker in the container. Nano and ffmpeg are installed and the ffmpeg path is preconfigured in the ```settings.json```.


Does it make sense to map the config directory also to a local directory instead only to have it within the Docker container?

…how to cleanly separate pip and docker sections

Easel4932 · 2025-02-08T17:10:05Z

I made the modifications you suggested (which made the Dockerfile much better honestly), let me know if you want anything else changed.

… user's home, creating music folder as user, using '-m' in useradd to create its home dir

Vicente015 · 2025-02-11T20:46:13Z

Dockerfile

+# Creating music folder
+RUN mkdir -p ${MUSIC_PATH}
+
+# Configuring ffmpeg and deownload path fir tidal-dl-ng


Suggested change

# Configuring ffmpeg and deownload path fir tidal-dl-ng

# Configuring ffmpeg and download path fir tidal-dl-ng

found a typo

…ents

exislow · 2025-02-28T10:56:17Z

Dockerfile

+ENV UID="1000"
+
+# User's home path
+ENV HOME_PATH="/home/appuser"


Please still avoid value repetitions. Here: appuser

exislow · 2025-02-28T11:05:20Z

README.md

@@ -42,6 +42,9 @@ If you like this projects and want to support it, feel free to buy me a coffee

 ## 💻 Installation / Upgrade

+
+### 🐍 Installing with pip


A blank is missing after ###.

exislow · 2025-02-28T11:05:33Z

README.md

 ## ⌨️ Usage

+### 🐍 Using pip


This is misleading. Nobody is using pip here.

exislow · 2025-02-28T11:06:13Z

README.md

@@ -50,8 +53,19 @@ pip install --upgrade tidal-dl-ng
 pip install --upgrade tidal-dl-ng[gui]
 ```

+### 🐋 Building the Docker image 
+**Requirements**: Docker == 27.5.0 (other verions might work but are not tested!) 
+All you need is the ```Dockerfile``` file from this repository and be in the same directory as it.


Why would you state this, if this file is already there?

exislow · 2025-02-28T11:06:58Z

README.md

+All you need is the ```Dockerfile``` file from this repository and be in the same directory as it.
+To build the image using ```docker build``` command: 
+```bash
+docker build -t <container-image-name> .


Please replace <container-image-name> with a suitable name to avoid further errors by the user.

exislow · 2025-02-28T11:07:24Z

README.md

+```bash
+docker build -t <container-image-name> .
+```
+You can give any name you want to the container. The Dockerfile should be easily modified to fit your needs but works great as is.


With a predefined name, you can omit this sentence. Let's keep this readme tight.

Added a Dockerfile and settings.json as well as added sections in REA…

606a7ce

…DME.md to build and run a container that has tidal-dl-ng installed with ffmpeg and path setup in settings.json.

Modified Dockerfile to preconfigure ffmpeg and download path and clea…

2eb605b

…ned folder creation a bit as well as removed now-useless settings.json from the repo.

Slightly modified the README.md to reflect the previous changes.

fdf7556

exislow reviewed Jan 20, 2025

View reviewed changes

Removed nano installation from the Dockerfile as useless in itself

91eb2d9

exislow requested changes Jan 31, 2025

View reviewed changes

Easel4932 added 2 commits February 8, 2025 17:51

Modified Dockerfile as per exislow's very good recommendations

d89da75

Modified README.md as per exislow's recommentations, still wondering …

d92bd10

…how to cleanly separate pip and docker sections

Easel4932 added 2 commits February 8, 2025 18:30

Cleaned and adjusted Dockerfile, no need to manually get ownership of…

2330e57

… user's home, creating music folder as user, using '-m' in useradd to create its home dir

fixed typo in readme.md

405550c

Vicente015 reviewed Feb 11, 2025

View reviewed changes

Fixed typo in Dockerfile thanks to Vicente015 and modifying some comm…

b9783ed

…ents

Easel4932 requested a review from exislow February 17, 2025 17:47

exislow requested changes Feb 28, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docker deployment of tidal-dl-ng #341

Docker deployment of tidal-dl-ng #341

Easel4932 commented Jan 16, 2025

exislow commented Jan 17, 2025

Easel4932 commented Jan 17, 2025

exislow Jan 20, 2025

Easel4932 Jan 20, 2025

exislow left a comment

exislow Jan 20, 2025

exislow Jan 20, 2025

exislow Jan 20, 2025

exislow Jan 20, 2025

exislow Jan 20, 2025

Easel4932 Feb 8, 2025

exislow Jan 20, 2025

exislow Jan 20, 2025

Easel4932 commented Feb 8, 2025

Vicente015 Feb 11, 2025

exislow Feb 28, 2025

exislow Feb 28, 2025

exislow Feb 28, 2025

exislow Feb 28, 2025

exislow Feb 28, 2025

exislow Feb 28, 2025


		⚠️ The folder from the host that you map in the container must exist, if Docker creates it it might be owned by ```root``` and tidal-dl-ng will not have the rights to write in this folder ⚠️

		💡 You can also run a bash shell if you want to tinker in the container. Nano and ffmpeg are installed and the ffmpeg path is preconfigured in the ```settings.json```.

	# Configuring ffmpeg and deownload path fir tidal-dl-ng
	# Configuring ffmpeg and download path fir tidal-dl-ng

		@@ -42,6 +42,9 @@ If you like this projects and want to support it, feel free to buy me a coffee

		## 💻 Installation / Upgrade


		### 🐍 Installing with pip

Docker deployment of tidal-dl-ng #341

Are you sure you want to change the base?

Docker deployment of tidal-dl-ng #341

Conversation

Easel4932 commented Jan 16, 2025

exislow commented Jan 17, 2025

Easel4932 commented Jan 17, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

exislow left a 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

Easel4932 commented Feb 8, 2025

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