Plex-Trakt-Sync

Overview

Plex-Trakt-Sync is a two-way synchronization tool between trakt.tv and Plex Media Server, allowing users to sync media collections, ratings, watched status, and watchlists without requiring a Plex Pass or Trakt VIP subscription.

Manual

Releases

Community

---

Pre-Deployment

If you need more than one Plex-Trakt account pair processed, that can be achieved through multiple instances, e.g.:

plextraktsync_instances: ['plextraktsync-seed', 'plextraktsync-alice', 'plextraktsync-charlie']

Deployment

sb install sandbox-plextraktsync

Usage

docker exec plextraktsync plextraktsync --help

Finishing the setup

The role sets the target Plex server to your Saltbox Plex instance if deployed. To add the missing Trakt.tv credentials, you can run:

docker exec -it plextraktsync plextraktsync login

Resetting Plex credentials

docker exec -it plextraktsync plextraktsync plex-login

Role Defaults

Variables can be customized using the Inventory. (1)

1. This role supports multiple instances via plextraktsync_instances.

   Example override

   Role-scopedInstance-scoped

   plextraktsync_role_web_subdomain: "custom"
   

   Applies to all instances of plextraktsync

   plextraktsync2_web_subdomain: "custom2"
   

   Applies to the instance named plextraktsync2

   Avoid overriding variables ending in _default

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

BasicsDockerDocker+Global Override Options

plextraktsync_instances

# Type: list
plextraktsync_instances: ['plextraktsync']

Example Override

# Type: list
plextraktsync_instances: ["plextraktsync", "plextraktsync2"]

Container

plextraktsync_role_docker_containerplextraktsync2_docker_container

# Type: string
plextraktsync_role_docker_container: "{{ plextraktsync_name }}"

# Type: string
plextraktsync2_docker_container: "{{ plextraktsync_name }}"

Image

plextraktsync_role_docker_image_pullplextraktsync2_docker_image_pull

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

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

plextraktsync_role_docker_image_tagplextraktsync2_docker_image_tag

# Type: string
plextraktsync_role_docker_image_tag: "latest"

# Type: string
plextraktsync2_docker_image_tag: "latest"

plextraktsync_role_docker_image_repoplextraktsync2_docker_image_repo

# Type: string
plextraktsync_role_docker_image_repo: "lscr.io/linuxserver-labs/plextraktsync"

# Type: string
plextraktsync2_docker_image_repo: "lscr.io/linuxserver-labs/plextraktsync"

plextraktsync_role_docker_imageplextraktsync2_docker_image

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

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

Envs

plextraktsync_role_docker_envs_defaultplextraktsync2_docker_envs_default

# Type: dict
plextraktsync_role_docker_envs_default:
  TZ: "{{ tz }}"
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"

# Type: dict
plextraktsync2_docker_envs_default:
  TZ: "{{ tz }}"
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"

plextraktsync_role_docker_envs_customplextraktsync2_docker_envs_custom

# Type: dict
plextraktsync_role_docker_envs_custom: {}

# Type: dict
plextraktsync2_docker_envs_custom: {}

Commands

plextraktsync_role_docker_commands_defaultplextraktsync2_docker_commands_default

# Type: list
plextraktsync_role_docker_commands_default: []

# Type: list
plextraktsync2_docker_commands_default: []

plextraktsync_role_docker_commands_customplextraktsync2_docker_commands_custom

# Type: list
plextraktsync_role_docker_commands_custom: []

# Type: list
plextraktsync2_docker_commands_custom: []

Volumes

plextraktsync_role_docker_volumes_defaultplextraktsync2_docker_volumes_default

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

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

plextraktsync_role_docker_volumes_customplextraktsync2_docker_volumes_custom

# Type: list
plextraktsync_role_docker_volumes_custom: []

# Type: list
plextraktsync2_docker_volumes_custom: []

Hostname

plextraktsync_role_docker_hostnameplextraktsync2_docker_hostname

# Type: string
plextraktsync_role_docker_hostname: "{{ plextraktsync_name }}"

# Type: string
plextraktsync2_docker_hostname: "{{ plextraktsync_name }}"

Networks

plextraktsync_role_docker_networks_aliasplextraktsync2_docker_networks_alias

# Type: string
plextraktsync_role_docker_networks_alias: "{{ plextraktsync_name }}"

# Type: string
plextraktsync2_docker_networks_alias: "{{ plextraktsync_name }}"

plextraktsync_role_docker_networks_defaultplextraktsync2_docker_networks_default

# Type: list
plextraktsync_role_docker_networks_default: []

# Type: list
plextraktsync2_docker_networks_default: []

plextraktsync_role_docker_networks_customplextraktsync2_docker_networks_custom

# Type: list
plextraktsync_role_docker_networks_custom: []

# Type: list
plextraktsync2_docker_networks_custom: []

Restart Policy

plextraktsync_role_docker_restart_policyplextraktsync2_docker_restart_policy

# Type: string
plextraktsync_role_docker_restart_policy: unless-stopped

# Type: string
plextraktsync2_docker_restart_policy: unless-stopped

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

Resource Limits

plextraktsync_role_docker_blkio_weightplextraktsync2_docker_blkio_weight

# Type: int
plextraktsync_role_docker_blkio_weight:

# Type: int
plextraktsync2_docker_blkio_weight:

plextraktsync_role_docker_cpu_periodplextraktsync2_docker_cpu_period

# Type: int
plextraktsync_role_docker_cpu_period:

# Type: int
plextraktsync2_docker_cpu_period:

plextraktsync_role_docker_cpu_quotaplextraktsync2_docker_cpu_quota

# Type: int
plextraktsync_role_docker_cpu_quota:

# Type: int
plextraktsync2_docker_cpu_quota:

plextraktsync_role_docker_cpu_sharesplextraktsync2_docker_cpu_shares

# Type: int
plextraktsync_role_docker_cpu_shares:

# Type: int
plextraktsync2_docker_cpu_shares:

plextraktsync_role_docker_cpusplextraktsync2_docker_cpus

# Type: string
plextraktsync_role_docker_cpus:

# Type: string
plextraktsync2_docker_cpus:

plextraktsync_role_docker_cpuset_cpusplextraktsync2_docker_cpuset_cpus

# Type: string
plextraktsync_role_docker_cpuset_cpus:

# Type: string
plextraktsync2_docker_cpuset_cpus:

plextraktsync_role_docker_cpuset_memsplextraktsync2_docker_cpuset_mems

# Type: string
plextraktsync_role_docker_cpuset_mems:

# Type: string
plextraktsync2_docker_cpuset_mems:

plextraktsync_role_docker_kernel_memoryplextraktsync2_docker_kernel_memory

# Type: string
plextraktsync_role_docker_kernel_memory:

# Type: string
plextraktsync2_docker_kernel_memory:

plextraktsync_role_docker_memoryplextraktsync2_docker_memory

# Type: string
plextraktsync_role_docker_memory:

# Type: string
plextraktsync2_docker_memory:

plextraktsync_role_docker_memory_reservationplextraktsync2_docker_memory_reservation

# Type: string
plextraktsync_role_docker_memory_reservation:

# Type: string
plextraktsync2_docker_memory_reservation:

plextraktsync_role_docker_memory_swapplextraktsync2_docker_memory_swap

# Type: string
plextraktsync_role_docker_memory_swap:

# Type: string
plextraktsync2_docker_memory_swap:

plextraktsync_role_docker_memory_swappinessplextraktsync2_docker_memory_swappiness

# Type: int
plextraktsync_role_docker_memory_swappiness:

# Type: int
plextraktsync2_docker_memory_swappiness:

plextraktsync_role_docker_shm_sizeplextraktsync2_docker_shm_size

# Type: string
plextraktsync_role_docker_shm_size:

# Type: string
plextraktsync2_docker_shm_size:

Security & Devices

plextraktsync_role_docker_cap_dropplextraktsync2_docker_cap_drop

# Type: list
plextraktsync_role_docker_cap_drop:

# Type: list
plextraktsync2_docker_cap_drop:

plextraktsync_role_docker_cgroupns_modeplextraktsync2_docker_cgroupns_mode

# Type: string
plextraktsync_role_docker_cgroupns_mode:

# Type: string
plextraktsync2_docker_cgroupns_mode:

plextraktsync_role_docker_device_cgroup_rulesplextraktsync2_docker_device_cgroup_rules

# Type: list
plextraktsync_role_docker_device_cgroup_rules:

# Type: list
plextraktsync2_docker_device_cgroup_rules:

plextraktsync_role_docker_device_read_bpsplextraktsync2_docker_device_read_bps

# Type: list
plextraktsync_role_docker_device_read_bps:

# Type: list
plextraktsync2_docker_device_read_bps:

plextraktsync_role_docker_device_read_iopsplextraktsync2_docker_device_read_iops

# Type: list
plextraktsync_role_docker_device_read_iops:

# Type: list
plextraktsync2_docker_device_read_iops:

plextraktsync_role_docker_device_requestsplextraktsync2_docker_device_requests

# Type: list
plextraktsync_role_docker_device_requests:

# Type: list
plextraktsync2_docker_device_requests:

plextraktsync_role_docker_device_write_bpsplextraktsync2_docker_device_write_bps

# Type: list
plextraktsync_role_docker_device_write_bps:

# Type: list
plextraktsync2_docker_device_write_bps:

plextraktsync_role_docker_device_write_iopsplextraktsync2_docker_device_write_iops

# Type: list
plextraktsync_role_docker_device_write_iops:

# Type: list
plextraktsync2_docker_device_write_iops:

plextraktsync_role_docker_devicesplextraktsync2_docker_devices

# Type: list
plextraktsync_role_docker_devices:

# Type: list
plextraktsync2_docker_devices:

plextraktsync_role_docker_groupsplextraktsync2_docker_groups

# Type: list
plextraktsync_role_docker_groups:

# Type: list
plextraktsync2_docker_groups:

plextraktsync_role_docker_privilegedplextraktsync2_docker_privileged

# Type: bool (true/false)
plextraktsync_role_docker_privileged:

# Type: bool (true/false)
plextraktsync2_docker_privileged:

plextraktsync_role_docker_security_optsplextraktsync2_docker_security_opts

# Type: list
plextraktsync_role_docker_security_opts:

# Type: list
plextraktsync2_docker_security_opts:

plextraktsync_role_docker_userplextraktsync2_docker_user

# Type: string
plextraktsync_role_docker_user:

# Type: string
plextraktsync2_docker_user:

plextraktsync_role_docker_userns_modeplextraktsync2_docker_userns_mode

# Type: string
plextraktsync_role_docker_userns_mode:

# Type: string
plextraktsync2_docker_userns_mode:

Networking

plextraktsync_role_docker_dns_optsplextraktsync2_docker_dns_opts

# Type: list
plextraktsync_role_docker_dns_opts:

# Type: list
plextraktsync2_docker_dns_opts:

plextraktsync_role_docker_dns_search_domainsplextraktsync2_docker_dns_search_domains

# Type: list
plextraktsync_role_docker_dns_search_domains:

# Type: list
plextraktsync2_docker_dns_search_domains:

plextraktsync_role_docker_dns_serversplextraktsync2_docker_dns_servers

# Type: list
plextraktsync_role_docker_dns_servers:

# Type: list
plextraktsync2_docker_dns_servers:

plextraktsync_role_docker_domainnameplextraktsync2_docker_domainname

# Type: string
plextraktsync_role_docker_domainname:

# Type: string
plextraktsync2_docker_domainname:

plextraktsync_role_docker_exposed_portsplextraktsync2_docker_exposed_ports

# Type: list
plextraktsync_role_docker_exposed_ports:

# Type: list
plextraktsync2_docker_exposed_ports:

plextraktsync_role_docker_hostsplextraktsync2_docker_hosts

# Type: dict
plextraktsync_role_docker_hosts:

# Type: dict
plextraktsync2_docker_hosts:

plextraktsync_role_docker_hosts_use_commonplextraktsync2_docker_hosts_use_common

# Type: bool (true/false)
plextraktsync_role_docker_hosts_use_common:

# Type: bool (true/false)
plextraktsync2_docker_hosts_use_common:

plextraktsync_role_docker_ipc_modeplextraktsync2_docker_ipc_mode

# Type: string
plextraktsync_role_docker_ipc_mode:

# Type: string
plextraktsync2_docker_ipc_mode:

plextraktsync_role_docker_linksplextraktsync2_docker_links

# Type: list
plextraktsync_role_docker_links:

# Type: list
plextraktsync2_docker_links:

plextraktsync_role_docker_network_modeplextraktsync2_docker_network_mode

# Type: string
plextraktsync_role_docker_network_mode:

# Type: string
plextraktsync2_docker_network_mode:

plextraktsync_role_docker_pid_modeplextraktsync2_docker_pid_mode

# Type: string
plextraktsync_role_docker_pid_mode:

# Type: string
plextraktsync2_docker_pid_mode:

plextraktsync_role_docker_portsplextraktsync2_docker_ports

# Type: list
plextraktsync_role_docker_ports:

# Type: list
plextraktsync2_docker_ports:

plextraktsync_role_docker_utsplextraktsync2_docker_uts

# Type: string
plextraktsync_role_docker_uts:

# Type: string
plextraktsync2_docker_uts:

Storage

plextraktsync_role_docker_keep_volumesplextraktsync2_docker_keep_volumes

# Type: bool (true/false)
plextraktsync_role_docker_keep_volumes:

# Type: bool (true/false)
plextraktsync2_docker_keep_volumes:

plextraktsync_role_docker_mountsplextraktsync2_docker_mounts

# Type: list
plextraktsync_role_docker_mounts:

# Type: list
plextraktsync2_docker_mounts:

plextraktsync_role_docker_storage_optsplextraktsync2_docker_storage_opts

# Type: dict
plextraktsync_role_docker_storage_opts:

# Type: dict
plextraktsync2_docker_storage_opts:

plextraktsync_role_docker_tmpfsplextraktsync2_docker_tmpfs

# Type: list
plextraktsync_role_docker_tmpfs:

# Type: list
plextraktsync2_docker_tmpfs:

plextraktsync_role_docker_volume_driverplextraktsync2_docker_volume_driver

# Type: string
plextraktsync_role_docker_volume_driver:

# Type: string
plextraktsync2_docker_volume_driver:

plextraktsync_role_docker_volumes_fromplextraktsync2_docker_volumes_from

# Type: list
plextraktsync_role_docker_volumes_from:

# Type: list
plextraktsync2_docker_volumes_from:

plextraktsync_role_docker_volumes_globalplextraktsync2_docker_volumes_global

# Type: bool (true/false)
plextraktsync_role_docker_volumes_global:

# Type: bool (true/false)
plextraktsync2_docker_volumes_global:

plextraktsync_role_docker_working_dirplextraktsync2_docker_working_dir

# Type: string
plextraktsync_role_docker_working_dir:

# Type: string
plextraktsync2_docker_working_dir:

Monitoring & Lifecycle

plextraktsync_role_docker_auto_removeplextraktsync2_docker_auto_remove

# Type: bool (true/false)
plextraktsync_role_docker_auto_remove:

# Type: bool (true/false)
plextraktsync2_docker_auto_remove:

plextraktsync_role_docker_cleanupplextraktsync2_docker_cleanup

# Type: bool (true/false)
plextraktsync_role_docker_cleanup:

# Type: bool (true/false)
plextraktsync2_docker_cleanup:

plextraktsync_role_docker_force_killplextraktsync2_docker_force_kill

# Type: string
plextraktsync_role_docker_force_kill:

# Type: string
plextraktsync2_docker_force_kill:

plextraktsync_role_docker_healthcheckplextraktsync2_docker_healthcheck

# Type: dict
plextraktsync_role_docker_healthcheck:

# Type: dict
plextraktsync2_docker_healthcheck:

plextraktsync_role_docker_healthy_wait_timeoutplextraktsync2_docker_healthy_wait_timeout

# Type: int
plextraktsync_role_docker_healthy_wait_timeout:

# Type: int
plextraktsync2_docker_healthy_wait_timeout:

plextraktsync_role_docker_initplextraktsync2_docker_init

# Type: bool (true/false)
plextraktsync_role_docker_init:

# Type: bool (true/false)
plextraktsync2_docker_init:

plextraktsync_role_docker_kill_signalplextraktsync2_docker_kill_signal

# Type: string
plextraktsync_role_docker_kill_signal:

# Type: string
plextraktsync2_docker_kill_signal:

plextraktsync_role_docker_log_driverplextraktsync2_docker_log_driver

# Type: string
plextraktsync_role_docker_log_driver:

# Type: string
plextraktsync2_docker_log_driver:

plextraktsync_role_docker_log_optionsplextraktsync2_docker_log_options

# Type: dict
plextraktsync_role_docker_log_options:

# Type: dict
plextraktsync2_docker_log_options:

plextraktsync_role_docker_oom_killerplextraktsync2_docker_oom_killer

# Type: bool (true/false)
plextraktsync_role_docker_oom_killer:

# Type: bool (true/false)
plextraktsync2_docker_oom_killer:

plextraktsync_role_docker_oom_score_adjplextraktsync2_docker_oom_score_adj

# Type: int
plextraktsync_role_docker_oom_score_adj:

# Type: int
plextraktsync2_docker_oom_score_adj:

plextraktsync_role_docker_output_logsplextraktsync2_docker_output_logs

# Type: bool (true/false)
plextraktsync_role_docker_output_logs:

# Type: bool (true/false)
plextraktsync2_docker_output_logs:

plextraktsync_role_docker_pausedplextraktsync2_docker_paused

# Type: bool (true/false)
plextraktsync_role_docker_paused:

# Type: bool (true/false)
plextraktsync2_docker_paused:

plextraktsync_role_docker_recreateplextraktsync2_docker_recreate

# Type: bool (true/false)
plextraktsync_role_docker_recreate:

# Type: bool (true/false)
plextraktsync2_docker_recreate:

plextraktsync_role_docker_restart_retriesplextraktsync2_docker_restart_retries

# Type: int
plextraktsync_role_docker_restart_retries:

# Type: int
plextraktsync2_docker_restart_retries:

plextraktsync_role_docker_stop_signalplextraktsync2_docker_stop_signal

# Type: string
plextraktsync_role_docker_stop_signal:

# Type: string
plextraktsync2_docker_stop_signal:

plextraktsync_role_docker_stop_timeoutplextraktsync2_docker_stop_timeout

# Type: int
plextraktsync_role_docker_stop_timeout:

# Type: int
plextraktsync2_docker_stop_timeout:

Other Options

plextraktsync_role_docker_capabilitiesplextraktsync2_docker_capabilities

# Type: list
plextraktsync_role_docker_capabilities:

# Type: list
plextraktsync2_docker_capabilities:

plextraktsync_role_docker_cgroup_parentplextraktsync2_docker_cgroup_parent

# Type: string
plextraktsync_role_docker_cgroup_parent:

# Type: string
plextraktsync2_docker_cgroup_parent:

plextraktsync_role_docker_create_timeoutplextraktsync2_docker_create_timeout

# Type: int
plextraktsync_role_docker_create_timeout:

# Type: int
plextraktsync2_docker_create_timeout:

plextraktsync_role_docker_entrypointplextraktsync2_docker_entrypoint

# Type: string
plextraktsync_role_docker_entrypoint:

# Type: string
plextraktsync2_docker_entrypoint:

plextraktsync_role_docker_env_fileplextraktsync2_docker_env_file

# Type: string
plextraktsync_role_docker_env_file:

# Type: string
plextraktsync2_docker_env_file:

plextraktsync_role_docker_labelsplextraktsync2_docker_labels

# Type: dict
plextraktsync_role_docker_labels:

# Type: dict
plextraktsync2_docker_labels:

plextraktsync_role_docker_labels_use_commonplextraktsync2_docker_labels_use_common

# Type: bool (true/false)
plextraktsync_role_docker_labels_use_common:

# Type: bool (true/false)
plextraktsync2_docker_labels_use_common:

plextraktsync_role_docker_read_onlyplextraktsync2_docker_read_only

# Type: bool (true/false)
plextraktsync_role_docker_read_only:

# Type: bool (true/false)
plextraktsync2_docker_read_only:

plextraktsync_role_docker_runtimeplextraktsync2_docker_runtime

# Type: string
plextraktsync_role_docker_runtime:

# Type: string
plextraktsync2_docker_runtime:

plextraktsync_role_docker_sysctlsplextraktsync2_docker_sysctls

# Type: list
plextraktsync_role_docker_sysctls:

# Type: list
plextraktsync2_docker_sysctls:

plextraktsync_role_docker_ulimitsplextraktsync2_docker_ulimits

# Type: list
plextraktsync_role_docker_ulimits:

# Type: list
plextraktsync2_docker_ulimits:

plextraktsync_role_autoheal_enabledplextraktsync2_autoheal_enabled

# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
plextraktsync_role_autoheal_enabled: true

# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
plextraktsync2_autoheal_enabled: true

plextraktsync_role_depends_onplextraktsync2_depends_on

# List of container dependencies that must be running before containers start
# Type: string
plextraktsync_role_depends_on: ""

# List of container dependencies that must be running before containers start
# Type: string
plextraktsync2_depends_on: ""

plextraktsync_role_depends_on_delayplextraktsync2_depends_on_delay

# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
plextraktsync_role_depends_on_delay: "0"

# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
plextraktsync2_depends_on_delay: "0"

plextraktsync_role_depends_on_healthchecksplextraktsync2_depends_on_healthchecks

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

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

plextraktsync_role_diun_enabledplextraktsync2_diun_enabled

# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
plextraktsync_role_diun_enabled: true

# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
plextraktsync2_diun_enabled: true

plextraktsync_role_docker_controllerplextraktsync2_docker_controller

# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
plextraktsync_role_docker_controller: true

# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
plextraktsync2_docker_controller: true

plextraktsync_role_docker_networks_alias_customplextraktsync2_docker_networks_alias_custom

# Type: list
plextraktsync_role_docker_networks_alias_custom:

# Type: list
plextraktsync2_docker_networks_alias_custom:

plextraktsync_role_docker_volumes_downloadplextraktsync2_docker_volumes_download

# Type: bool (true/false)
plextraktsync_role_docker_volumes_download:

# Type: bool (true/false)
plextraktsync2_docker_volumes_download: