Skip to content

Unpackerr in Docker on a Synology NAS

UpdateDate
New Guide Released02/07/2022
Amended Network Access23/07/2022
Fixed a mistake with the last edit and not giving network access.29/07/2022


What is Unpackerr

Unpackerr monitors your torrent client’s completed download folders and when a compressed file requires ‘Unpacking’ from a Zip or RAR it will do it automatically for you. It will then notify Radarr and other arrs the download is ready.

Let’s Begin

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

In order for you to successfully use this guide please complete the Setting up a restricted Docker user and the Docker Bridge guide you will also want to have Radarr, Sonarr or Lidarr set up.

Part 1 — Config File Set up

First up lets create a folder for unpackerr to keep the config files, head into Filestation and create a folder in the /docker share called unpackerr.

In order to use Unpackerr we need to set up a number of variables in the config file, I have built a version with some pre-configured basics in line with the folder structure across the guides.

Download the pre-made config file below and save it into the newly created unpackerr folder.

Right Click and Save As: unpackerr.conf

Next up we are going to edit the file, so it can send notifications to the Arrs when it has completed its work.

Making your amendments

You can edit this file in a number of ways, but to keep the guide OS agnostic we will be using the Synology Text Editor package.

Open up the config file in Text Editor you will see its nicely broken down into sections.

In the first section you can amend the preferences to your own liking I have set some sane defaults already.

In the second section you can start adding in your settings for the Arrs. Due to Radarr and Sonarr being the most commonly used applications I have left them in the file already. You will need to edit the following lines on each.

SettingsVariable to Use
url = “http://127.0.0.1:8989”Change this IP address and port in line with your personal Arrs
api_key = “0123456789abcdef0123456789abcdef”Your API key can be located in the Arrs settings pages copy and paste it between the “”
delete_orig = falseIf you want Unpackerr to delete the original compressed files when it has completed set this to ‘true’

If you are using other Arrs you can optionally copy the settings from below and add them into the config file and amend the same settings mentioned above accordingly

[[lidarr]]
  url = "http://127.0.0.1:8686"
  api_key = "0123456789abcdef0123456789abcdef"
  paths = ["/data/torrents/completed"]
  protocols = "torrent"
  timeout = "10s"
  delete_orig = false
[[readarr]]
  url = "http://127.0.0.1:8787"
  api_key = "0123456789abcdef0123456789abcdef"
  paths = ["/data/torrents/completed"]
  protocols = "torrent"
  timeout = "10s"
  delete_orig = false

We won’t be changing any of the settings in the final two sections of the config file for this guide. You can now save and exit the config file.

Part 2 — Container Setup

Downloading the Unpackerr Image

Open up Docker within DSM and navigate to the ‘Registry’ tab and search for ‘Unpackerr’.

In the list of available containers select the ‘hotio’ version, right click on it and select ‘Download’ or click the button at the top of the window.

When the dialogue pops up asking you to choose a version, make sure you choose ‘Latest’ from the list.

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 ‘Unpackerr’ image and click on ‘Launch’

The first screen will ask how you want to set up the Docker network, we are going to select the ‘synobridge’ that we created earlier.

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 Unpackerr 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 (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.

You will notice these are already added into the list of available variables just update them accordingly.

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
ARGSRemove this option otherwise you will not be able to save.

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

No ports required for Unpackerr just click ‘Next’.

Volume Settings

We will now be specifying the directories where Unpackerr will load the file and where to find our completed downloads

Click on Add Folder, and browse into the /docker share and select the unpackerr folder you created earlier, then add another folder this time selecting /data.

You will now add the Mount Paths as per the screenshot / table below.

File/FolderMount path
docker/unpackerr/config
data/data

Click Next to move 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 find that any compressed files are automatically unpacked ready for the media managers to pick the resulting file(s) up and move them.



Docker Compose

You can use the below code saved as unpackerr.yml in the ‘/docker/unpackerr’ share, however you will need to follow the start of this guide for the config setup.

version: "3.8"
services:
  unpackerr:
    container_name: unpackerr
    image: cr.hotio.dev/hotio/unpackerr
    environment:
      - PUID=YOURUID
      - PGID=YOURGID
      - UMASK=002
      - TZ=YOURTIMEZONE
    volumes:
      - /volume1/docker/unpackerr:/config
      - /volume1/data:/data
    network_mode: synobridge
    restart: unless-stopped
sudo docker-compose -f /volume1/docker/unpackerr/unpackerr.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 inDockerSynology

Be First to Comment

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!