How to Install pyLoad on Your Synology NAS

by

How to Install pyLoad on Your Synology NAS

pyLoad is a Free and Open Source download manager written in Python and designed to be extremely lightweight, easily extensible and fully manageable via web. pyLoad was developed to run on NAS devices, next-gen routers and headless home servers, whatever device is able to connect to the internet and supports the Python programming language, so it’s available for all kinds of operating systems and a wide range of hardware platforms. In this step by step guide I will show you how to install pyLoad on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest pyLoad v0.4.20 release.

  • 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 folders and name it pyload. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

pyLoad Synology NAS Set up 1

  • STEP 4

Now create two new folders inside the pyload folder that you previously created at STEP 3 and name them config and downloads. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

pyLoad Synology NAS Set up 2

  • STEP 5

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 6

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

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

version: "3.9"
services:
  pyload:
    image: ghcr.io/linuxserver/pyload-ng:latest
    container_name: pyLoad
    hostname: pyload
    mem_limit: 4g
    cpu_shares: 768
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: wget --no-verbose --tries=1 --spider http://localhost:8000
    ports:
      - 9555:8000  # HTTP access
      - 9666:9666  # Click'n'Load port
    volumes:
      - /volume1/docker/pyload/config:/config:rw
      - /volume1/docker/pyload/downloads:/downloads:rw
    environment:
      TZ: Europe/Bucharest
      PUID: 1026
      PGID: 100
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value for TZ. (Select your current Time Zone from this list.)
Note: Before you paste the code above in the Web editor area below, change the value numbers for PUID and PGID with your own values. (Follow my step by step guide on how to do this.)

pyLoad Synology NAS Set up 3

  • STEP 7

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.

pyLoad Synology NAS Set up 4

  • STEP 8

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

pyLoad Synology NAS Set up 5

  • STEP 9

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

  • STEP 10

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:9555 Type in the default username and password then click SIGN IN. Follow the instructions in the image below.

⚠️Warning: the default username is pyload and the default password is pyload

pyLoad Synology NAS Set up 6

  • STEP 10

Your pyLoad dashboard at a glance!

pyLoad Synology NAS Set up 7

Enjoy pyLoad!

🆘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 pyLoad container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make pyLoad 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 pyLoad 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 Wednesday / March 6th, 2024 at 12:37 PM

🧡 I Need Your Help!