index

Web Server

Examples. Prefix: UN_WEBSERVER_, Header: [webserver]

Using the config file:

[webserver]
## The web server currently only supports metrics; set this to true if you wish to use it.
 metrics = false
## This may be set to a port or an ip:port to bind a specific IP. 0.0.0.0 binds ALL IPs.
 listen_addr = "0.0.0.0:5656"
## Recommend setting a log file for HTTP requests. Otherwise, they go with other logs.
 log_file = ''
## This app automatically rotates logs. Set these to the size and number to keep.
 log_files = 10
 log_file_mb = 10
## Set both of these to valid file paths to enable HTTPS/TLS.
 ssl_cert_file = ''
 ssl_key_file = ''
## Base URL from which to serve content.
 urlbase = "/"
## Upstreams should be set to the IP or CIDR of your trusted upstream proxy.
## Setting this correctly allows X-Forwarded-For to be used in logs.
## In the future it may control auth proxy trust. Must be a list of strings.
## example: upstreams = [ "127.0.0.1/32", "10.1.2.0/24" ]
 upstreams = []

Using environment variables:

## Web Server
UN_WEBSERVER_METRICS=false
UN_WEBSERVER_LISTEN_ADDR=0.0.0.0:5656
UN_WEBSERVER_LOG_FILE=
UN_WEBSERVER_LOG_FILES=10
UN_WEBSERVER_LOG_FILE_MB=10
UN_WEBSERVER_SSL_CERT_FILE=
UN_WEBSERVER_SSL_KEY_FILE=
UN_WEBSERVER_URLBASE=/
UN_WEBSERVER_UPSTREAMS=

Metrics

The web server currently only provides prometheus metrics, which you can display in Grafana. It provides no UI. This may change in the future. The web server was added in v0.12.0.

Config Name	Variable Name	Default / Note
metrics	`UN_WEBSERVER_METRICS`	`false` / Extracted folders are written with this mode
listen_addr	`UN_WEBSERVER_LISTEN_ADDR`	`"0.0.0.0:5656"` / ip:port to listen on; `0.0.0.0` is all IPs.
log_file	`UN_WEBSERVER_LOG_FILE`	No Default / Provide optional file path to write HTTP logs.
log_files	`UN_WEBSERVER_LOG_FILES`	`10` / Log files to keep after rotating. `0` to disable.
log_file_mb	`UN_WEBSERVER_LOG_FILE_MB`	`10` / Max size of HTTP log files in megabytes
ssl_cert_file	`UN_WEBSERVER_SSL_CERT_FILE`	No Default / Path to SSL cert file to serve HTTPS.
ssl_key_file	`UN_WEBSERVER_SSL_KEY_FILE`	No Default / Path to SSL key file to serve HTTPS.
urlbase	`UN_WEBSERVER_URLBASE`	`"/"` / Base URL path to serve HTTP content.
upstreams	`UN_WEBSERVER_UPSTREAMS`	`[]` / List of upstream proxy CIDRs or IPs to trust.

Folder Settings

Examples. Prefix: UN_FOLDERS_, Header: [folders]

Using the config file:

## Global Folder configuration that affects all watched folders.
[folders]
## How often poller checks for new folders.
## The default of `0s` will disable the poller on all systems except Docker.
## Set this value to `1ms` to disable it in Docker.
 interval = "0s"
## How many new folder events can be immediately queued. Don't change this.
 buffer = 20000

Using environment variables:

## Folder Settings
UN_FOLDERS_INTERVAL=1s
UN_FOLDERS_BUFFER=20000

Config Name	Variable Name	Default / Note
interval	`UN_FOLDERS_INTERVAL`	`"0s"` / How often poller checks for new folders. Use `1ms` to disable it.
buffer	`UN_FOLDERS_BUFFER`	`20000` / How many new folder events can be immediately queued.

Sonarr Settings

Examples. Prefix: UN_SONARR_, Header: [[sonarr]]

Using the config file:

## Leaving the [[sonarr]] header uncommented (no leading hash #) without also
## uncommenting the api_key (remove the hash #) will produce a startup warning.
[[sonarr]]
 url = "http://127.0.0.1:8989"
 api_key = "0123456789abcdef0123456789abcdef"
## List of paths where content is downloaded for this app.
## Used as fallback if the path the Starr app reports does not exist or is not accessible.
 paths = ['/downloads']
## Default protocols is torrent. Alternative: "torrent,usenet"
 protocols = "torrent"
## How long to wait for a reply from the backend.
 timeout = "10s"
## How long to wait after import before deleting the extracted items.
 delete_delay = "5m"
## If you use this app with NZB you may wish to delete archives after extraction.
## General recommendation is: do not enable this for torrent use.
## Setting this to true deletes the entire original download folder after import.
 delete_orig = false
## If you use Syncthing, setting this to true will make unpackerr wait for syncs to finish.
 syncthing = false

Using environment variables:

## Sonarr Settings
UN_SONARR_0_URL=http://sonarr:8989
UN_SONARR_0_API_KEY=0123456789abcdef0123456789abcdef
UN_SONARR_0_PATHS_0=/downloads
UN_SONARR_0_PROTOCOLS=torrent
UN_SONARR_0_TIMEOUT=10s
UN_SONARR_0_DELETE_DELAY=5m
UN_SONARR_0_DELETE_ORIG=false
UN_SONARR_0_SYNCTHING=false

Config Name	Variable Name	Default / Note
url	`UN_SONARR_0_URL`	No Default / URL where this starr app can be accessed.
api_key	`UN_SONARR_0_API_KEY`	No Default / Provide URL and API key if you use this app.
paths	`UN_SONARR_0_PATHS_0`	`["/downloads"]` / File system path where downloaded items are located.
protocols	`UN_SONARR_0_PROTOCOLS`	`"torrent"` / Protocols to process. Alt: `torrent,usenet`
timeout	`UN_SONARR_0_TIMEOUT`	`"10s"` / How long to wait for the app to respond.
delete_delay	`UN_SONARR_0_DELETE_DELAY`	`"5m"` / Extracts are deleted this long after import, `-1s` to disable.
delete_orig	`UN_SONARR_0_DELETE_ORIG`	`false` / Delete archives after import? Recommend keeping this false.
syncthing	`UN_SONARR_0_SYNCTHING`	`false` / Setting this to true makes unpackerr wait for syncthing to finish.

Radarr Settings

Examples. Prefix: UN_RADARR_, Header: [[radarr]]

Using the config file:

## Leaving the [[radarr]] header uncommented (no leading hash #) without also
## uncommenting the api_key (remove the hash #) will produce a startup warning.
[[radarr]]
 url = "http://127.0.0.1:7878"
 api_key = "0123456789abcdef0123456789abcdef"
## List of paths where content is downloaded for this app.
## Used as fallback if the path the Starr app reports does not exist or is not accessible.
 paths = ['/downloads']
## Default protocols is torrent. Alternative: "torrent,usenet"
 protocols = "torrent"
## How long to wait for a reply from the backend.
 timeout = "10s"
## How long to wait after import before deleting the extracted items.
 delete_delay = "5m"
## If you use this app with NZB you may wish to delete archives after extraction.
## General recommendation is: do not enable this for torrent use.
## Setting this to true deletes the entire original download folder after import.
 delete_orig = false
## If you use Syncthing, setting this to true will make unpackerr wait for syncs to finish.
 syncthing = false

Using environment variables:

## Radarr Settings
UN_RADARR_0_URL=http://radarr:7878
UN_RADARR_0_API_KEY=0123456789abcdef0123456789abcdef
UN_RADARR_0_PATHS_0=/downloads
UN_RADARR_0_PROTOCOLS=torrent
UN_RADARR_0_TIMEOUT=10s
UN_RADARR_0_DELETE_DELAY=5m
UN_RADARR_0_DELETE_ORIG=false
UN_RADARR_0_SYNCTHING=false

Config Name	Variable Name	Default / Note
url	`UN_RADARR_0_URL`	No Default / URL where this starr app can be accessed.
api_key	`UN_RADARR_0_API_KEY`	No Default / Provide URL and API key if you use this app.
paths	`UN_RADARR_0_PATHS_0`	`["/downloads"]` / File system path where downloaded items are located.
protocols	`UN_RADARR_0_PROTOCOLS`	`"torrent"` / Protocols to process. Alt: `torrent,usenet`
timeout	`UN_RADARR_0_TIMEOUT`	`"10s"` / How long to wait for the app to respond.
delete_delay	`UN_RADARR_0_DELETE_DELAY`	`"5m"` / Extracts are deleted this long after import, `-1s` to disable.
delete_orig	`UN_RADARR_0_DELETE_ORIG`	`false` / Delete archives after import? Recommend keeping this false.
syncthing	`UN_RADARR_0_SYNCTHING`	`false` / Setting this to true makes unpackerr wait for syncthing to finish.

Lidarr Settings

Examples. Prefix: UN_LIDARR_, Header: [[lidarr]]

Using the config file:

[[lidarr]]
 url = "http://127.0.0.1:8686"
 api_key = "0123456789abcdef0123456789abcdef"
## List of paths where content is downloaded for this app.
## Used as fallback if the path the Starr app reports does not exist or is not accessible.
 paths = ['/downloads']
## Default protocols is torrent. Alternative: "torrent,usenet"
 protocols = "torrent"
## How long to wait for a reply from the backend.
 timeout = "10s"
## How long to wait after import before deleting the extracted items.
 delete_delay = "5m"
## If you use this app with NZB you may wish to delete archives after extraction.
## General recommendation is: do not enable this for torrent use.
## Setting this to true deletes the entire original download folder after import.
 delete_orig = false
## If you use Syncthing, setting this to true will make unpackerr wait for syncs to finish.
 syncthing = false

Using environment variables:

## Lidarr Settings
UN_LIDARR_0_URL=http://lidarr:8686
UN_LIDARR_0_API_KEY=0123456789abcdef0123456789abcdef
UN_LIDARR_0_PATHS_0=/downloads
UN_LIDARR_0_PROTOCOLS=torrent
UN_LIDARR_0_TIMEOUT=10s
UN_LIDARR_0_DELETE_DELAY=5m
UN_LIDARR_0_DELETE_ORIG=false
UN_LIDARR_0_SYNCTHING=false

Config Name	Variable Name	Default / Note
url	`UN_LIDARR_0_URL`	No Default / URL where this starr app can be accessed.
api_key	`UN_LIDARR_0_API_KEY`	No Default / Provide URL and API key if you use this app.
paths	`UN_LIDARR_0_PATHS_0`	`["/downloads"]` / File system path where downloaded items are located.
protocols	`UN_LIDARR_0_PROTOCOLS`	`"torrent"` / Protocols to process. Alt: `torrent,usenet`
timeout	`UN_LIDARR_0_TIMEOUT`	`"10s"` / How long to wait for the app to respond.
delete_delay	`UN_LIDARR_0_DELETE_DELAY`	`"5m"` / Extracts are deleted this long after import, `-1s` to disable.
delete_orig	`UN_LIDARR_0_DELETE_ORIG`	`false` / Delete archives after import? Recommend keeping this false.
syncthing	`UN_LIDARR_0_SYNCTHING`	`false` / Setting this to true makes unpackerr wait for syncthing to finish.

Readarr Settings

Examples. Prefix: UN_READARR_, Header: [[readarr]]

Using the config file:

[[readarr]]
 url = "http://127.0.0.1:8787"
 api_key = "0123456789abcdef0123456789abcdef"
## List of paths where content is downloaded for this app.
## Used as fallback if the path the Starr app reports does not exist or is not accessible.
 paths = ['/downloads']
## Default protocols is torrent. Alternative: "torrent,usenet"
 protocols = "torrent"
## How long to wait for a reply from the backend.
 timeout = "10s"
## How long to wait after import before deleting the extracted items.
 delete_delay = "5m"
## If you use this app with NZB you may wish to delete archives after extraction.
## General recommendation is: do not enable this for torrent use.
## Setting this to true deletes the entire original download folder after import.
 delete_orig = false
## If you use Syncthing, setting this to true will make unpackerr wait for syncs to finish.
 syncthing = false

Using environment variables:

## Readarr Settings
UN_READARR_0_URL=http://readarr:8787
UN_READARR_0_API_KEY=0123456789abcdef0123456789abcdef
UN_READARR_0_PATHS_0=/downloads
UN_READARR_0_PROTOCOLS=torrent
UN_READARR_0_TIMEOUT=10s
UN_READARR_0_DELETE_DELAY=5m
UN_READARR_0_DELETE_ORIG=false
UN_READARR_0_SYNCTHING=false

Config Name	Variable Name	Default / Note
url	`UN_READARR_0_URL`	No Default / URL where this starr app can be accessed.
api_key	`UN_READARR_0_API_KEY`	No Default / Provide URL and API key if you use this app.
paths	`UN_READARR_0_PATHS_0`	`["/downloads"]` / File system path where downloaded items are located.
protocols	`UN_READARR_0_PROTOCOLS`	`"torrent"` / Protocols to process. Alt: `torrent,usenet`
timeout	`UN_READARR_0_TIMEOUT`	`"10s"` / How long to wait for the app to respond.
delete_delay	`UN_READARR_0_DELETE_DELAY`	`"5m"` / Extracts are deleted this long after import, `-1s` to disable.
delete_orig	`UN_READARR_0_DELETE_ORIG`	`false` / Delete archives after import? Recommend keeping this false.
syncthing	`UN_READARR_0_SYNCTHING`	`false` / Setting this to true makes unpackerr wait for syncthing to finish.

Whisparr Settings

Examples. Prefix: UN_WHISPARR_, Header: [[whisparr]]

Using the config file:

[[whisparr]]
 url = "http://127.0.0.1:6969"
 api_key = "0123456789abcdef0123456789abcdef"
## List of paths where content is downloaded for this app.
## Used as fallback if the path the Starr app reports does not exist or is not accessible.
 paths = ['/downloads']
## Default protocols is torrent. Alternative: "torrent,usenet"
 protocols = "torrent"
## How long to wait for a reply from the backend.
 timeout = "10s"
## How long to wait after import before deleting the extracted items.
 delete_delay = "5m"
## If you use this app with NZB you may wish to delete archives after extraction.
## General recommendation is: do not enable this for torrent use.
## Setting this to true deletes the entire original download folder after import.
 delete_orig = false
## If you use Syncthing, setting this to true will make unpackerr wait for syncs to finish.
 syncthing = false

Using environment variables:

## Whisparr Settings
UN_WHISPARR_0_URL=http://whisparr:6969
UN_WHISPARR_0_API_KEY=0123456789abcdef0123456789abcdef
UN_WHISPARR_0_PATHS_0=/downloads
UN_WHISPARR_0_PROTOCOLS=torrent
UN_WHISPARR_0_TIMEOUT=10s
UN_WHISPARR_0_DELETE_DELAY=5m
UN_WHISPARR_0_DELETE_ORIG=false
UN_WHISPARR_0_SYNCTHING=false

Config Name	Variable Name	Default / Note
url	`UN_WHISPARR_0_URL`	No Default / URL where this starr app can be accessed.
api_key	`UN_WHISPARR_0_API_KEY`	No Default / Provide URL and API key if you use this app.
paths	`UN_WHISPARR_0_PATHS_0`	`["/downloads"]` / File system path where downloaded items are located.
protocols	`UN_WHISPARR_0_PROTOCOLS`	`"torrent"` / Protocols to process. Alt: `torrent,usenet`
timeout	`UN_WHISPARR_0_TIMEOUT`	`"10s"` / How long to wait for the app to respond.
delete_delay	`UN_WHISPARR_0_DELETE_DELAY`	`"5m"` / Extracts are deleted this long after import, `-1s` to disable.
delete_orig	`UN_WHISPARR_0_DELETE_ORIG`	`false` / Delete archives after import? Recommend keeping this false.
syncthing	`UN_WHISPARR_0_SYNCTHING`	`false` / Setting this to true makes unpackerr wait for syncthing to finish.

Watch Folders

Examples. Prefix: UN_FOLDER_, Header: [[folder]]

Using the config file:

##################################################################################
### ###  STOP HERE ### STOP HERE ### STOP HERE ### STOP HERE #### STOP HERE  ### #
### Only using Starr apps? The things above. The below configs are OPTIONAL. ### #
##################################################################################


##-Folders-#######################################################################
## This application can also watch folders for things to extract. If you copy a ##
## subfolder into a watched folder (defined below) any extractable items in the ##
## folder will be decompressed. This has nothing to do with Starr applications. ##
##################################################################################
[[folder]]
 path = '/downloads/auto_extract'
## Path to extract files to. The default (leaving this blank) is the same as `path` (above).
 extract_path = ''
## Delete extracted or original files this long after extraction.
## The default is 0. Set to 0 to disable all deletes. Uncomment it to enable deletes. Uses Go Duration.
 delete_after = "10m"
## Unpackerr extracts archives inside archives. Set this to true to disable recursive extractions.
 disable_recursion = false
## Delete extracted files after successful extraction? delete_after must be greater than 0.
 delete_files = false
## Delete original items after successful extraction? delete_after must be greater than 0.
 delete_original = false
## Disable extraction log (unpackerred.txt) file creation?
 disable_log = false
## Move extracted files into original folder? If false, files go into an _unpackerred folder.
 move_back = false
## Set this to true if you want this app to extract ISO files with .iso extension.
 extract_isos = false

Using environment variables:

## Watch Folders
UN_FOLDER_0_PATH=/downloads/auto_extract
UN_FOLDER_0_EXTRACT_PATH=
UN_FOLDER_0_DELETE_AFTER=10m
UN_FOLDER_0_DISABLE_RECURSION=false
UN_FOLDER_0_DELETE_FILES=false
UN_FOLDER_0_DELETE_ORIGINAL=false
UN_FOLDER_0_DISABLE_LOG=false
UN_FOLDER_0_MOVE_BACK=false
UN_FOLDER_0_EXTRACT_ISOS=false

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 Starr app.

Config Name	Variable Name	Default / Note
path	`UN_FOLDER_0_PATH`	No Default / Folder to watch for archives. Not for Starr apps.
extract_path	`UN_FOLDER_0_EXTRACT_PATH`	No Default / Where to extract to. Uses `path` if not set.
delete_after	`UN_FOLDER_0_DELETE_AFTER`	`"10m"` / Delete requested files after this duration; `0` disables.
disable_recursion	`UN_FOLDER_0_DISABLE_RECURSION`	`false` / Setting this to true disables extracting archives inside archives.
delete_files	`UN_FOLDER_0_DELETE_FILES`	`false` / Delete extracted files after successful extraction.
delete_original	`UN_FOLDER_0_DELETE_ORIGINAL`	`false` / Delete archives after successful extraction.
disable_log	`UN_FOLDER_0_DISABLE_LOG`	`false` / Turns off creation of extraction logs files for this folder.
move_back	`UN_FOLDER_0_MOVE_BACK`	`false` / Move extracted items back into original folder.
extract_isos	`UN_FOLDER_0_EXTRACT_ISOS`	`false` / Setting this to true enables .iso file extraction.

Web Hooks

Examples. Prefix: UN_WEBHOOK_, Header: [[webhook]]

Using the config file:

################
### Webhooks ###
################
# Sends a webhook when an extraction queues, starts, finishes, and/or is deleted.
# Created to integrate with notifiarr.com.
# Also works natively with Discord.com, Telegram.org, and Slack.com webhooks.
# Can possibly be used with other services by providing a custom template_path.
###### Don't forget to uncomment [[webhook]] and url at a minimum !!!!
[[webhook]]
 url = "https://notifiarr.com/api/v1/notification/unpackerr/api_key_from_notifiarr_com"
## Provide an optional name to hide the URL in logs.
## If a name is not provided then the URL is used.
 name = ""
## Do not log success (less log spam).
 silent = false
## List of event ids to send notification for, [0] for all.
## The default is [0] and this is an example:
 events = [1, 4, 6]
## ===> Advanced Optional Webhook Configuration <===
## Used in Discord and Slack templates as bot name, in Telegram as chat_id.
 nickname = "Unpackerr"
## Also passed into templates. Used in Slack templates for destination channel.
 channel = ""
## List of apps to exclude. None by default. This is an example:
 exclude = ["readarr", "lidarr"]
## Override internal webhook template for discord.com or other hooks.
 template_path = ''
## Override automatic template detection. Values: notifiarr, discord, telegram, gotify, pushover, slack
 template = ""
## Set this to true to ignore the SSL certificate on the server.
 ignore_ssl = false
## You can adjust how long to wait for a server response.
 timeout = "10s"
## If your custom template uses another MIME type, set this.
 content_type = "application/json"

Using environment variables:

## Web Hooks
UN_WEBHOOK_0_URL=https://notifiarr.com/api/v1/notification/unpackerr/api_key_from_notifiarr_com
UN_WEBHOOK_0_NAME=
UN_WEBHOOK_0_SILENT=false
UN_WEBHOOK_0_EVENTS_0=1
UN_WEBHOOK_0_EVENTS_1=4
UN_WEBHOOK_0_EVENTS_2=6
UN_WEBHOOK_0_NICKNAME=Unpackerr
UN_WEBHOOK_0_CHANNEL=
UN_WEBHOOK_0_EXCLUDE_0=readarr
UN_WEBHOOK_0_EXCLUDE_1=lidarr
UN_WEBHOOK_0_TEMPLATE_PATH=
UN_WEBHOOK_0_TEMPLATE=
UN_WEBHOOK_0_IGNORE_SSL=false
UN_WEBHOOK_0_TIMEOUT=10s
UN_WEBHOOK_0_CONTENT_TYPE=application/json

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.

Config Name	Variable Name	Default / Note
url	`UN_WEBHOOK_0_URL`	No Default / URL to send POST webhook to.
name	`UN_WEBHOOK_0_NAME`	No Default / Provide an optional name to hide the URL in logs.
silent	`UN_WEBHOOK_0_SILENT`	`false` / Hide successful POSTs from logs.
events	`UN_WEBHOOK_0_EVENTS_0`	`[0]` / List of event ids to send notification for, `0` for all.
nickname	`UN_WEBHOOK_0_NICKNAME`	`"Unpackerr"` / Passed into templates for telegram, discord and slack hooks.
channel	`UN_WEBHOOK_0_CHANNEL`	No Default / Passed into templates for slack.com webhooks.
exclude	`UN_WEBHOOK_0_EXCLUDE_0`	`[]` / List of apps to exclude: radarr, sonarr, folders, etc.
template_path	`UN_WEBHOOK_0_TEMPLATE_PATH`	No Default / Instead of an internal template, provide your own.
template	`UN_WEBHOOK_0_TEMPLATE`	No Default / Instead of auto template selection, force a built-in template.
ignore_ssl	`UN_WEBHOOK_0_IGNORE_SSL`	`false` / Ignore invalid SSL certificates.
timeout	`UN_WEBHOOK_0_TIMEOUT`	`"10s"` / How long to wait for server response.
content_type	`UN_WEBHOOK_0_CONTENT_TYPE`	`"application/json"` / Content-Type header sent to webhook.

Notes for Web Hooks

Nickname should equal the chat_id value in Telegram webhooks.
Channel is used as destination channel for Slack. It's not used in others.
Nickname and Channel may be used as custom values in custom templates.
Name is only used in logs, but it's also available as a template value as {{name}}.
Built-In Templates: pushover, telegram, discord, notifiarr, slack, gotify.

Command Hooks

Examples. Prefix: UN_CMDHOOK_, Header: [[cmdhook]]

Using the config file:

#####################
### Command Hooks ###
#####################
# Executes a script or command when an extraction queues, starts, finishes, and/or is deleted.
# All data is passed in as environment variables. Try /usr/bin/env to see what variables are available.
###### Don't forget to uncomment [[cmdhook]] at a minimum !!!!
[[cmdhook]]
 command = '/downloads/scripts/command.sh'
## Provide an optional name to hide the URL in logs.
## If a name is not provided the first word in the command is used.
 name = ""
## Runs the command inside /bin/sh ('nix) or cmd.exe (Windows).
 shell = false
## Do not log command's output.
 silent = false
## List of event ids to run command for, [0] for all.
## The default is [0] and this is an example:
 events = [1, 4, 7]
## ===> Optional Command Hook Configuration <===
## List of apps to exclude. None by default. This is an example:
 exclude = ["readarr", "lidarr"]
## You can adjust how long to wait for the command to run.
 timeout = "10s"

Using environment variables:

## Command Hooks
UN_CMDHOOK_0_COMMAND=/downloads/scripts/command.sh
UN_CMDHOOK_0_NAME=
UN_CMDHOOK_0_SHELL=false
UN_CMDHOOK_0_SILENT=false
UN_CMDHOOK_0_EVENTS_0=1
UN_CMDHOOK_0_EVENTS_1=4
UN_CMDHOOK_0_EVENTS_2=7
UN_CMDHOOK_0_EXCLUDE_0=readarr
UN_CMDHOOK_0_EXCLUDE_1=lidarr
UN_CMDHOOK_0_TIMEOUT=10s

Unpackerr can execute commands (or scripts) before and after an archive extraction. The only thing required is a command. Name is optional, and used in logs only. Setting shell to true executes your command after /bin/sh -c or cmd.exe /c on Windows.

Config Name	Variable Name	Default / Note
command	`UN_CMDHOOK_0_COMMAND`	No Default / Command to run.
name	`UN_CMDHOOK_0_NAME`	No Default / Name for logs, otherwise uses first word in command.
shell	`UN_CMDHOOK_0_SHELL`	`false` / Run command inside a shell.
silent	`UN_CMDHOOK_0_SILENT`	`false` / Hide command output from logs.
events	`UN_CMDHOOK_0_EVENTS_0`	`[0]` / List of event ids to run command for, `0` for all.
exclude	`UN_CMDHOOK_0_EXCLUDE_0`	`[]` / List of apps to exclude: radarr, sonarr, folders, etc.
timeout	`UN_CMDHOOK_0_TIMEOUT`	`"10s"` / How long to wait for the command to run.

All extraction data is input to the command using environment variables, see example below. Extracted files variables names begin with UN_DATA_FILES_. Try /usr/bin/env as an example command to see what variables are available.

Example Output Variables

UN_DATA_OUTPUT=folder/subfolder_unpackerred
UN_PATH=folder/subfolder
UN_DATA_START=2021-10-04T23:04:27.849216-07:00
UN_REVISION=
UN_EVENT=extracted
UN_GO=go1.17
UN_DATA_ARCHIVES=folder/subfolder_unpackerred/Funjetting.rar,folder/subfolder_unpackerred/Funjetting.r00,folder/subfolder/files.zip
UN_DATA_ARCHIVE_2=folder/subfolder/files.zip
UN_DATA_ARCHIVE_1=folder/subfolder_unpackerred/Funjetting.r00
UN_DATA_ARCHIVE_0=folder/subfolder_unpackerred/Funjetting.rar
UN_DATA_FILES=folder/subfolder/Funjetting.mp3,folder/subfolder/Funjetting.r00,folder/subfolder/Funjetting.rar,folder/subfolder/_unpackerred.subfolder.txt
UN_DATA_FILE_1=folder/subfolder/Funjetting.r00
UN_DATA_BYTES=2407624
PWD=/Users/david/go/src/github.com/Unpackerr/unpackerr
UN_DATA_FILE_0=folder/subfolder/Funjetting.mp3
UN_OS=darwin
UN_DATA_FILE_3=folder/subfolder/_unpackerred.subfolder.txt
UN_DATA_FILE_2=folder/subfolder/Funjetting.rar
UN_BRANCH=
UN_TIME=2021-10-04T23:04:27.869613-07:00
UN_VERSION=
UN_DATA_QUEUE=0
SHLVL=1
UN_APP=Folder
UN_STARTED=2021-10-04T23:03:22.849253-07:00
UN_ARCH=amd64
UN_DATA_ELAPSED=20.365752ms
UN_DATA_ERROR=

Web Server​

Folder Settings​

Sonarr Settings​

Radarr Settings​

Lidarr Settings​

Readarr Settings​

Whisparr Settings​

Watch Folders​

Web Hooks​

Notes for Web Hooks​

Command Hooks​