SpotDL-WebGUI

SpotDL-WebGUI

Docker app from MackAttack's Repository

Overview

Container spotDL finds songs from Spotify playlists on YouTube and downloads them - along with album art, lyrics and metadata. Additionally provides a web interface for easily adding media links to process.

Readme

View on GitHub

spotDL v4

spotDL finds songs from Spotify playlists on YouTube and downloads them - along with album art, lyrics and metadata.

MIT License PyPI version PyPi downloads Contributors Discord

spotDL: The fastest, easiest and most accurate command-line music downloader.

Read the documentation on ReadTheDocs!

Installation

Refer to our Installation Guide for more details.

Python (Recommended Method)

  • spotDL can be installed by running pip install spotdl.

  • To update spotDL run pip install --upgrade spotdl

    On some systems you might have to change pip to pip3.

Other options
  • Prebuilt executable
  • On Termux
    • curl -L https://raw.githubusercontent.com/spotDL/spotify-downloader/master/scripts/termux.sh | sh
  • Arch
  • Docker

    • Build image:

      docker build -t spotdl .

    • Launch container with spotDL parameters (see section below). You need to create mapped volume to access song files

      docker run --rm -v $(pwd):/music spotdl download [trackUrl]

    • For Docker Compose and permission-managed Docker downloads, see the Docker section in /docs/index.md.

    • Build from source

      git clone https://github.com/spotDL/spotify-downloader && cd spotify-downloader
pip install uv
uv sync
uv run scripts/build.py

      An executable is created in spotify-downloader/dist/.

Installing FFmpeg

FFmpeg is required for spotDL. If using FFmpeg only for spotDL, you can simply install FFmpeg to your spotDL installation directory: spotdl --download-ffmpeg

We recommend the above option, but if you want to install FFmpeg system-wide, follow these instructions

  • Windows Tutorial
  • OSX - brew install ffmpeg
  • Linux - sudo apt install ffmpeg or use your distro's package manager

Installing Deno

We strongly recommend installing Deno. spotDL uses yt-dlp for YouTube downloads, and some videos require Deno to download successfully. Without Deno, spotDL may fail to download some songs, including videos marked as "made for kids".

If using Deno only for spotDL, install Deno to your spotDL directory: spotdl --download-deno

If you want to install Deno system-wide instead, follow the official Deno installation guide.

Usage

Using SpotDL without options:

spotdl [urls]

You can run spotDL as a package if running it as a script doesn't work:

python -m spotdl [urls]

General usage:

spotdl [operation] [options] QUERY

There are different operations spotDL can perform. The default is download, which simply downloads the songs from YouTube and embeds metadata.

The query for spotDL is usually a list of Spotify URLs, but for some operations like sync, only a single link or file is required. For a list of all options use spotdl -h

Supported operations

  • save: Saves only the metadata from Spotify without downloading anything.

    • Usage: spotdl save [query] --save-file {filename}.spotdl

  • web: Starts a web interface instead of using the command line. However, it has limited features and only supports downloading individual songs.

  • url: Get user-friendly URL for each song from the query.

    • Usage: spotdl url [query]

  • sync: Updates directories. Compares the directory with the current state of the playlist. Newly added songs will be downloaded and removed songs will be deleted. No other songs will be downloaded and no other files will be deleted.

    • Usage: spotdl sync [query] --save-file {filename}.spotdl

      This creates a new sync file. To update the directory in the future, use:

      spotdl sync {filename}.spotdl

  • meta: Updates metadata for the provided song files.

Music Sourcing and Audio Quality

spotDL uses YouTube as a source for music downloads. This method is used to avoid any issues related to downloading music from Spotify.

Note Users are responsible for their actions and potential legal consequences. We do not support unauthorized downloading of copyrighted material and take no responsibility for user actions.

Audio Quality

spotDL downloads music from YouTube and is designed to always download the highest possible bitrate; which is 128 kbps for regular users and 256 kbps for YouTube Music premium users.

Check the Audio Formats page for more info.

Contributing

Interested in contributing? Check out our CONTRIBUTING.md to find resources around contributing along with a guide on how to set up a development environment.

Join our amazing community as a code contributor

License

This project is Licensed under the MIT License.

Install SpotDL-WebGUI on Unraid in a few clicks.

Find SpotDL-WebGUI in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for SpotDL-WebGUI Review the template variables and paths Click Install
Explore Unraid OS

Requirements

Made available as Unraid template by Unraid MackAttack and GitHub MROGHUB. Please support SpotDL Directly at their repository https://github.com/spotDL/spotify-downloader and add Extra Argument --restart always if you want to always run or restart

Categories

Downloaders > Media App > Music

Download Statistics

419,601
Total Downloads
25,700
This Month
21,035
Avg / Month

Total Downloads Over Time

Loading chart...

Related apps

Explore more like this

Explore all
Music apps

Links

Projectgithub.comSupportgithub.comRegistrygithub.comTemplateraw.githubusercontent.com

Details

Repository
spotdl/spotify-downloader
Registry
https://github.com/spotDL/spotify-downloader
Last Updated2026-06-29
First Seen2024-11-21

Runtime arguments

Web UI
http://[IP]:[PORT:8800]
Network
bridge
Shell
bash
Privileged
false

Template configuration

Music LocationPathrw

Directory for storing downloaded music files

Target
/music
Default
/mnt/user/music
AppData DirectoryPathrw

Directory for storing SpotDL configuration and cache

Target
/appdata
Default
/mnt/user/appdata/spotdl
Output FormatVariablerw

Audio output format (mp3/m4a/opus)

Target
/etc/spotdl/config.json
Default
mp3
BitrateVariablerw

Audio bitrate in kbps (128/256)

Target
/etc/spotdl/config.json
Default
128
Disable Bitrate ConversionVariablerw

Whether to disable automatic bitrate conversion

Target
/etc/spotdl/config.json
Default
False
Cookie File PathPathrw

Path to YouTube Music cookie file

Target
/appdata/cookies.txt
Default
/mnt/user/appdata/spotdl/cookies.txt
WebGUI PortPorttcp

Port for SpotDL WebGUI

Target
8800
Default
8800
WebGUI HostVariabletcp

Host binding for SpotDL WebGUI

Target
0.0.0.0
Default
0.0.0.0