hadryan / ytmusicdownloader

Service that downloads music from YouTube automatically. Service is manageable through an integrated API.

YtMusicDownloader

YtMusicDownloader is a python service that downloads music from YouTube automatically. Service is manageable through an integrated API.
YtMusicDownloader uses youtube-dl to download files. Shout-outs to them and here is their website.
To see features and usage of the API, refer to "YtMusicDownloader/docs/API User Guide.md". this document is also available on "/" once the web server is running.
The project integrates docker and the simplest way to use it is to clone the whole project and use docker. This guide will go over on how to do this, but you can refer to the docker documentation for any problems or if you want to configure more advanced stuff yourself.

Installation

1. Install Docker

Linux (debian based)

1. Update your system
   sudo apt update
2. Install requirements
   sudo apt install apt-transport-https ca-certificates curl software-properties-common
3. Install Docker package
   sudo snap install docker

If snap is not installed, install it with sudo apt install snapd.

Mac OS and Windows 10

Follow the docker documentation.

2. Download the project from Github

Linux and Mac OS

1. Create a folder
   sudo mkdir ~/qmk
2. Go to the folder location
   cd ~/qmk
3. Download the project from GitHub
   git clone https://github.com/hQamonky/YtMusicDownloader.git

You can of course do this manually if you prefer: Download zip file form github and unzip it into ~/qmk.

Windoesn't 10

1. Open the file explorer and go to C:\Program Files.
   Create a folder names "qmk".
2. Open the folder and do a "Shift+Right Click" -> "Open PowerShell window here".
   Run the command git clone https://github.com/hQamonky/YtMusicDownloader.git
   You can do this manually if you prefer: Download zip file form github and unzip it into C:\Program Files\qmk.

3. Build the docker image

Before actually building the image, you should edit the Dockerfile. So open it: gedit ~/qmk/YtMusicDownloader/Dockerfile
You'll see a line that says RUN adduser -DH -u 1000 qmk 1000. This is useful in order to access the files that are being downloaded, without the need of entering a root password.
Here you have 2 options:

1. Find your current user id and group id and replace the two 1000s in the Dockerfile with your own ids (the first 1000 is the user id and the last is the group id)
2. Don't bother with the Dockerfile but you'll have to call the /configuration/user endpoint and set use_custom_user="false"

It is most likely that your user id and group id are 1000. But to check that out, run the id command in the terminal (for windows users, google it).
Note: Do not change anything else in the adduser command, especially "qmk"!
Finally, build the image: sudo docker build --no-cache -t qmk_yt_music_dl:1.0 ~/qmk/YtMusicDownloader
For noob... erhum.. I mean Windows users, replace ~/qmk/YtMusicDownloader by C:\\Program Files\qmk\YtMusicDownloader.

4. Run the image to create a container

Use the command:
sudo docker run -p 8092:8080 -v ~/qmk/YtMusicDownloader:/usr/src/app -v ~/Music:/Music -d --name qmk_ymd qmk_yt_music_dl:1.0
Here you can customize this command if you want:

• 8092 is the port you will be using to access the API.
• -v enables the docker container to access a folder on the host machine.
  • -v ~/qmk/YtMusicDownloader:/usr/src/app is required and cannot be changed.
  • -v ~/Music:/Music Here you can change to the path that you want.
    This option can be used to set a folder where you want the app to output the downloads. You can also add more folders with more -v flags if you want.
• The -d option makes the container run in the background and it gives you the id of the container.
  You can omit this option if you want to run the app in the foreground.
• The --name qmk_ymd option gives a name to the container, you can name it whatever you want. It is optional but we will use it for starting and stopping the container.

Once you have executed this command, the container will be started. Stop it with sudo docker stop qmk_ymd.

Usage

Start the program

Simply run: sudo docker start qmk_ymd

Stop the program

Just run sudo docker stop qmk_ymd.
If you have any problem, like you don't remember the name you gave it or something, here's how to deal with it.
First display the information of the running containers with sudo docker ps.
Write down the container id or the name of your container.
Then stop the container with:
sudo docker stop container_id (replace container_id with the id (or name) you just retrieved)
You can also use the docker kill command, refer to the docker documentation for more information on that.

Update

Unfortunately, there is no "simple" update process, you basically have to do the whole installation process again :)
Well not everything actually, you already have installed docker and setup the container. So depending on the update, might not need to rebuild the docker container.
Be aware that the following steps might (normally should not) overwrite your data. If you don't want to lose it, make a backup of ytMusicDownloader.db and of configuration.json from ~/qmk/YtMusicDownloader/src/.

1. Go to project folder: cd ~/qmk/YtMusicDownloader
2. Update the project from GitHub: git pull
3. Restart your container: sudo docker restart container qmk_ymd
   If this works, you're good and you don't need to go any further.
   If it doesn't it means that you have to rebuild the docker container and do a "full update". So continue with the following steps.
4. Remove the docker container: sudo docker container rm -f qmk_ymd
5. If needed, edit the Dockerfile and enter your user id and group id: gedit ~/qmk/YtMusicDownloader/Dockerfile
6. Build the image: sudo docker build --no-cache -t qmk_yt_music_dl:latest ~/qmk/YtMusicDownloader (you can omit the --no-cache flag to go faster, but consider that it might cause problems)
7. Run the image: sudo docker run -p 8092:8080 -v ~/qmk/YtMusicDownloader:/usr/src/app -v ~/Music:/Music -d --name qmk_ymd qmk_yt_music_dl

Go a little further

I suggest that you create shortcuts to handle the docker commands.

Linux (might also work on Mac OS)

Create update scripts

Basic update

Create gedit ~/qmk/YtMusicDownloader/basic_update.sh

#!/bin/sh

cd ~/qmk/YtMusicDownloader
git pull
docker restart container qmk_ymd

Save and exit.
Make the file executable: sudo chmod +x ~/qmk/YtMusicDownloader/basic_update.sh
To run the script: sudo ~/qmk/YtMusicDownloader/basic_update.sh

Full update

Create gedit ~/qmk/YtMusicDownloader/full_update.sh

#!/bin/sh

cd ~/qmk/YtMusicDownloader
git pull
docker container rm -f qmk_ymd
docker build --no-cache -t qmk_yt_music_dl:latest ~/qmk/YtMusicDownloader
docker run -p 8092:8080 -v ~/qmk/YtMusicDownloader:/usr/src/app -v ~/Music:/Music -d --name qmk_ymd qmk_yt_music_dl

Don't forget to add a command in the script to edit the Dockerfile if you need to!
Save and exit.
Make the file executable: sudo chmod +x ~/qmk/YtMusicDownloader/full_update.sh
To run the script: sudo ~/qmk/YtMusicDownloader/full_update.sh

Create aliases

Create file gedit ~/.bash_aliases and insert the following:

# qmk software
alias ymd-st="sudo docker start qmk_ymd"  
alias ymd-sp="sudo docker stop qmk_ymd"  
alias ymd-bu="sudo ~/qmk/YtMusicDownloader/basic_update.sh"  
alias ymd-fu="sudo ~/qmk/YtMusicDownloader/full_update.sh"  

Apply your changes with source ~/.bash_aliases.

Create desktop launcher

Create file sudo gedit /usr/share/applications/qmk_yt_music_downloader.desktop and insert the following:

[Desktop Entry]  
Version = 1.0  
Type = Application  
Terminal = false  
Name = QMK YT Music Downloader  
Exec = sudo docker start qmk_ymd %f  
Icon = ~/qmk/YtMusicDownloader/icon.png  
Categories = Application;  

If you want to have a terminal open when running the app, remove the %f on the "Exec" line.
For this launcher to work, it is required to make the system not ask for sudo password.
Edit the file sudo gedit /etc/sudoers and add the following line at the end of the file:

qmk ALL=(ALL:ALL) NOPASSWD:/snap/bin/docker

Note: you have to replace "qmk" with your own username.
Create an icon and rename/copy it to ~/qmk/YtMusicDownloader/icon.png.
Apply changes with sudo update-desktop-database.
You could also create a stop or update launcher if you want. I mean, be creative, do whatever.

Make program run at startup

There are several ways to do this: use cron, use the "Startup Applications" program, etc.
I'll let you google this if you want, I'm just laying this here as a suggestion.