hassio-addons/unpackerr/README.md

Home assistant add-on: Unpackerr

Thanks to everyone having starred my repo! To star it click on the image below, then it will be on top right. Thanks!

About

---

Extract from the author's gighub : unpackerr runs as a daemon on your download host. It checks for completed downloads and extracts them so Lidarr, Radarr, Readarr, Sonarr may import them. There are a handful of options out there for extracting and deleting files after your client downloads them.

This addon is based on the docker image https://hub.docker.com/r/hotio/unpackerr

Installation

---

The installation of this add-on is pretty straightforward and not different in comparison to installing any other add-on.

1. Add my add-ons repository to your home assistant instance (in supervisor addons store at top right, or click button below if you have configured my HA)
2. Install this add-on.
3. Click the Save button to store your configuration.
4. Set the add-on options to your preferences
5. Start the add-on.
6. Check the logs of the add-on to see if everything went well.
7. Open the webUI and adapt the software options

Configuration

This addon has no web interface - it runs as a background service. Unpackerr monitors completed downloads and extracts archives automatically.

Setup Steps

1. Configure your download client to save completed downloads to the extraction path
2. Set the watch path where extracted files should be placed
3. Configure *arr apps to monitor the watch path for imports
4. Start the addon and monitor logs for activity

Options

Option	Type	Default	Description
PGID	int	1000	Group ID for file permissions
PUID	int	1000	User ID for file permissions
TZ	str		Timezone (e.g., Europe/London)
extraction_path	str	/share/downloads_packed	Path where downloaded archives are located
watch_path	str	/share/downloads_unpacked	Path where extracted files are placed
localdisks	str		Local drives to mount (e.g., sda1,sdb1)
networkdisks	str		SMB shares to mount (e.g., //SERVER/SHARE)
cifsusername	str		SMB username for network shares
cifspassword	str		SMB password for network shares
cifsdomain	str		SMB domain for network shares

Example Configuration

PGID: 1000
PUID: 1000
TZ: "Europe/London"
extraction_path: "/share/downloads/completed"
watch_path: "/share/downloads/extracted"
localdisks: "sda1,sdb1"
networkdisks: "//192.168.1.100/downloads"
cifsusername: "dluser"
cifspassword: "password123"
cifsdomain: "workgroup"

Integration with *arr Apps

Configure your applications to use the appropriate paths:

• Download clients: Save completed downloads to extraction_path
• Sonarr/Radarr/Lidarr: Monitor watch_path for imports
• File structure: Maintain consistent folder structures

Mounting Drives

This addon supports mounting both local drives and remote SMB shares:

• Local drives: See Mounting Local Drives in Addons
• Remote shares: See Mounting Remote Shares in Addons

Custom Scripts and Environment Variables

This addon supports custom script execution and environment variable injection through the addon_config mapping:

• Custom scripts: See Running Custom Scripts in Addons
• env_vars option: Use the add-on env_vars option to pass extra environment variables (uppercase or lowercase names). See https://github.com/alexbelgium/hassio-addons/wiki/Add-Environment-variables-to-your-Addon-2 for details.

In /addon_configs/db21ed7f_unpackerr/unpackerr.conf you can set all variables according to this list of environment variables : https://github.com/davidnewhall/unpackerr

Support

Create an issue on github