davidnewhall / Unpackerr

• formerly unpacker-poller
• formerly deluge-unpacker

About

This application runs as a daemon on your download host. It checks for completed downloads and extracts them so Radarr, Lidarr, Sonarr, and Readarr may import them. There are a handful of options out there for extracting and deleting files after your client downloads them. I just didn't care for any of them, so I wrote my own. I wanted a small single-binary with reasonable logging that can extract downloaded archives and clean up the mess after they've been imported.

Installation

• Note: Requires access to your download location. Make sure you set the path variables correctly in the configuration. Even if they're set incorrectly this app makes a best effort attempt to locate your downloads.

Docker

This project builds automatically in Docker Cloud and creates ready-to-use multi-architecture images. The latest tag is always a tagged release in GitHub. The master tag corresponds to the master branch in GitHub and may be broken.

Use the methods below to install using Docker.

unRAID (Docker)

• Unpackerr is available in the Community Applications on unRAID.

Docker Config File

• Copy the example config file from this repo.
• Then grab the image from docker hub and run it using an overlay for the config file.

docker pull golift/unpackerr
docker run -d -v /mnt/HostDownloads:/downloads -v /your/config/unpackerr.conf:/etc/unpackerr/unpackerr.conf golift/unpackerr
docker logs <container id from docker run>

Docker Env Variables

• Instead of a config file, you may configure the docker container with environment variables.
• Any variable not provided takes the default.
• Must provide URL and API key for Sonarr or Radarr or Lidarr or any combination.
• You may provide multiple sonarr, radarr or lidarr instances using UN_SONARR_1_URL, UN_SONARR_2_URL, etc.

Sonarr

Radarr

Lidarr

Readarr

Folder

Folders are a way to watch a folder for things to extract. You can use this to monitor your download client's "move to" path if you're not using it with an *arr app.

Webhooks

This application can send a POST webhook to a URL when an extraction begins, and again when it finishes. Configure 1 or more webhook URLs with the parameters below. Works great with notifiarr.com. You can use requestbin.com to test and see the payload.

Event IDs (not all of these are used in webhooks): 0 = all, 1 = queued, 2 = extracting, 3 = extract failed, 4 = extracted, 5 = imported, 6 = deleting, 7 = delete failed, 8 = deleted

Webhook Notes

1. Nickname should equal the chat_id value in Telegram webhooks.
2. Channel is used as destination channel for Slack. It's not used in others.
3. Nickname and Channel may be used as custom values in custom templates.
4. Name is only used in logs, but it's also available as a template value as {{name}}.

Example Usage

docker pull golift/unpackerr
docker run -d -v /mnt/HostDownloads:/downloads -e "UN_SONARR_0_URL=http://localhost:8989" -e "UN_SONARR_0_API_KEY=kjsdkasjdaksdj" golift/unpackerr
docker logs <container id from docker run>

More Dockers!

If you want a container that has a bit more to it, you can try a third party option. The container provided by golift is from scratch so it has nothing more than a binary and a config file (with our defaults).

• @madcatsu maintains an Alpine Docker Container for Unpackerr. (repo)

• @hotio maintains a Custom Docker Container for Unpackerr. (repo)

Linux and FreeBSD Install

• Download a package from the Releases page.
• Install it, edit config, start it.

Example of the above in shell form:

wget -qO- https://golift.io/unpackerr/raw/master/scripts/install.sh | sudo bash

nano /etc/unpackerr/unpackerr.conf         # linux
vi /usr/local/etc/unpackerr/unpackerr.conf # freebsd

sudo systemctl restart unpackerr    # linux
service unpackerr start             # freebsd

On Linux, unpackerr runs as user:group unpackerr:unpackerr. You will need to give that user or group read and write access to your archives. That may mean adding the unpackerr user, for example, to the debian-transmission group.

On FreeBSD the app runs as nobody. That's not very good and will probably change in the future.

macOS Install

• Use homebrew.
• Edit config file at /usr/local/etc/unpackerr/unpackerr.conf
• Start it.
• Like this:

brew install golift/mugs/unpackerr
vi /usr/local/etc/unpackerr/unpackerr.conf
brew services start unpackerr

You can also use a GUI app on a Mac instead of CLI via Homebrew:

• Download a .dmg file from the Releases page.
• Copy the Unpackerr.app to /Applications.
• Run it. It starts in the menu bar as an icon.
• Click the menu bar icon and select Config -> Edit.
• Edit the config to suit your system and save.
• Click the menu bar icon again and select Config -> Reload.
• View the logs by clicking the menu bar icon and Logs -> View.
• You can add it to login items to run it automatically when you login.

The .app and the Homebrew version are the same application, but one runs in GUI mode and one does not.

Windows Install

• Extract a .exe.zip file from the Releases page into a folder like C:\Program Files\unpackerr\.
• Run the unpackerr.amd64.exe binary. This starts the app in the system tray.
• Click the systray icon and select Config -> Edit.
• Edit the config to suit your system and save.
• Click the systray icon again and select Config -> Reload.
• View the logs by clicking the systray icon and Logs -> View.
• Make a shortcut to the application in your Startup menu to run it when you login.

Troubleshooting

Make sure your Downloads location matches on all your applications! Find help on Discord.

Log files:

• Linux: /var/log/messages or /var/log/syslog (w/ default syslog)
• FreeBSD: /var/log/syslog (w/ default syslog)
• macOS: /usr/local/var/log/unpackerr.log or ~/.unpackerr/unpackerr.log
• Windows: ~/.unpackerr/unpackerr.log

If transfers are in a Warning or Error state they will not be extracted. If Unpackerr prints information about transfers you do not see in your Starr app.

Still having problems? Let me know!

Logic

The application polls radarr, readarr, sonarr and lidarr at the interval configured. The queued items are inspected for completeness. The interval of these pollers is set in the config file. 1-10 minutes is generally sufficient.

When Unpackerr finds an item in Sonarr or Radarr or Lidarr the download location is checked for a .rar file. If an extractable archive exists, and Sonarr/Radarr/Lidarr has status=Completed from your download client Unpackerr will extract the file. Files are extracted to a temporary folder, and then moved back into the download location for Completed Download Handling to import them. When the item falls out of the (Radarr/Sonarr/Lidarr) queue, the extracted files are deleted.

Contributing

Yes, please.

License

MIT - Copyright (c) 2018-2021 David Newhall II