Tdarr Node

Deployment

sb install sandbox-tdarr-node

Usage

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

tdarr_node_server_ip: "tdarr"
tdarr_node_server_port: "8266"
tdarr_node_node_id: "MainNode"
tdarr_node_node_port: "8267"
tdarr_node_external: false

By switching tdarr_node_external to true the node will be accessible externally via the specified tdarr_node_node_port on any hostname or IP address pointing directly to the server.

To connect the Tdarr node to a Tdarr server, set tdarr_node_server_ip and tdarr_node_server_port to the IP/hostname and port of the exposed Tdarr server.

Role Defaults

Info

Variables can be overridden in /srv/git/saltbox/inventories/host_vars/localhost.yml.

Example Override

tdarr_node_name: "custom_value"

Avoid overriding variables ending in _default

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

BasicsSettingsDockerDocker+Global Override Options

tdarr_node_name

# Type: string
tdarr_node_name: tdarr-node

tdarr_node_server_ip

# Type: string
tdarr_node_server_ip: "tdarr"

tdarr_node_server_port

# Type: string
tdarr_node_server_port: "8266"

tdarr_node_node_id

# Type: string
tdarr_node_node_id: "MainNode"

tdarr_node_node_port

# Type: string
tdarr_node_node_port: "8267"

tdarr_node_external

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

Container

tdarr_node_role_docker_container

# Type: string
tdarr_node_role_docker_container: "{{ tdarr_node_name }}"

Image

tdarr_node_role_docker_image_pull

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

tdarr_node_role_docker_image_repo

# Type: string
tdarr_node_role_docker_image_repo: "haveagitgat/tdarr_node"

tdarr_node_role_docker_image_tag

# Type: string
tdarr_node_role_docker_image_tag: "latest"

tdarr_node_role_docker_image

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

Ports

tdarr_node_role_docker_ports_default

# Type: list
tdarr_node_role_docker_ports_default:
  - "{{ tdarr_node_node_port }}:{{ tdarr_node_node_port }}"

tdarr_node_role_docker_ports_custom

# Type: list
tdarr_node_role_docker_ports_custom: []

Envs

tdarr_node_role_docker_envs_default

# Type: dict
tdarr_node_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"
  serverIP: "{{ tdarr_node_server_ip }}"
  serverPort: "{{ tdarr_node_server_port }}"
  nodeName: "{{ tdarr_node_node_id }}"
  inContainer: "true"

tdarr_node_role_docker_envs_custom

# Type: dict
tdarr_node_role_docker_envs_custom: {}

Volumes

tdarr_node_role_docker_volumes_default

# Type: list
tdarr_node_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_configs_location', role='tdarr') }}:/app/configs"
  - "{{ 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_node_role_docker_volumes_custom

# Type: list
tdarr_node_role_docker_volumes_custom: []

Hostname

tdarr_node_role_docker_hostname

# Type: string
tdarr_node_role_docker_hostname: "{{ tdarr_node_name }}"

Networks

tdarr_node_role_docker_networks_alias

# Type: string
tdarr_node_role_docker_networks_alias: "{{ tdarr_node_name }}"

tdarr_node_role_docker_networks_default

# Type: list
tdarr_node_role_docker_networks_default: []

tdarr_node_role_docker_networks_custom

# Type: list
tdarr_node_role_docker_networks_custom: []

Restart Policy

tdarr_node_role_docker_restart_policy

# Type: string
tdarr_node_role_docker_restart_policy: unless-stopped

State

tdarr_node_role_docker_state

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

# Type: int
tdarr_node_role_docker_blkio_weight:

tdarr_node_role_docker_cpu_period

# Type: int
tdarr_node_role_docker_cpu_period:

tdarr_node_role_docker_cpu_quota

# Type: int
tdarr_node_role_docker_cpu_quota:

tdarr_node_role_docker_cpu_shares

# Type: int
tdarr_node_role_docker_cpu_shares:

tdarr_node_role_docker_cpus

# Type: string
tdarr_node_role_docker_cpus:

tdarr_node_role_docker_cpuset_cpus

# Type: string
tdarr_node_role_docker_cpuset_cpus:

tdarr_node_role_docker_cpuset_mems

# Type: string
tdarr_node_role_docker_cpuset_mems:

tdarr_node_role_docker_kernel_memory

# Type: string
tdarr_node_role_docker_kernel_memory:

tdarr_node_role_docker_memory

# Type: string
tdarr_node_role_docker_memory:

tdarr_node_role_docker_memory_reservation

# Type: string
tdarr_node_role_docker_memory_reservation:

tdarr_node_role_docker_memory_swap

# Type: string
tdarr_node_role_docker_memory_swap:

tdarr_node_role_docker_memory_swappiness

# Type: int
tdarr_node_role_docker_memory_swappiness:

tdarr_node_role_docker_shm_size

# Type: string
tdarr_node_role_docker_shm_size:

Security & Devices

tdarr_node_role_docker_cap_drop

# Type: list
tdarr_node_role_docker_cap_drop:

tdarr_node_role_docker_cgroupns_mode

# Type: string
tdarr_node_role_docker_cgroupns_mode:

tdarr_node_role_docker_device_cgroup_rules

# Type: list
tdarr_node_role_docker_device_cgroup_rules:

tdarr_node_role_docker_device_read_bps

# Type: list
tdarr_node_role_docker_device_read_bps:

tdarr_node_role_docker_device_read_iops

# Type: list
tdarr_node_role_docker_device_read_iops:

tdarr_node_role_docker_device_requests

# Type: list
tdarr_node_role_docker_device_requests:

tdarr_node_role_docker_device_write_bps

# Type: list
tdarr_node_role_docker_device_write_bps:

tdarr_node_role_docker_device_write_iops

# Type: list
tdarr_node_role_docker_device_write_iops:

tdarr_node_role_docker_devices

# Type: list
tdarr_node_role_docker_devices:

tdarr_node_role_docker_devices_default

# Type: string
tdarr_node_role_docker_devices_default:

tdarr_node_role_docker_groups

# Type: list
tdarr_node_role_docker_groups:

tdarr_node_role_docker_privileged

# Type: bool (true/false)
tdarr_node_role_docker_privileged:

tdarr_node_role_docker_security_opts

# Type: list
tdarr_node_role_docker_security_opts:

tdarr_node_role_docker_user

# Type: string
tdarr_node_role_docker_user:

tdarr_node_role_docker_userns_mode

# Type: string
tdarr_node_role_docker_userns_mode:

Networking

tdarr_node_role_docker_dns_opts

# Type: list
tdarr_node_role_docker_dns_opts:

tdarr_node_role_docker_dns_search_domains

# Type: list
tdarr_node_role_docker_dns_search_domains:

tdarr_node_role_docker_dns_servers

# Type: list
tdarr_node_role_docker_dns_servers:

tdarr_node_role_docker_domainname

# Type: string
tdarr_node_role_docker_domainname:

tdarr_node_role_docker_exposed_ports

# Type: list
tdarr_node_role_docker_exposed_ports:

tdarr_node_role_docker_hosts

# Type: dict
tdarr_node_role_docker_hosts:

tdarr_node_role_docker_hosts_use_common

# Type: bool (true/false)
tdarr_node_role_docker_hosts_use_common:

tdarr_node_role_docker_ipc_mode

# Type: string
tdarr_node_role_docker_ipc_mode:

tdarr_node_role_docker_links

# Type: list
tdarr_node_role_docker_links:

tdarr_node_role_docker_network_mode

# Type: string
tdarr_node_role_docker_network_mode:

tdarr_node_role_docker_pid_mode

# Type: string
tdarr_node_role_docker_pid_mode:

tdarr_node_role_docker_uts

# Type: string
tdarr_node_role_docker_uts:

Storage

tdarr_node_role_docker_keep_volumes

# Type: bool (true/false)
tdarr_node_role_docker_keep_volumes:

tdarr_node_role_docker_mounts

# Type: list
tdarr_node_role_docker_mounts:

tdarr_node_role_docker_storage_opts

# Type: dict
tdarr_node_role_docker_storage_opts:

tdarr_node_role_docker_tmpfs

# Type: list
tdarr_node_role_docker_tmpfs:

tdarr_node_role_docker_volume_driver

# Type: string
tdarr_node_role_docker_volume_driver:

tdarr_node_role_docker_volumes_from

# Type: list
tdarr_node_role_docker_volumes_from:

tdarr_node_role_docker_volumes_global

# Type: bool (true/false)
tdarr_node_role_docker_volumes_global:

tdarr_node_role_docker_working_dir

# Type: string
tdarr_node_role_docker_working_dir:

Monitoring & Lifecycle

tdarr_node_role_docker_auto_remove

# Type: bool (true/false)
tdarr_node_role_docker_auto_remove:

tdarr_node_role_docker_cleanup

# Type: bool (true/false)
tdarr_node_role_docker_cleanup:

tdarr_node_role_docker_force_kill

# Type: string
tdarr_node_role_docker_force_kill:

tdarr_node_role_docker_healthcheck

# Type: dict
tdarr_node_role_docker_healthcheck:

tdarr_node_role_docker_healthy_wait_timeout

# Type: int
tdarr_node_role_docker_healthy_wait_timeout:

tdarr_node_role_docker_init

# Type: bool (true/false)
tdarr_node_role_docker_init:

tdarr_node_role_docker_kill_signal

# Type: string
tdarr_node_role_docker_kill_signal:

tdarr_node_role_docker_log_driver

# Type: string
tdarr_node_role_docker_log_driver:

tdarr_node_role_docker_log_options

# Type: dict
tdarr_node_role_docker_log_options:

tdarr_node_role_docker_oom_killer

# Type: bool (true/false)
tdarr_node_role_docker_oom_killer:

tdarr_node_role_docker_oom_score_adj

# Type: int
tdarr_node_role_docker_oom_score_adj:

tdarr_node_role_docker_output_logs

# Type: bool (true/false)
tdarr_node_role_docker_output_logs:

tdarr_node_role_docker_paused

# Type: bool (true/false)
tdarr_node_role_docker_paused:

tdarr_node_role_docker_recreate

# Type: bool (true/false)
tdarr_node_role_docker_recreate:

tdarr_node_role_docker_restart_retries

# Type: int
tdarr_node_role_docker_restart_retries:

tdarr_node_role_docker_stop_timeout

# Type: int
tdarr_node_role_docker_stop_timeout:

Other Options

tdarr_node_role_docker_capabilities

# Type: list
tdarr_node_role_docker_capabilities:

tdarr_node_role_docker_cgroup_parent

# Type: string
tdarr_node_role_docker_cgroup_parent:

tdarr_node_role_docker_commands

# Type: list
tdarr_node_role_docker_commands:

tdarr_node_role_docker_create_timeout

# Type: int
tdarr_node_role_docker_create_timeout:

tdarr_node_role_docker_entrypoint

# Type: string
tdarr_node_role_docker_entrypoint:

tdarr_node_role_docker_env_file

# Type: string
tdarr_node_role_docker_env_file:

tdarr_node_role_docker_labels

# Type: dict
tdarr_node_role_docker_labels:

tdarr_node_role_docker_labels_use_common

# Type: bool (true/false)
tdarr_node_role_docker_labels_use_common:

tdarr_node_role_docker_read_only

# Type: bool (true/false)
tdarr_node_role_docker_read_only:

tdarr_node_role_docker_runtime

# Type: string
tdarr_node_role_docker_runtime:

tdarr_node_role_docker_sysctls

# Type: list
tdarr_node_role_docker_sysctls:

tdarr_node_role_docker_ulimits

# Type: list
tdarr_node_role_docker_ulimits:

tdarr_node_role_autoheal_enabled

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

tdarr_node_role_depends_on

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

tdarr_node_role_depends_on_delay

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

tdarr_node_role_depends_on_healthchecks

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

tdarr_node_role_diun_enabled

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

tdarr_node_role_docker_controller

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

tdarr_node_role_docker_image_repo

# Type: string
tdarr_node_role_docker_image_repo:

tdarr_node_role_docker_image_tag

# Type: string
tdarr_node_role_docker_image_tag:

tdarr_node_role_docker_volumes_download

# Type: bool (true/false)
tdarr_node_role_docker_volumes_download:

tdarr_node_role_paths_configs_location

# Type: string
tdarr_node_role_paths_configs_location:

tdarr_node_role_paths_logs_location

# Type: string
tdarr_node_role_paths_logs_location:

tdarr_node_role_paths_transcodes_location

# Type: string
tdarr_node_role_paths_transcodes_location: