This Docker image periodically tracks and downloads new music for your library using spotDL. New tracks are downloaded from YouTube and Spotify's metadata is embedded. You can chose from various formats (the default is opus) and add custom options to the spotDL execution command. For more information, read the docs.
You can find the Dockerfile and all the resources used to create this image in my GitHub repository. If you find this useful, please leave a ⭐. Feel free to request new features or make a pull request if you're up for it! 💪
The following docker-compose creates a container that downloads new music everyday at 00:00 AM.
name: spotify-downloader
services:
spotify-downloader:
image: pjmeca/spotify-downloader:latest
container_name: spotify-downloader
restart: unless-stopped
volumes:
- /your/main/music/path:/music # (Required) Change this
- /path/to/tracking.yaml:/app/tracking.yaml:ro # (Required) Change this
- /logs:/app/logs # (Optional)
environment:
CRON_SCHEDULE: "0 0 * * *" # (Required) Customize your cron if needed
CLIENT__ID: "y0ur5p071fycl13n71d" # (Required) Change this
CLIENT__SECRET: "y0ur5p071fycl13n753cr37" # (Required) Change this
TZ: Europe/Madrid # (Recommended) Your timezone
FORMAT: "opus" # (Optional) Music format. Must be compatible with spotDL. Defaults to "opus".
OPTIONS: "" # (Optional) Additional spotDL options. Don't add here your Spotify credentials.Then run:
docker compose -f ./docker-compose.yml up -d
Each time the script inside the container runs, it reads the tracking.yaml file (you must supply this file as a read-only volume) and downloads all its contents. You don't need to stop or redeploy your container each time the file gets updated; changes will be read automatically on the next run.
Below is an example of tracking.yaml. The name field is used as a folder name, which will be created if it does not exist. If you want to download multiple URLs to the same folder, create multiple entries with the same name.
Optionally, you can specify if you wish to refresh each entry (defaults to True) in case it already contains files. It is advised to set this field for artists who do not publish new tracks frequently, as it will drastically decrease Spotify's API calls, thus reducing the risk of receiving too many 429 HTTP codes.
artists:
- name: Dua Lipa
url: https://open.spotify.com/intl-es/artist/6M2wZ9GZgrQXHCFfjv46we
- name: The Beatles
url: https://open.spotify.com/intl-es/artist/3WrFJ7ztbogyGnTHbHJFl2
refresh: false
- name: Olivia Rodrigo
url: https://open.spotify.com/intl-es/artist/1McMsnEElThX1knmY4oliG
refresh: true
playlists:
- name: Los 90 España
url: https://open.spotify.com/playlist/37i9dQZF1DWXm9R2iowygpuser@host:/music$ tree -d
.
├── Dua Lipa
├── Los 90 España
├── Olivia Rodrigo
└── The Beatles- 2.0.0: .Net Release
- 1.1.2: Upgrade
spotdltov4.2.8 - 1.1.1: Fix: A debug directory was mistakenly introduced in the build of the release image
- 1.1.0: Added
refreshfield totracking.yaml - 1.0.0: Added playlists; first stable release
- 0.0.4: Fixed download directories (again)
- 0.0.3: Displayed program start & end time
- 0.0.2: Fixed download directories
- 0.0.1: Initial release
Note
In September 2024, version 2.0.0 of spotify-downloader was released. This major version included a rewrite of the original code in Python. The reason behind this decision was to address a continuous series of 429 errors from the Spotify API unhandled by spotDL. I followed all the recomendations suggested in their issue, but it still didn't work. So, I decided to take a different approach, giving myself more flexibility to achieve what I really need.
The reason why this change was made in .NET instead of sticking with Python is just that I am much more fluent in the former.
- The spotDL project for providing the core functionality of this image.
- The cron project for offering an easy way to display cron expressions in a human-friendly way.