Skip to content

Overseerr in Docker on a Synology NAS

UpdateDate
New guide Published19/03/2022


What is Overseerr

Overseerr is a web front end for the users of your Plex Server, it allows them to request new Movies and Shows which are then passed to Radarr and Sonarr for automated download.

Lets Begin

In this guide I am going to take you through the steps to get Overseerr up and running in Docker on your Synology NAS.

In order for you to successfully use this guide please complete the second of the two preceding guides.

Step 2: Setting up a restricted Docker user

This guide contains two parts:

  • Part 1 — Setting up the container via the DSM GUI
  • Part 2 — Setting up DDNS, Reverse Proxy and SSL

Part 1 — Container Set up (DSM GUI)

Downloading the Overseerr Image

Open up Docker within DSM and navigate to the ‘Registry’ section and search for ‘overseerr’ in the search box and download the ‘LinuxServer/overseerr’ version

The pop-up box will ask which version you want to download, make sure you choose ‘Latest’ from the list of available versions.

You can check the status of the download over on the ‘Image’ tab.

Setting up the container

In Docker click on the ‘Image’ tab, in the list of your containers select the ‘Overseerr’ image and click on ‘Launch’

You will now see the initial setup screen, if you like you can change the name of the container, but we are not going to change the resource limitations or make any changes to the ‘Configure capabilities’ options.

Next up we are going to click on the ‘Advanced Settings’ button, this will take you to a new window with a number of tabs which we are going to work through.

On the first tab enable ‘Auto Restart’ this will ensure Overseerr will automatically start up whenever you reboot your NAS.

Volumes / Mounts

We can now move onto the volume tab in which we will be specifying the directory where Overseerr will store its configuration files and database.

Click on Add Folder, click on the ‘docker’ folder and create a new sub-folder called ‘overseerr’ select this folder and click ‘select’

In the Mount path section for this folder enter ‘/config’ it should now look like the screenshot below.

File/FolderMount path
docker/overseerr/config

Network

We are not going to be specifying specific ports for Overseerr to use as we want to keep things simple, tick the ‘Use the same network as Docker Host’

Port Settings / Links

Don’t make any changes here.

Environment Variables (PGID,  PUID and Timezone)

Next we are going to set up a couple of environment variables that docker will use to allow the container access to our files and folders and also to tell it where we live in the world.

Click the Add button, and fill in the following details as per the table/screenshot, you will need to do one at a time.

variableValue
PUIDThe UID you obtained in the user setup guide
PGIDThe GID you obtained in the user setup guide
TZYour timezone wikipedia.org/wiki/List_of_tz_database_time_zones

You have now completed the setup of the container.

Click on Apply to move back to the initial settings screen and then click next, you will be shown an overall summary of the settings we have specified, this is a good time to double-check everything is correct. Finally, click on Done and the container should start to boot.

You should now be able to access the web interface via the IP of your NAS followed by the port 5055

e.g 192.168.0.40:5055

If you only plan on using Overseerr inside your home network you do not need to follow any further steps.

Part 2 – DDNS, SSL and Reverse Proxy

Before we start, make sure you have registered for a Synology Account as we are going to be using their DDNS service. https://account.synology.com/en-uk/register/

In order to successfully use reverse DNS you will also need to forward port 443 to you NAS IP. (You will need to check how to do this on your own router) This port is used for secure web traffic.

DDNS

A DDNS address allows you to get external access to DSM via a subdomain provided by Synology, this is useful on home internet connections where your ISP will change your IP address on a regular basis. (If you have already set this up via one of my other tutorials you can go to the next step)

In the DSM Control panel go to ‘External Access’ and then to the ‘DDNS’ tab

Click on ‘Add’, then fill out the following sections.

SectionValue
Service ProviderSynology
HostnameThis can be anything it will be used to access your NAS externally
Email:Log into your Synology account
External Address (IPv4)This should be filled in automatically
External Address (IPv6)This should be filled in automatically if your ISP is using IPv6
Get a Cert from Let’s EncryptTick this box
Enable HeartbeatTick this box

Now press OK, DSM will apply your settings. It can take a few moments to set up and the DSM interface will refresh. You will likely receive a certificate error which you will need to accept to get back into DSM.

You should now test that you can access your Diskstation via the hostname you requested and not receive any SSL errors.

Reverse Proxy

So you don’t have to open up additional ports on your router for Overseerr we are going to set up a reverse proxy subdomain. This means you and your users can access Overseerr without using a port number as it will route all traffic through the secure 443 port.

Go back into the Control Panel and access the ‘Login Portal’ then in the ‘Advanced’ tab click ‘Reverse Proxy’ and then click on ‘Create’.

We are now going to enter some rules, so when you or your users access the URL specified the request will automatically be sent to the Overseerr web UI. (Optionally you may want to use something more meaningful in the hostname section such as ‘plexrequests’ instead of ‘overseerr’)

Use the settings below, you will need to amend the Hostname sections in line with the hostname you registered earlier, and the IP of your NAS.

SettingValue
Reverse Proxy Name:overseerr
Protocol:HTTPS
Hostname:overseerr.xxx.synology.me (change the part after ‘overseerr.’ to your own hostname you registered earlier.
Port:443
Protocol:HTTP
Hostname:Your NAS IP
Port:5055

You should now be able to access the Overseerr initial setup by going to https://overseerr.yourhostname it will be a secure connection, and you should have no SSL errors.

As Overseerr has a really nice initial setup UI that takes you through the basics I won’t be covering this. The key part once completed will be to import your Plex users, so they can log in to the UI and begin making requests.

You are ready to roll 🙂

Docker Compose

You can use the below code saved as overseerr.yml in ‘/docker/overseerr’ which will get the container set up, You will then need to follow the guide from Part 2 onwards.

version: "3.8"
services:
  overseerr:
    image: ghcr.io/linuxserver/overseerr
    container_name: overseerr
    environment:
      - PUID=YOURPUID
      - PGID=YOURPGID
      - TZ=YOURTIMEZONE
    volumes:
      - /volume1/docker/overseerr:/config
    ports:
      - 5055:5055
    restart: unless-stopped
sudo docker-compose -f /volume1/docker/overseerr/overseerr.yml up -d


Throw me some bits or buy me a coffee?

If you have found my site useful please consider pinging me a tip as it helps cover the cost of running the site, you can even buy me a coffee 🙂

Buy Me A Coffee
Doge / Ethereum / Bitcoin
Published inDockerSearch / IndexersSynology

6 Comments

  1. Cory Cory

    Everything works great except the part about being able to use a let’s encrypt cert and using overseerr.xxx.synology.me. The cert doesn’t seem to support wildcards and isn’t happy when I go to overseerr.xxx.synology.me, but when I adjust the reverse proxy to xxx.synology.me and actually go to that url, the cert is proper.

  2. David K David K

    These instructions are great, set it up and works. BUT, I have for a long time, have the synology use VPN PIA. I enable it be “Create a VPN Profile”

    However, when the VPN is enabled, it seems that the reverse proxy rules are ignored by the synology box. I have a DS920+

    Is there a way to have both running at the same time?

    • David K David K

      Okay, If I disconnect the VPN and then refresh the DDNS and then re-enable the VPN connection it works. Not sure if this is a long term solution, or only works until the Synology DDNS agent refreshes the IP address

      • Dr_Frankenstein Dr_Frankenstein

        I was just replying to you other comment to say, it’s not something I have run into before as I solely vpn my Deluge and Prowlarr containers. It will be because your DDNS updates periodically so Synology will be routing to your ISP ip but because your whole box is on the VPN connection it won’t hit the proxy rules. You should in theory be able to do a manual ddns refresh so the VPN IP is given to Synology.

        • David KafrissenDAvid K David KafrissenDAvid K

          Thanks for the quick reply, I was able to solve this in the following manner.
          I setup a second DDNS and matching certificate using my asus router which supports this.

          Then I needed to REMOVE the existing certificate that was being served by the synology box, leaving it in caused the certificate checks to fail on the client.

          I also removed the DDNS entry on the synology box for
          XXXX.synology.me. Not sure if this step is needed or not. But the DDNS entry cannot be used, see below

          Quick connect works for me, and with VPN enabled, the DDNS entry for XXX.synology.me does not work and therefore is not needed.

          PPS: I try and login in using Google, however, it never completes the login

        • Steve Steve

          Apologies for hijacking this thread, but have you managed to get Prowlarr to successfully talk to Sonarr/Radarr etc when it’s running through the VPN? I’ve got Deluge and Prowlarr running through the VPN via your other tutorial but it’s never able to communicate with them due to (I assume) the VPN

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

drfrankenstein.co.uk – writing Synology Docker Guides since 2016 – Join My Discord!