Skip to content

Overseerr in Docker on a Synology NAS

Please note if you are using DSM7.2 or higher you should use the Container Manager version of this guide from the menu.
This guide has reached the end of its updates as most people are now on the latest DSM update - This guide is correct as of 08/12/2023 however no further updates will be added.
UpdateDate
Amended the path to save the compose file – this is for security, so the container has no access to the file contents.14/04/2023
Historic updates now at the end of the guide.


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.

Let’s 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 follow the two steps below first.

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 be greeted with the Network screen, we will be using the ‘synobridge’ network we created earlier select it from the list and click Next.

General Settings

Next you will be greeted with the General Settings screen, this is where you can start specifying some of your preferences.

You can change the name of the container to anything you like, and you may want to enable Auto Restart as this will ensure Overseerr starts automatically if you reboot your NAS.

You will also notice a Configure capabilities button — don’t change anything in here!

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.

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.

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

Port Settings / Links

You do not need to set up anything on these tabs.

Press ‘Save’ to go back to the initial setup screen, then press ‘Next’

Port Settings

We won’t be changing any of the ports the container uses. You can repeat the ones shown on the right side of the settings page ‘Container Port’ onto the left side ‘Local Port’ once you have done this press ‘Next’.

Volume Settings

We can now be specifying where Overseerr will store its configuration files.

Click on Add Folder, select on the ‘docker’ share 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

Click next to go to the final screen.

Summary

You have now completed the setup of the container.

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

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 the reverse proxy 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 (Dynamic Domain Name System)

A DDNS address allows you to get external access to Overseerr 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.

Note: If you want to access DSM via this new address you will either need to create an additional Reverse Proxy for it or open port 5001 on your router.

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 will be the address used to identify your NAS so make it personal to you not specific to this guide.
overseerr.synology.me = BAD
myawesomenas.synology,me =GOOD
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.xxx.synology.me (use the address you used in the reverse proxy) 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 🙂


Historic UpdatesDate
New guide Published19/03/2022
Updated with DSM7.1 Steps and Screenshots21/06/2022
Added new port settings and Docker Bridge Network23/07/2022
Compose version number removed and small wording amendments09/04/2023
Historic Updates

Buy Me a Coffee or a Beer

If you have found my site useful please consider pinging me a tip as it helps cover the cost of running things or just lets me get the odd beverage. Plus 10% goes to the devs of the apps I do guides for every year.

Published inDockerSearch / Indexers 7.1Synology

47 Comments

  1. Jack Offenbedt Jack Offenbedt

    Can you add a section on how to update Overseerr on Synology? I’ve done it a couple of times and have no idea what I did or how/why it worked.

  2. mike mike

    I’m getting hung up on the step of creating the DDNS. I seem to be doing just fine and things look like they were successful up until I try to access my NAS from a browser window using either the IP address or the hostname I created.

    At that point, I simply receive a blank white page bearing the message: “Invalid Host header”. Is there further configuration I was meant to do (perhaps port forwarding) before this step?

    I appreciate any thoughts you have on my issue, thanks!

    • Dr_Frankenstein Dr_Frankenstein

      Hey Mike, if you have forwarded just port 80 and 443 for the SSL certs you won’t be able to access DSM unless you open up port 5001 or add a Reverse Proxy. The proxy we setup for overseer will only give access to overseer. If you need any extra help reach out on Discord or ping me an email via my contact page (top left of this site)

  3. 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.

  4. 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

Your email address will not be published. Required fields are marked *

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!