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

External Access

You have some choices when it comes to making your new container accessible from outside your home network, these come with different levels of security and convenience. This mini section is generic but covers the basics of getting this guide up and running and is entirely optional.

  • Synology’s DDNS (Dynamic Domain Name System) with a TLS Certificate and Reverse Proxy
    This is useful if you have some family members or friends that need access to something like Overseerr or Jellyseer and is covered below.

  • Tailscale or Wireguard VPN
    If just you are accessing these services, and you don’t want to expose them to the internet this would be the more secure choice. See my other separate guides.

  • Cloudflare Tunnels
    I don’t currently use these, so I would recommend watching the Wundertech guide on how they work.

A note on Double NAT or CGNAT
Unfortunately more ISPs are moving to these methods of address allocation as the IPv4 address space is getting low on available addresses. If your ISP is doing this your choices are more limited.

You can test if this is the case by checking the WAN IP on your Router/Modem settings and then comparing it to the one shown on portchecker.co. If they are different you are likely Double NAT and will either need to see if you can pay your ISP for a standard IPv4 address or use Tailscale or Cloudflare Tunnels for access.

Using the built-in tools on DSM

The first step of this process is to forward port 443 on your Router to your NAS IP Address, how you do this will depend on your router model, so please refer to its manual.

Router (External):443 > NASIP (Internal):443

Next 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/ If you already have this set up move to the next step.

DDNS (Dynamic Domain Name System)

A DDNS address allows you to get external access to your container via an address provided by Synology, this is useful on home internet connections where your ISP will change your IP address on a semi-regular basis.

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 unique address just for you so keep the name generic.
minecraft.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.

Reverse Proxy

We are going to set up a reverse proxy subdomain for the address you just register. This means you and your users can access the container 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 containers web UI.

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:Give it a meaningful name in line with the container you are setting up.
Protocol:HTTPS
Hostname:containername.xxx.synology.me
containername‘ will be the name you want to use to access this container
.xxx.synology.me‘ will be the exact name you registered earlier
Port:443
Protocol:HTTP
Hostname:‘localhost’ or your NAS IP address
Port:The UI Port Number from the yaml in the guide you are following

On the second tab ‘Custom Header’ click on Create then WebSocket, this will add two entries for WebSockets to function correctly, you can now press save.

You should now be able to access the web UI of the container by going to the address you just set up in the reverse proxy, it will be a secure connection, and you should have no certificate 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

Looking for some help, join our Discord community

If you are struggling with any steps in the guides or looking to branch out into other containers join our Discord community!

Buy me a beverage!

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 stay hydrated. Plus 10% goes to the devs of the apps I do guides for every year.

Published inDockerSearch / Indexers 7.1Synology

47 Comments

  1. Mskenn Mskenn

    I am unable to access overseerr from outside my network.

    I have a Bell Aliant Gigahub that I have to put into ADMZ to get a public IP to my UDM-PRO.

    I have any IP trying to access 443 on my UDMP forwarded to 443 of my synology but still no go when I get up the reverse proxy.

    • Dr_Frankenstein Dr_Frankenstein

      First thing I would check is that the port is showing as open which would mean its reaching the Synology proxy.
      https://portchecker.co/

      If it is showing as open what happens when you access the URL does it immediately time out, take 30 seconds or give a specific error?

      Let me know, but we may need to take this to email if it’s not working.

      • Mskenn Mskenn

        When I check 443 for my public IP it says its open.

        When I try to access the URL it immediately times out with “Safari can’t connect to server”

        • Dr_Frankenstein Dr_Frankenstein

          OK that’s a good start. When accessing your address e.g. overseerr.mskenn.synology.me make sure you have https:// at the start. Also make sure your settings match up with the screenshots.

          If It’s still not working can you ping me a message via my Help Me! Page as I may need to see your settings in order to help.

  2. Hey Doc.
    I’m having a problem logging into the overseer.
    After clicking on Sign In, a login box opens, after clicking on enter the box closes and nothing happens.
    Analyzing the log among some errors appears one saying the following:
    Failed to retrieve GitHub releases. This may be an issue on GitHub’s end. Overseerr can’t check if it’s on the latest version.
    ————————————————– ————————————————– ———
    Something went wrong authenticating with Plex account {\”errorMessage\”:\”Invalid auth token\”,\”ip\”:\”::ffff:172.20.0.1\”}

    I’ve tried stopping and restarting the container, without success, any tips on how to fix it? I can send you the full log if you want.

  3. NA NA

    Instead of part 2, would it be possible to use Cloudflare tunnel? A guide on that would be cool!

  4. David David

    Hi there, thanks so much for your amazing guides!

    Somehow Overseerr is loading very slow – online I read the following:

    {“I found out that DNS was the slowing factor, I was already using the normal bridge by adding:
    dns:
    – 1.1.1.1
    – 8.8.8.8
    into the overseerr section in my docker-compose file, the app was blazing fast!”}

    I am a beginner though, and am not sure if anyway Overseerr in general is slow, if it will help and also how to add this relating to ‘synobridge’ — I’m curious what your thoughts are.

    • Dr_Frankenstein Dr_Frankenstein

      Good tip I have seen this discussed in our Discord. It’s a shame it can’t currently be added into the Docker UI. However you can set your overall NAS to use much faster DNS services vs the likely slower one from your ISP (Control Panel > Networking > ‘Manually Configure DNS Server’)

      synobridge wise it has no real world bearing on the speed.

    • Brad Brad

      How do we set the DNS on the container? I’ve read this speeds it up as well but not sure how to do this

      • Dr_Frankenstein Dr_Frankenstein

        You can set your overall nas dns from network settings and then manually setting it to something nice and fast like 9.9.9.9 and 1.1.1.1 as the secondary

      • Dr_Frankenstein Dr_Frankenstein

        The only way to set the container dns is using compose to start the container.

  5. When setting up the reverse proxy, it says that the domain is already in use? When I log into my Synology account, the domain is on me though.

      • Joesoes Joesoes

        For example, yes. I resolved the issue by removing and adding the DDNS at account.synology.com. Still having issues accessing overseerr outside of my network though.

        • Dr_Frankenstein Dr_Frankenstein

          Key thing is to test your port forwarding is working using something like https://portchecker.co/ for port 443 – Any issues though ping me an email via my contact page or jump on Matrix or Discord

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!