How to Install PlaylistDL on Your Synology NAS

by

How to Install PlaylistDL on Your Synology NAS

PlaylistDL is a self-hosted web application for downloading songs, albums, or playlists from Spotify and YouTube as MP3 files. The application provides a web interface for users to input links, which are then downloaded as audio files using spotdl (for Spotify) or yt-dlp (for YouTube). In this step by step guide I will show you how to install PlaylistDL on your Synology NAS using Docker & Portainer.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

Install Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

  • STEP 3

Go to File Station and open the docker folder. Inside the docker folder, create one new folder and name it playlistdl. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

PlaylistDL Synology NAS Set up 1

  • STEP 4

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

1 Synology Portainer Add Stack

  • STEP 5

In the Name field type in playlistdl. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

services:
  playlistdl:
    image: tanner23456/playlistdl:v2
    container_name: PlaylistDL
    healthcheck:
      test: ["CMD-SHELL", "nc -z 127.0.0.1 5000 || exit 1"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    ports:
      - 5005:5000
    environment:
        ADMIN_USERNAME: marius
        ADMIN_PASSWORD: mariushosting 
        AUDIO_DOWNLOAD_PATH: /volume1/docker/playlistdl
        CLEANUP_INTERVAL: 300
    volumes:
      - /volume1/docker/playlistdl:/volume1/docker/playlistdl:rw
    restart: on-failure:5

Note: Before you paste the code above in the Run command area below, change the value for ADMIN_USERNAME. Add your own username. marius is an example for a username. You should use your own username.
Note: Before you paste the code above in the Run command area below, change the value for ADMIN_PASSWORD. Add your own password. mariushosting is an example for a password. You should use your own password.

PlaylistDL Synology NAS Set up 2

  • STEP 6

Scroll down on the page until you see a button named Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

PlaylistDL Synology NAS Set up 3

  • STEP 7

If everything goes right, you will see the following message at the top right of your screen: “Success Stack successfully deployed“.

PlaylistDL Synology NAS Set up 4

  • STEP 8

Go back to STEP 1 or you will deal with karma 🙂

  • STEP 9

The installation process can take up to a few seconds/minutes. It will depend on your Internet speed connection. Now open your browser and type in http://Synology-ip-address:5005 At the top right of the page, click Admin. Follow the instructions in the image below.

PlaylistDL Synology NAS Set up 5

  • STEP 10

A new pop up window will open. Type in your own Username (ADMIN_USERNAME) and Password (ADMIN_PASSWORD) that you have previously added at STEP 5, then click Login. Follow the instructions in the image below.

PlaylistDL Synology NAS Set up 6

  • STEP 11

Type in the URL of the audio that you want to download, then click Download. Follow the instructions in the image below. Your files will be available in the playlistdl folder that you have previously created at STEP 3.

PlaylistDL Synology NAS Set up 7

Enjoy PlaylistDL!

🆘TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article.

Note: If you want to run the PlaylistDL container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make PlaylistDL work via HTTPS, it’s mandatory to activate WebSocket.

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find out how to update the PlaylistDL container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Monday / November 18th, 2024 at 4:31 AM

🧡 I Need Your Help!