Unpackerr¶

Overview¶

Unpackerr is a lightweight, cross-platform application designed to automatically extract compressed files (like RAR, ZIP, 7Z, TAR, and ISO) from download folders, primarily for use with media management tools such as Radarr, Sonarr, Lidarr.

Manual

Releases

Community

Deployment¶

sb install unpackerr

Basics¶

Documentation

The important part of the setup is the setup for the applications. You'll need to change these three settings for each:

[[sonarr]]
  url = "http://sonarr:8989"
  api_key = "YOUR_API_KEY"
# File system path where downloaded Sonarr items are located.
  paths = ['/mnt/unionfs/downloads/torrents/qbittorrent/completed']

The path will depend on the torrent client you are using and its configuration.

Same setup is required for radarr and lidarr if you are using them.

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
unpackerr_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like unpackerr_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

Instead, use the corresponding _custom variable (like unpackerr_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsDockerDocker+Global Override Options

unpackerr_name

# Type: string
unpackerr_name: unpackerr

Container

unpackerr_role_docker_container

# Type: string
unpackerr_role_docker_container: "{{ unpackerr_name }}"

Image

unpackerr_role_docker_image_pull

# Type: bool (true/false)
unpackerr_role_docker_image_pull: true

unpackerr_role_docker_image_repo

# Type: string
unpackerr_role_docker_image_repo: "ghcr.io/hotio/unpackerr"

unpackerr_role_docker_image_tag

# Type: string
unpackerr_role_docker_image_tag: "latest"

unpackerr_role_docker_image

# Type: string
unpackerr_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='unpackerr') }}:{{ lookup('role_var', '_docker_image_tag', role='unpackerr') }}"

Envs

unpackerr_role_docker_envs_default

# Type: dict
unpackerr_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"
  UMASK: "002"

unpackerr_role_docker_envs_custom

# Type: dict
unpackerr_role_docker_envs_custom: {}

Volumes

unpackerr_role_docker_volumes_default

# Type: list
unpackerr_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='unpackerr') }}:/config"

unpackerr_role_docker_volumes_custom

# Type: list
unpackerr_role_docker_volumes_custom: []

Hostname

unpackerr_role_docker_hostname

# Type: string
unpackerr_role_docker_hostname: "{{ unpackerr_name }}"

Networks

unpackerr_role_docker_networks_alias

# Type: string
unpackerr_role_docker_networks_alias: "{{ unpackerr_name }}"

unpackerr_role_docker_networks_default

# Type: list
unpackerr_role_docker_networks_default: []

unpackerr_role_docker_networks_custom

# Type: list
unpackerr_role_docker_networks_custom: []

Restart Policy

unpackerr_role_docker_restart_policy

# Type: string
unpackerr_role_docker_restart_policy: unless-stopped

State

unpackerr_role_docker_state

# Type: string
unpackerr_role_docker_state: started

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

unpackerr_role_docker_blkio_weight

# Type: int
unpackerr_role_docker_blkio_weight:

unpackerr_role_docker_cpu_period

# Type: int
unpackerr_role_docker_cpu_period:

unpackerr_role_docker_cpu_quota

# Type: int
unpackerr_role_docker_cpu_quota:

unpackerr_role_docker_cpu_shares

# Type: int
unpackerr_role_docker_cpu_shares:

unpackerr_role_docker_cpus

# Type: string
unpackerr_role_docker_cpus:

unpackerr_role_docker_cpuset_cpus

# Type: string
unpackerr_role_docker_cpuset_cpus:

unpackerr_role_docker_cpuset_mems

# Type: string
unpackerr_role_docker_cpuset_mems:

unpackerr_role_docker_kernel_memory

# Type: string
unpackerr_role_docker_kernel_memory:

unpackerr_role_docker_memory

# Type: string
unpackerr_role_docker_memory:

unpackerr_role_docker_memory_reservation

# Type: string
unpackerr_role_docker_memory_reservation:

unpackerr_role_docker_memory_swap

# Type: string
unpackerr_role_docker_memory_swap:

unpackerr_role_docker_memory_swappiness

# Type: int
unpackerr_role_docker_memory_swappiness:

unpackerr_role_docker_shm_size

# Type: string
unpackerr_role_docker_shm_size:

Security & Devices

unpackerr_role_docker_cap_drop

# Type: list
unpackerr_role_docker_cap_drop:

unpackerr_role_docker_cgroupns_mode

# Type: string
unpackerr_role_docker_cgroupns_mode:

unpackerr_role_docker_device_cgroup_rules

# Type: list
unpackerr_role_docker_device_cgroup_rules:

unpackerr_role_docker_device_read_bps

# Type: list
unpackerr_role_docker_device_read_bps:

unpackerr_role_docker_device_read_iops

# Type: list
unpackerr_role_docker_device_read_iops:

unpackerr_role_docker_device_requests

# Type: list
unpackerr_role_docker_device_requests:

unpackerr_role_docker_device_write_bps

# Type: list
unpackerr_role_docker_device_write_bps:

unpackerr_role_docker_device_write_iops

# Type: list
unpackerr_role_docker_device_write_iops:

unpackerr_role_docker_devices

# Type: list
unpackerr_role_docker_devices:

unpackerr_role_docker_devices_default

# Type: string
unpackerr_role_docker_devices_default:

unpackerr_role_docker_groups

# Type: list
unpackerr_role_docker_groups:

unpackerr_role_docker_privileged

# Type: bool (true/false)
unpackerr_role_docker_privileged:

unpackerr_role_docker_security_opts

# Type: list
unpackerr_role_docker_security_opts:

unpackerr_role_docker_user

# Type: string
unpackerr_role_docker_user:

unpackerr_role_docker_userns_mode

# Type: string
unpackerr_role_docker_userns_mode:

Networking

unpackerr_role_docker_dns_opts

# Type: list
unpackerr_role_docker_dns_opts:

unpackerr_role_docker_dns_search_domains

# Type: list
unpackerr_role_docker_dns_search_domains:

unpackerr_role_docker_dns_servers

# Type: list
unpackerr_role_docker_dns_servers:

unpackerr_role_docker_domainname

# Type: string
unpackerr_role_docker_domainname:

unpackerr_role_docker_exposed_ports

# Type: list
unpackerr_role_docker_exposed_ports:

unpackerr_role_docker_hosts

# Type: dict
unpackerr_role_docker_hosts:

unpackerr_role_docker_hosts_use_common

# Type: bool (true/false)
unpackerr_role_docker_hosts_use_common:

unpackerr_role_docker_ipc_mode

# Type: string
unpackerr_role_docker_ipc_mode:

unpackerr_role_docker_links

# Type: list
unpackerr_role_docker_links:

unpackerr_role_docker_network_mode

# Type: string
unpackerr_role_docker_network_mode:

unpackerr_role_docker_pid_mode

# Type: string
unpackerr_role_docker_pid_mode:

unpackerr_role_docker_ports

# Type: list
unpackerr_role_docker_ports:

unpackerr_role_docker_uts

# Type: string
unpackerr_role_docker_uts:

Storage

unpackerr_role_docker_keep_volumes

# Type: bool (true/false)
unpackerr_role_docker_keep_volumes:

unpackerr_role_docker_mounts

# Type: list
unpackerr_role_docker_mounts:

unpackerr_role_docker_storage_opts

# Type: dict
unpackerr_role_docker_storage_opts:

unpackerr_role_docker_tmpfs

# Type: list
unpackerr_role_docker_tmpfs:

unpackerr_role_docker_volume_driver

# Type: string
unpackerr_role_docker_volume_driver:

unpackerr_role_docker_volumes_from

# Type: list
unpackerr_role_docker_volumes_from:

unpackerr_role_docker_volumes_global

# Type: bool (true/false)
unpackerr_role_docker_volumes_global:

unpackerr_role_docker_working_dir

# Type: string
unpackerr_role_docker_working_dir:

Monitoring & Lifecycle

unpackerr_role_docker_auto_remove

# Type: bool (true/false)
unpackerr_role_docker_auto_remove:

unpackerr_role_docker_cleanup

# Type: bool (true/false)
unpackerr_role_docker_cleanup:

unpackerr_role_docker_force_kill

# Type: string
unpackerr_role_docker_force_kill:

unpackerr_role_docker_healthcheck

# Type: dict
unpackerr_role_docker_healthcheck:

unpackerr_role_docker_healthy_wait_timeout

# Type: int
unpackerr_role_docker_healthy_wait_timeout:

unpackerr_role_docker_init

# Type: bool (true/false)
unpackerr_role_docker_init:

unpackerr_role_docker_kill_signal

# Type: string
unpackerr_role_docker_kill_signal:

unpackerr_role_docker_log_driver

# Type: string
unpackerr_role_docker_log_driver:

unpackerr_role_docker_log_options

# Type: dict
unpackerr_role_docker_log_options:

unpackerr_role_docker_oom_killer

# Type: bool (true/false)
unpackerr_role_docker_oom_killer:

unpackerr_role_docker_oom_score_adj

# Type: int
unpackerr_role_docker_oom_score_adj:

unpackerr_role_docker_output_logs

# Type: bool (true/false)
unpackerr_role_docker_output_logs:

unpackerr_role_docker_paused

# Type: bool (true/false)
unpackerr_role_docker_paused:

unpackerr_role_docker_recreate

# Type: bool (true/false)
unpackerr_role_docker_recreate:

unpackerr_role_docker_restart_retries

# Type: int
unpackerr_role_docker_restart_retries:

unpackerr_role_docker_stop_timeout

# Type: int
unpackerr_role_docker_stop_timeout:

Other Options

unpackerr_role_docker_capabilities

# Type: list
unpackerr_role_docker_capabilities:

unpackerr_role_docker_cgroup_parent

# Type: string
unpackerr_role_docker_cgroup_parent:

unpackerr_role_docker_commands

# Type: list
unpackerr_role_docker_commands:

unpackerr_role_docker_create_timeout

# Type: int
unpackerr_role_docker_create_timeout:

unpackerr_role_docker_entrypoint

# Type: string
unpackerr_role_docker_entrypoint:

unpackerr_role_docker_env_file

# Type: string
unpackerr_role_docker_env_file:

unpackerr_role_docker_labels

# Type: dict
unpackerr_role_docker_labels:

unpackerr_role_docker_labels_use_common

# Type: bool (true/false)
unpackerr_role_docker_labels_use_common:

unpackerr_role_docker_read_only

# Type: bool (true/false)
unpackerr_role_docker_read_only:

unpackerr_role_docker_runtime

# Type: string
unpackerr_role_docker_runtime:

unpackerr_role_docker_sysctls

# Type: list
unpackerr_role_docker_sysctls:

unpackerr_role_docker_ulimits

# Type: list
unpackerr_role_docker_ulimits:

unpackerr_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
unpackerr_role_autoheal_enabled: true

unpackerr_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
unpackerr_role_depends_on: ""

unpackerr_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
unpackerr_role_depends_on_delay: "0"

unpackerr_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
unpackerr_role_depends_on_healthchecks:

unpackerr_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
unpackerr_role_diun_enabled: true

unpackerr_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
unpackerr_role_docker_controller: true

unpackerr_role_docker_image_repo

# Type: string
unpackerr_role_docker_image_repo:

unpackerr_role_docker_image_tag

# Type: string
unpackerr_role_docker_image_tag:

unpackerr_role_docker_volumes_download

# Type: bool (true/false)
unpackerr_role_docker_volumes_download:

unpackerr_role_paths_location

# Type: string
unpackerr_role_paths_location: