Unpackerr
Unpackerr
WARNING: This does not save anything, if you close the window (or refresh) all changes are gone & you will need to start over!
What would you like to generate:
Generated conf file

When you are done you can click Generate to build the conf then copy and paste the contents to your unpackerr.conf & restart unpackerr

Note: If you use multiple instances of a starr app, just copy its section and adjust the url/api_key fields. The same concept applies to the folder watcher section for multiple folders.

Generated docker-compose file
Note: If you use multiple instances of a starr app, just copy its section and adjust the url/api_key fields AND increment the _SONARR_0_ for example.


General configuration
Enabled
Setting
Value
Description
debug
Turn on debug messages in the output.
quiet
Disable writing messages to stdout/stderr. This silences the app.
error_stderr
Send error output to stderr instead of stdout by setting error_stderr to true.
activity
Setting activity to true will silence all app queue log lines with only zeros.
interval
How often to poll sonarr and radarr.
start_delay
How long an item must be queued (download complete) before extraction will start.
retry_delay
How long to wait before removing the history for a failed extraction.
max_retries
How many times to retry a failed extraction. Pauses retry_delay between attempts.
parallel
How many files may be extracted in parallel. 1 works fine.
file_mode
What mode to create files with
dir_mode
What mode to create directories with
log_file
Log file path
log_queues
The Starr-application activity queue is logged on an interval.
log_file_mb
How large to make each log file
log_files
How many log files to keep
Starr Configuration
Lidarr
Enabled
Setting
Value
Description
Whether or not you need to monitor lidarr for packed files
url
What is the address of the app on your system (open it in the browser and copy it)
api_key
What is the app apikey, Settings -> General (Feel free to leave this blank here and add it to your generated config later)
paths
File system paths where downloaded items are located, Example: /path/to/files,C:\path\to\files\
protocols
Default protocols is torrent. Alternative: torrent,usenet
timeout
How long to wait for a reply from the backend.
delete_delay
How long to wait after import before deleting the extracted items.
delete_orig
Setting this to true deletes the entire original download folder after import.
syncthing
If you use Syncthing, setting this to true will make unpackerr wait for syncs to finish.
Radarr
Enabled
Setting
Value
Description
Whether or not you need to monitor radarr for packed files
url
What is the address of the app on your system (open it in the browser and copy it)
api_key
What is the app apikey, Settings -> General (Feel free to leave this blank here and add it to your generated config later)
paths
File system paths where downloaded items are located, Example: /path/to/files,C:\path\to\files\
protocols
Default protocols is torrent. Alternative: torrent,usenet
timeout
How long to wait for a reply from the backend.
delete_delay
How long to wait after import before deleting the extracted items.
delete_orig
Setting this to true deletes the entire original download folder after import.
syncthing
If you use Syncthing, setting this to true will make unpackerr wait for syncs to finish.
Readarr
Enabled
Setting
Value
Description
Whether or not you need to monitor readarr for packed files
url
What is the address of the app on your system (open it in the browser and copy it)
api_key
What is the app apikey, Settings -> General (Feel free to leave this blank here and add it to your generated config later)
paths
File system paths where downloaded items are located, Example: /path/to/files,C:\path\to\files\
protocols
Default protocols is torrent. Alternative: torrent,usenet
timeout
How long to wait for a reply from the backend.
delete_delay
How long to wait after import before deleting the extracted items.
delete_orig
Setting this to true deletes the entire original download folder after import.
syncthing
If you use Syncthing, setting this to true will make unpackerr wait for syncs to finish.
Sonarr
Enabled
Setting
Value
Description
Whether or not you need to monitor sonarr for packed files
url
What is the address of the app on your system (open it in the browser and copy it)
api_key
What is the app apikey, Settings -> General (Feel free to leave this blank here and add it to your generated config later)
paths
File system paths where downloaded items are located, Example: /path/to/files,C:\path\to\files\
protocols
Default protocols is torrent. Alternative: torrent,usenet
timeout
How long to wait for a reply from the backend.
delete_delay
How long to wait after import before deleting the extracted items.
delete_orig
Setting this to true deletes the entire original download folder after import.
syncthing
If you use Syncthing, setting this to true will make unpackerr wait for syncs to finish.
Whisparr
Enabled
Setting
Value
Description
Whether or not you need to monitor whisparr for packed files
url
What is the address of the app on your system (open it in the browser and copy it)
api_key
What is the app apikey, Settings -> General (Feel free to leave this blank here and add it to your generated config later)
paths
File system paths where downloaded items are located, Example: /path/to/files,C:\path\to\files\
protocols
Default protocols is torrent. Alternative: torrent,usenet
timeout
How long to wait for a reply from the backend.
delete_delay
How long to wait after import before deleting the extracted items.
delete_orig
Setting this to true deletes the entire original download folder after import.
syncthing
If you use Syncthing, setting this to true will make unpackerr wait for syncs to finish.
Other Configuration
Webhook config
Enabled
Setting
Value
Description
Whether or not you are going to use a webhook
url
name
Set this to hide the URL in logs.
silent
do not log success (less log spam)
events
list of event ids to include, 0 == all. Example: 1,2,3,4
timeout
You can adjust how long to wait for a server response.
ignore_ssl
Set this to true to ignore the SSL certificate on the server.
exclude
list of apps to exclude, Example: radarr, lidarr
nickname
Used in Discord and Slack templates as bot name, in Telegram as chat_id.
channel
Also passed into templates. Used in Slack templates for destination channel.
template_path
Override internal webhook template for discord.com or other hooks.
template
Override automatic template detection. Values: notifiarr, discord, telegram, gotify, pushover, slack
content_type
If your custom template uses another MIME type, set this.
Folder config
Enabled
Setting
Value
Description
Whether or not you are going to use a folder
path
Path to extract files to.
extract_path
Path to extract files to. The default (leaving this blank) is the same as `path` (above).
delete_after
The default is 0. Set to 0 to disable all deletes. Uncomment it to enable deletes. Uses Go Duration.
disable_recursion
Unpackerr extracts archives inside archives. Set this to true to disable recursive extractions.
delete_files
Delete extracted files after successful extraction? true/false, no quotes. Honors delete_after.
delete_original
Delete original items after successful extraction? true/false, no quotes. Honors delete_after.
disable_log
Disable extraction log (unpackerred.txt) file creation? true/false, no quotes.
move_back
Move extracted files into original folder? If false, files go into an _unpackerred folder.
extract_isos
Set this to true if you want this app to extract ISO files with .iso extension.
interval
How often to poll for folder changes
Cmdhook config
Enabled
Setting
Value
Description
Whether or not you are going to use a cmdhook
command
Path to command or script.
shell
Runs the command inside /bin/sh ('nix) or cmd.exe (Windows).
name
Provide an optional name for logging.
silent
Hides command output from logs.
events
list of event ids to include, 0 == all. Example: 1,2,3
exclude
list of apps to exclude, Example: radarr, lidarr
timeout
You can adjust how long to wait for a server response.
Webserver config
Enabled
Setting
Value
Description
Whether or not you are going to use a webserver
metrics
The web server currently only supports metrics; set this to true if you wish to use it.
listen_addr
This may be set to a port or an ip:port to bind a specific IP. 0.0.0.0 binds ALL IPs.
log_file
Recommend setting a log file for HTTP requests. Otherwise, they go with other logs.
log_files
This app automatically rotates logs. Set these to the size of the files.
log_file_mb
This app automatically rotates logs. Set these to the number to keep.
ssl_cert_file
Set both of these to valid file paths to enable HTTPS/TLS.
ssl_key_file
urlbase
Base URL from which to serve content.
upstreams
Upstreams should be set to the IP or CIDR of your trusted upstream proxy. Example: 127.0.0.1/32,10.1.2.0/24
All services are online
© 2019-2024 Notifiarr
Privacy Policy, Terms of Use, Cookie Policy
Loading

I'm gathering everything needed to complete the request, give me just a moment...

 
Close
Display Mode
Dark Mode
Dark
Light Mode
Light
Theme Color
 
 
 
 
 
 
 
 
 
 
 
 
  • Privacy Policy
  • Terms of Service
  • Acceptable Use
  • Cookies