Recyclarr¶

Overview¶

Recyclarr is a command-line application designed to automatically synchronize recommended settings from the TRaSH Guides to Sonarr and Radarr instances.

Manual

Releases

Community

Configuration¶

Edit the Recyclarr section in Sandbox settings.yml and enter your desired update schedule using standard cron syntax.

     recyclarr:
       cron_schedule: "@daily"

Note

If you change this value, you must re-run sb install sandbox-recyclarr for it take effect.

If a config file does not exist, a default config is generated but it is not functional out of the box. Edit the file /opt/recyclarr/recyclarr.yml to provision your Sonarr/Radarr details and preferred settings.

Configure Sonarr section

    sonarr:
      sonarr:
        base_url: http://sonarr:8989
        api_key: your_sonarr_api_key

Configure Radarr section

    radarr:
      radarr:
        base_url: http://radarr:7878
        api_key: your_radarr_api_key

Follow documentation to complete configuration

Deployment¶

sb install sandbox-recyclarr

Role Defaults¶

Use the Inventory to customize variables. (1)

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

When overriding variables that end in _default (like recyclarr_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 recyclarr_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsSettingsDockerDocker+Global Override Options

recyclarr_name

# Type: string
recyclarr_name: recyclarr

recyclarr_role_cron_schedule

# Type: string
recyclarr_role_cron_schedule: "@daily"

Container

recyclarr_role_docker_container

# Type: string
recyclarr_role_docker_container: "{{ recyclarr_name }}"

Image

recyclarr_role_docker_image_pull

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

recyclarr_role_docker_image_repo

# Type: string
recyclarr_role_docker_image_repo: "ghcr.io/recyclarr/recyclarr"

recyclarr_role_docker_image_tag

# Type: string
recyclarr_role_docker_image_tag: "latest"

recyclarr_role_docker_image

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

Envs

recyclarr_role_docker_envs_default

# Type: dict
recyclarr_role_docker_envs_default:
  TZ: "{{ tz }}"
  CRON_SCHEDULE: "{{ lookup('role_var', '_cron_schedule', role='recyclarr') }}"
  RECYCLARR_CREATE_CONFIG: "true"

recyclarr_role_docker_envs_custom

# Type: dict
recyclarr_role_docker_envs_custom: {}

Volumes

recyclarr_role_docker_volumes_default

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

recyclarr_role_docker_volumes_custom

# Type: list
recyclarr_role_docker_volumes_custom: []

Hostname

recyclarr_role_docker_hostname

# Type: string
recyclarr_role_docker_hostname: "{{ recyclarr_name }}"

Networks

recyclarr_role_docker_networks_alias

# Type: string
recyclarr_role_docker_networks_alias: "{{ recyclarr_name }}"

recyclarr_role_docker_networks_default

# Type: list
recyclarr_role_docker_networks_default: []

recyclarr_role_docker_networks_custom

# Type: list
recyclarr_role_docker_networks_custom: []

Restart Policy

recyclarr_role_docker_restart_policy

# Type: string
recyclarr_role_docker_restart_policy: unless-stopped

State

recyclarr_role_docker_state

# Type: string
recyclarr_role_docker_state: started

User

recyclarr_role_docker_user

# Type: string
recyclarr_role_docker_user: "{{ uid }}:{{ gid }}"

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

Resource Limits

recyclarr_role_docker_blkio_weight

# Type: int
recyclarr_role_docker_blkio_weight:

recyclarr_role_docker_cpu_period

# Type: int
recyclarr_role_docker_cpu_period:

recyclarr_role_docker_cpu_quota

# Type: int
recyclarr_role_docker_cpu_quota:

recyclarr_role_docker_cpu_shares

# Type: int
recyclarr_role_docker_cpu_shares:

recyclarr_role_docker_cpus

# Type: string
recyclarr_role_docker_cpus:

recyclarr_role_docker_cpuset_cpus

# Type: string
recyclarr_role_docker_cpuset_cpus:

recyclarr_role_docker_cpuset_mems

# Type: string
recyclarr_role_docker_cpuset_mems:

recyclarr_role_docker_kernel_memory

# Type: string
recyclarr_role_docker_kernel_memory:

recyclarr_role_docker_memory

# Type: string
recyclarr_role_docker_memory:

recyclarr_role_docker_memory_reservation

# Type: string
recyclarr_role_docker_memory_reservation:

recyclarr_role_docker_memory_swap

# Type: string
recyclarr_role_docker_memory_swap:

recyclarr_role_docker_memory_swappiness

# Type: int
recyclarr_role_docker_memory_swappiness:

recyclarr_role_docker_shm_size

# Type: string
recyclarr_role_docker_shm_size:

Security & Devices

recyclarr_role_docker_cap_drop

# Type: list
recyclarr_role_docker_cap_drop:

recyclarr_role_docker_cgroupns_mode

# Type: string
recyclarr_role_docker_cgroupns_mode:

recyclarr_role_docker_device_cgroup_rules

# Type: list
recyclarr_role_docker_device_cgroup_rules:

recyclarr_role_docker_device_read_bps

# Type: list
recyclarr_role_docker_device_read_bps:

recyclarr_role_docker_device_read_iops

# Type: list
recyclarr_role_docker_device_read_iops:

recyclarr_role_docker_device_requests

# Type: list
recyclarr_role_docker_device_requests:

recyclarr_role_docker_device_write_bps

# Type: list
recyclarr_role_docker_device_write_bps:

recyclarr_role_docker_device_write_iops

# Type: list
recyclarr_role_docker_device_write_iops:

recyclarr_role_docker_devices

# Type: list
recyclarr_role_docker_devices:

recyclarr_role_docker_devices_default

# Type: string
recyclarr_role_docker_devices_default:

recyclarr_role_docker_groups

# Type: list
recyclarr_role_docker_groups:

recyclarr_role_docker_privileged

# Type: bool (true/false)
recyclarr_role_docker_privileged:

recyclarr_role_docker_security_opts

# Type: list
recyclarr_role_docker_security_opts:

recyclarr_role_docker_userns_mode

# Type: string
recyclarr_role_docker_userns_mode:

Networking

recyclarr_role_docker_dns_opts

# Type: list
recyclarr_role_docker_dns_opts:

recyclarr_role_docker_dns_search_domains

# Type: list
recyclarr_role_docker_dns_search_domains:

recyclarr_role_docker_dns_servers

# Type: list
recyclarr_role_docker_dns_servers:

recyclarr_role_docker_domainname

# Type: string
recyclarr_role_docker_domainname:

recyclarr_role_docker_exposed_ports

# Type: list
recyclarr_role_docker_exposed_ports:

recyclarr_role_docker_hosts

# Type: dict
recyclarr_role_docker_hosts:

recyclarr_role_docker_hosts_use_common

# Type: bool (true/false)
recyclarr_role_docker_hosts_use_common:

recyclarr_role_docker_ipc_mode

# Type: string
recyclarr_role_docker_ipc_mode:

recyclarr_role_docker_links

# Type: list
recyclarr_role_docker_links:

recyclarr_role_docker_network_mode

# Type: string
recyclarr_role_docker_network_mode:

recyclarr_role_docker_pid_mode

# Type: string
recyclarr_role_docker_pid_mode:

recyclarr_role_docker_ports

# Type: list
recyclarr_role_docker_ports:

recyclarr_role_docker_uts

# Type: string
recyclarr_role_docker_uts:

Storage

recyclarr_role_docker_keep_volumes

# Type: bool (true/false)
recyclarr_role_docker_keep_volumes:

recyclarr_role_docker_mounts

# Type: list
recyclarr_role_docker_mounts:

recyclarr_role_docker_storage_opts

# Type: dict
recyclarr_role_docker_storage_opts:

recyclarr_role_docker_tmpfs

# Type: list
recyclarr_role_docker_tmpfs:

recyclarr_role_docker_volume_driver

# Type: string
recyclarr_role_docker_volume_driver:

recyclarr_role_docker_volumes_from

# Type: list
recyclarr_role_docker_volumes_from:

recyclarr_role_docker_volumes_global

# Type: bool (true/false)
recyclarr_role_docker_volumes_global:

recyclarr_role_docker_working_dir

# Type: string
recyclarr_role_docker_working_dir:

Monitoring & Lifecycle

recyclarr_role_docker_auto_remove

# Type: bool (true/false)
recyclarr_role_docker_auto_remove:

recyclarr_role_docker_cleanup

# Type: bool (true/false)
recyclarr_role_docker_cleanup:

recyclarr_role_docker_force_kill

# Type: string
recyclarr_role_docker_force_kill:

recyclarr_role_docker_healthcheck

# Type: dict
recyclarr_role_docker_healthcheck:

recyclarr_role_docker_healthy_wait_timeout

# Type: int
recyclarr_role_docker_healthy_wait_timeout:

recyclarr_role_docker_init

# Type: bool (true/false)
recyclarr_role_docker_init:

recyclarr_role_docker_kill_signal

# Type: string
recyclarr_role_docker_kill_signal:

recyclarr_role_docker_log_driver

# Type: string
recyclarr_role_docker_log_driver:

recyclarr_role_docker_log_options

# Type: dict
recyclarr_role_docker_log_options:

recyclarr_role_docker_oom_killer

# Type: bool (true/false)
recyclarr_role_docker_oom_killer:

recyclarr_role_docker_oom_score_adj

# Type: int
recyclarr_role_docker_oom_score_adj:

recyclarr_role_docker_output_logs

# Type: bool (true/false)
recyclarr_role_docker_output_logs:

recyclarr_role_docker_paused

# Type: bool (true/false)
recyclarr_role_docker_paused:

recyclarr_role_docker_recreate

# Type: bool (true/false)
recyclarr_role_docker_recreate:

recyclarr_role_docker_restart_retries

# Type: int
recyclarr_role_docker_restart_retries:

recyclarr_role_docker_stop_timeout

# Type: int
recyclarr_role_docker_stop_timeout:

Other Options

recyclarr_role_docker_capabilities

# Type: list
recyclarr_role_docker_capabilities:

recyclarr_role_docker_cgroup_parent

# Type: string
recyclarr_role_docker_cgroup_parent:

recyclarr_role_docker_commands

# Type: list
recyclarr_role_docker_commands:

recyclarr_role_docker_create_timeout

# Type: int
recyclarr_role_docker_create_timeout:

recyclarr_role_docker_entrypoint

# Type: string
recyclarr_role_docker_entrypoint:

recyclarr_role_docker_env_file

# Type: string
recyclarr_role_docker_env_file:

recyclarr_role_docker_labels

# Type: dict
recyclarr_role_docker_labels:

recyclarr_role_docker_labels_use_common

# Type: bool (true/false)
recyclarr_role_docker_labels_use_common:

recyclarr_role_docker_read_only

# Type: bool (true/false)
recyclarr_role_docker_read_only:

recyclarr_role_docker_runtime

# Type: string
recyclarr_role_docker_runtime:

recyclarr_role_docker_sysctls

# Type: list
recyclarr_role_docker_sysctls:

recyclarr_role_docker_ulimits

# Type: list
recyclarr_role_docker_ulimits:

recyclarr_role_autoheal_enabled

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

recyclarr_role_cron_schedule

# Type: string
recyclarr_role_cron_schedule:

recyclarr_role_depends_on

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

recyclarr_role_depends_on_delay

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

recyclarr_role_depends_on_healthchecks

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

recyclarr_role_diun_enabled

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

recyclarr_role_docker_controller

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

recyclarr_role_docker_image_repo

# Type: string
recyclarr_role_docker_image_repo:

recyclarr_role_docker_image_tag

# Type: string
recyclarr_role_docker_image_tag:

recyclarr_role_docker_volumes_download

# Type: bool (true/false)
recyclarr_role_docker_volumes_download:

recyclarr_role_paths_location

# Type: string
recyclarr_role_paths_location: