Synology Install Readarr with Portainer

Synology Install Readarr with Portainer

My previous guide for Readarr involved the use of Task Scheduler. Today I’m offering a recommended and excellent alternative for installing the latest Readarr version via Portainer. Readarr is an eBook (and maybe eventually magazine/audiobook) collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new books from your favorite authors and will grab, sort and rename them. In this step by step guide I will show you how to install Readarr on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Readarr v0.4.2 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 folder and name it readarr. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Readarr Synology NAS Portainer Set up 1

  • STEP 4

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

Readarr Synology NAS Portainer 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 readarr. Follow the instructions in the image below.

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

version: '3.9'
services:
 readarr:
    image: ghcr.io/linuxserver/readarr:nightly
    container_name: READARR-SYNOLOGY
    healthcheck:
     test: curl -f http://localhost:8787/ || exit 1
    restart: on-failure:5
    security_opt:
      - no-new-privileges:true
    volumes:
      - /volume1/docker/readarr/books:/books:rw #If you want, you can change the following line /volume1/docker/readarr/books with the path Location of your own Books library.
      - /volume1/docker/readarr/downloads:/downloads:rw #If you want, you can change the following line /volume1/docker/readarr/downloads with the path Location of your Download folder.
      - /volume1/docker/readarr/config:/config:rw 
    environment:
      TZ: Europe/Bucharest
      PGID: 100
      PUID: 1026
    ports:
      - 8787:8787

Note: If you want, you can change the following line /volume1/docker/readarr/books with the path Location of your own Books library that is available on your NAS.
Note: If you want, you can change the following line /volume1/docker/readarr/downloads with the path Location of your Download folder on your NAS.
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.)

Readarr Synology NAS Portainer Set up 3

  • STEP 7

Scroll down on the page until you see a button called 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.

Readarr Synology NAS Portainer Set up 4

  • STEP 8

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

Readarr Synology NAS Portainer 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:8787 Click Settings. Follow the instructions in the image below.

Readarr Synology NAS Portainer Set up 6

  • STEP 11

Under Settings, click Media Management. Follow the instructions in the image below.

Readarr Synology NAS Portainer Set up 7

  • STEP 12

Under Root Folders, click +. Follow the instructions in the image below.

Readarr Synology NAS Set up 7 new 2024

  • STEP 13

In the Name field area type in Books and in the Path field area type in /books/ then click Save. Follow the instructions in the image below.

Readarr Synology NAS Portainer Set up 9

Enjoy Readarr!

🆘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 Readarr container over HTTPS, check How to Run Docker Containers Over HTTPS. In order to make Readarr 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 Readarr 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 Thursday / October 24th, 2024 at 6:21 AM