Tdarr

Description / name	Input element
Your domain name

Overview

Tdarr is a cross-platform conditional based transcoding application for automating media library transcode/remux management in order to process your media files as required. For example, you can set rules for the required codecs, containers, languages etc that your media should have which helps keeps things organized and can increase compatability with your devices. A common use for Tdarr is to simply convert video files from h264 to h265 (hevc), saving 40%-50% in size.

Manual

Releases

Community

---

Deployment

sb install sandbox-tdarr

Usage

Visit https://tdarr.iYOUR_DOMAIN_NAMEi.

Basics

Tdarr is configured with the following defaults which can be modified via the inventory system.

tdarr_server_port: "8266"
tdarr_server_external: false

By switching tdarr_server_external to true the Tdarr server will be accessible externally via the specified tdarr_server_port on any hostname or IP address pointing directly to the server.

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   tdarr_name: "custom_value"
   

   Avoid overriding variables ending in _default

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

BasicsSettingsWebDNSTraefikDockerDocker+Global Override Options

tdarr_name

# Type: string
tdarr_name: tdarr

tdarr_role_server_port

# Type: string
tdarr_role_server_port: "8266"

tdarr_role_server_external

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

tdarr_role_web_subdomain

# Type: string
tdarr_role_web_subdomain: "{{ tdarr_name }}"

tdarr_role_web_domain

# Type: string
tdarr_role_web_domain: "{{ user.domain }}"

tdarr_role_web_port

# Type: string
tdarr_role_web_port: "8265"

tdarr_role_web_url

# Type: string
tdarr_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='tdarr') + '.' + lookup('role_var', '_web_domain', role='tdarr')
                     if (lookup('role_var', '_web_subdomain', role='tdarr') | length > 0)
                     else lookup('role_var', '_web_domain', role='tdarr')) }}"

tdarr_role_dns_record

# Type: string
tdarr_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='tdarr') }}"

tdarr_role_dns_zone

# Type: string
tdarr_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='tdarr') }}"

tdarr_role_dns_proxy

# Type: bool (true/false)
tdarr_role_dns_proxy: "{{ dns_proxied }}"

tdarr_role_traefik_sso_middleware

# Type: string
tdarr_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

tdarr_role_traefik_middleware_default

# Type: string
tdarr_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

tdarr_role_traefik_middleware_custom

# Type: string
tdarr_role_traefik_middleware_custom: ""

tdarr_role_traefik_certresolver

# Type: string
tdarr_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

tdarr_role_traefik_enabled

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

tdarr_role_traefik_api_enabled

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

tdarr_role_traefik_api_endpoint

# Type: string
tdarr_role_traefik_api_endpoint: ""

Container

tdarr_role_docker_container

# Type: string
tdarr_role_docker_container: "{{ tdarr_name }}"

Image

tdarr_role_docker_image_pull

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

tdarr_role_docker_image_repo

# Type: string
tdarr_role_docker_image_repo: "haveagitgat/tdarr"

tdarr_role_docker_image_tag

# Type: string
tdarr_role_docker_image_tag: "latest"

tdarr_role_docker_image

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

Ports

tdarr_role_docker_ports_default

# Type: list
tdarr_role_docker_ports_default:
  - "{{ lookup('role_var', '_server_port', role='tdarr') }}:{{ lookup('role_var', '_server_port', role='tdarr') }}"

tdarr_role_docker_ports_custom

# Type: list
tdarr_role_docker_ports_custom: []

Envs

tdarr_role_docker_envs_default

# Type: dict
tdarr_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"
  serverIP: "0.0.0.0"
  webUIPort: "8265"
  serverPort: "{{ lookup('role_var', '_server_port', role='tdarr') }}"
  internalNode: "true"
  inContainer: "true"

tdarr_role_docker_envs_custom

# Type: dict
tdarr_role_docker_envs_custom: {}

Volumes

tdarr_role_docker_volumes_default

# Type: list
tdarr_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_configs_location', role='tdarr') }}:/app/configs"
  - "{{ lookup('role_var', '_paths_server_location', role='tdarr') }}:/app/server"
  - "{{ lookup('role_var', '_paths_logs_location', role='tdarr') }}:/app/logs"
  - "{{ lookup('role_var', '_paths_transcodes_location', role='tdarr') }}:/temp"
  - "/mnt/unionfs/Media:/media"
  - "/mnt/unionfs/Media/Movies:/movies"
  - "/mnt/unionfs/Media/TV:/tv"
  - "/dev/shm:/dev/shm"

tdarr_role_docker_volumes_custom

# Type: list
tdarr_role_docker_volumes_custom: []

Hostname

tdarr_role_docker_hostname

# Type: string
tdarr_role_docker_hostname: "{{ tdarr_name }}"

Networks

tdarr_role_docker_networks_alias

# Type: string
tdarr_role_docker_networks_alias: "{{ tdarr_name }}"

tdarr_role_docker_networks_default

# Type: list
tdarr_role_docker_networks_default: []

tdarr_role_docker_networks_custom

# Type: list
tdarr_role_docker_networks_custom: []

Restart Policy

tdarr_role_docker_restart_policy

# Type: string
tdarr_role_docker_restart_policy: unless-stopped

State

tdarr_role_docker_state

# Type: string
tdarr_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

tdarr_role_docker_blkio_weight

# Type: int
tdarr_role_docker_blkio_weight:

tdarr_role_docker_cpu_period

# Type: int
tdarr_role_docker_cpu_period:

tdarr_role_docker_cpu_quota

# Type: int
tdarr_role_docker_cpu_quota:

tdarr_role_docker_cpu_shares

# Type: int
tdarr_role_docker_cpu_shares:

tdarr_role_docker_cpus

# Type: string
tdarr_role_docker_cpus:

tdarr_role_docker_cpuset_cpus

# Type: string
tdarr_role_docker_cpuset_cpus:

tdarr_role_docker_cpuset_mems

# Type: string
tdarr_role_docker_cpuset_mems:

tdarr_role_docker_kernel_memory

# Type: string
tdarr_role_docker_kernel_memory:

tdarr_role_docker_memory

# Type: string
tdarr_role_docker_memory:

tdarr_role_docker_memory_reservation

# Type: string
tdarr_role_docker_memory_reservation:

tdarr_role_docker_memory_swap

# Type: string
tdarr_role_docker_memory_swap:

tdarr_role_docker_memory_swappiness

# Type: int
tdarr_role_docker_memory_swappiness:

tdarr_role_docker_shm_size

# Type: string
tdarr_role_docker_shm_size:

Security & Devices

tdarr_role_docker_cap_drop

# Type: list
tdarr_role_docker_cap_drop:

tdarr_role_docker_cgroupns_mode

# Type: string
tdarr_role_docker_cgroupns_mode:

tdarr_role_docker_device_cgroup_rules

# Type: list
tdarr_role_docker_device_cgroup_rules:

tdarr_role_docker_device_read_bps

# Type: list
tdarr_role_docker_device_read_bps:

tdarr_role_docker_device_read_iops

# Type: list
tdarr_role_docker_device_read_iops:

tdarr_role_docker_device_requests

# Type: list
tdarr_role_docker_device_requests:

tdarr_role_docker_device_write_bps

# Type: list
tdarr_role_docker_device_write_bps:

tdarr_role_docker_device_write_iops

# Type: list
tdarr_role_docker_device_write_iops:

tdarr_role_docker_devices

# Type: list
tdarr_role_docker_devices:

tdarr_role_docker_devices_default

# Type: string
tdarr_role_docker_devices_default:

tdarr_role_docker_groups

# Type: list
tdarr_role_docker_groups:

tdarr_role_docker_privileged

# Type: bool (true/false)
tdarr_role_docker_privileged:

tdarr_role_docker_security_opts

# Type: list
tdarr_role_docker_security_opts:

tdarr_role_docker_user

# Type: string
tdarr_role_docker_user:

tdarr_role_docker_userns_mode

# Type: string
tdarr_role_docker_userns_mode:

Networking

tdarr_role_docker_dns_opts

# Type: list
tdarr_role_docker_dns_opts:

tdarr_role_docker_dns_search_domains

# Type: list
tdarr_role_docker_dns_search_domains:

tdarr_role_docker_dns_servers

# Type: list
tdarr_role_docker_dns_servers:

tdarr_role_docker_domainname

# Type: string
tdarr_role_docker_domainname:

tdarr_role_docker_exposed_ports

# Type: list
tdarr_role_docker_exposed_ports:

tdarr_role_docker_hosts

# Type: dict
tdarr_role_docker_hosts:

tdarr_role_docker_hosts_use_common

# Type: bool (true/false)
tdarr_role_docker_hosts_use_common:

tdarr_role_docker_ipc_mode

# Type: string
tdarr_role_docker_ipc_mode:

tdarr_role_docker_links

# Type: list
tdarr_role_docker_links:

tdarr_role_docker_network_mode

# Type: string
tdarr_role_docker_network_mode:

tdarr_role_docker_pid_mode

# Type: string
tdarr_role_docker_pid_mode:

tdarr_role_docker_uts

# Type: string
tdarr_role_docker_uts:

Storage

tdarr_role_docker_keep_volumes

# Type: bool (true/false)
tdarr_role_docker_keep_volumes:

tdarr_role_docker_mounts

# Type: list
tdarr_role_docker_mounts:

tdarr_role_docker_storage_opts

# Type: dict
tdarr_role_docker_storage_opts:

tdarr_role_docker_tmpfs

# Type: list
tdarr_role_docker_tmpfs:

tdarr_role_docker_volume_driver

# Type: string
tdarr_role_docker_volume_driver:

tdarr_role_docker_volumes_from

# Type: list
tdarr_role_docker_volumes_from:

tdarr_role_docker_volumes_global

# Type: bool (true/false)
tdarr_role_docker_volumes_global:

tdarr_role_docker_working_dir

# Type: string
tdarr_role_docker_working_dir:

Monitoring & Lifecycle

tdarr_role_docker_auto_remove

# Type: bool (true/false)
tdarr_role_docker_auto_remove:

tdarr_role_docker_cleanup

# Type: bool (true/false)
tdarr_role_docker_cleanup:

tdarr_role_docker_force_kill

# Type: string
tdarr_role_docker_force_kill:

tdarr_role_docker_healthcheck

# Type: dict
tdarr_role_docker_healthcheck:

tdarr_role_docker_healthy_wait_timeout

# Type: int
tdarr_role_docker_healthy_wait_timeout:

tdarr_role_docker_init

# Type: bool (true/false)
tdarr_role_docker_init:

tdarr_role_docker_kill_signal

# Type: string
tdarr_role_docker_kill_signal:

tdarr_role_docker_log_driver

# Type: string
tdarr_role_docker_log_driver:

tdarr_role_docker_log_options

# Type: dict
tdarr_role_docker_log_options:

tdarr_role_docker_oom_killer

# Type: bool (true/false)
tdarr_role_docker_oom_killer:

tdarr_role_docker_oom_score_adj

# Type: int
tdarr_role_docker_oom_score_adj:

tdarr_role_docker_output_logs

# Type: bool (true/false)
tdarr_role_docker_output_logs:

tdarr_role_docker_paused

# Type: bool (true/false)
tdarr_role_docker_paused:

tdarr_role_docker_recreate

# Type: bool (true/false)
tdarr_role_docker_recreate:

tdarr_role_docker_restart_retries

# Type: int
tdarr_role_docker_restart_retries:

tdarr_role_docker_stop_timeout

# Type: int
tdarr_role_docker_stop_timeout:

Other Options

tdarr_role_docker_capabilities

# Type: list
tdarr_role_docker_capabilities:

tdarr_role_docker_cgroup_parent

# Type: string
tdarr_role_docker_cgroup_parent:

tdarr_role_docker_commands

# Type: list
tdarr_role_docker_commands:

tdarr_role_docker_create_timeout

# Type: int
tdarr_role_docker_create_timeout:

tdarr_role_docker_entrypoint

# Type: string
tdarr_role_docker_entrypoint:

tdarr_role_docker_env_file

# Type: string
tdarr_role_docker_env_file:

tdarr_role_docker_labels

# Type: dict
tdarr_role_docker_labels:

tdarr_role_docker_labels_use_common

# Type: bool (true/false)
tdarr_role_docker_labels_use_common:

tdarr_role_docker_read_only

# Type: bool (true/false)
tdarr_role_docker_read_only:

tdarr_role_docker_runtime

# Type: string
tdarr_role_docker_runtime:

tdarr_role_docker_sysctls

# Type: list
tdarr_role_docker_sysctls:

tdarr_role_docker_ulimits

# Type: list
tdarr_role_docker_ulimits:

tdarr_role_autoheal_enabled

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

tdarr_role_depends_on

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

tdarr_role_depends_on_delay

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

tdarr_role_depends_on_healthchecks

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

tdarr_role_diun_enabled

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

tdarr_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
tdarr_role_dns_enabled: true

tdarr_role_docker_controller

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

tdarr_role_docker_image_repo

# Type: string
tdarr_role_docker_image_repo:

tdarr_role_docker_image_tag

# Type: string
tdarr_role_docker_image_tag:

tdarr_role_docker_volumes_download

# Type: bool (true/false)
tdarr_role_docker_volumes_download:

tdarr_role_paths_configs_location

# Type: string
tdarr_role_paths_configs_location:

tdarr_role_paths_logs_location

# Type: string
tdarr_role_paths_logs_location:

tdarr_role_paths_server_location

# Type: string
tdarr_role_paths_server_location:

tdarr_role_paths_transcodes_location

# Type: string
tdarr_role_paths_transcodes_location:

tdarr_role_server_port

# Type: string (quoted number)
tdarr_role_server_port:

tdarr_role_themepark_addons

# Type: string
tdarr_role_themepark_addons:

tdarr_role_themepark_app

# Type: string
tdarr_role_themepark_app:

tdarr_role_themepark_theme

# Type: string
tdarr_role_themepark_theme:

tdarr_role_traefik_api_endpoint

# Type: dict/omit
tdarr_role_traefik_api_endpoint:

tdarr_role_traefik_api_middleware

# Type: string
tdarr_role_traefik_api_middleware:

tdarr_role_traefik_api_middleware_http

# Type: string
tdarr_role_traefik_api_middleware_http:

tdarr_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
tdarr_role_traefik_autodetect_enabled: false

tdarr_role_traefik_certresolver

# Type: string
tdarr_role_traefik_certresolver:

tdarr_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
tdarr_role_traefik_crowdsec_enabled: false

tdarr_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
tdarr_role_traefik_error_pages_enabled: false

tdarr_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
tdarr_role_traefik_gzip_enabled: false

tdarr_role_traefik_middleware_http

# Type: string
tdarr_role_traefik_middleware_http:

tdarr_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
tdarr_role_traefik_middleware_http_api_insecure:

tdarr_role_traefik_middleware_http_insecure

# Type: bool (true/false)
tdarr_role_traefik_middleware_http_insecure:

tdarr_role_traefik_priority

# Type: string
tdarr_role_traefik_priority:

tdarr_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
tdarr_role_traefik_robot_enabled: true

tdarr_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
tdarr_role_traefik_tailscale_enabled: false

tdarr_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
tdarr_role_traefik_wildcard_enabled: true

tdarr_role_web_domain

# Type: string
tdarr_role_web_domain:

tdarr_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
tdarr_role_web_fqdn_override:

Example Override

tdarr_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "tdarr2.{{ user.domain }}"
  - "tdarr.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

tdarr_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
tdarr_role_web_host_override:

Example Override

tdarr_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'tdarr2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

tdarr_role_web_http_port

# Type: string (quoted number)
tdarr_role_web_http_port:

tdarr_role_web_http_scheme

# Type: string ("http"/"https")
tdarr_role_web_http_scheme:

tdarr_role_web_http_serverstransport

# Type: dict/omit
tdarr_role_web_http_serverstransport:

tdarr_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
tdarr_role_web_scheme:

tdarr_role_web_serverstransport

# Type: dict/omit
tdarr_role_web_serverstransport:

tdarr_role_web_subdomain

# Type: string
tdarr_role_web_subdomain: