Kometa

Overview

Kometa is a powerful tool designed to give you complete control over your media libraries.

Manual

Releases

Community

---

Info

Kometa is the replacement for Plex Meta Manager. A simple migration for your appdata is available by running sb install sandbox-pmm-kometa-migration.

Configuration

To configure the time that Kometa should run, you may override the kometa_time variable via the inventory system. The default is "03:00" or 3:00 AM in the server's time zone.

Deployment

sb install sandbox-kometa

Usage

docker exec kometa python kometa.py

Basics

You will need to create a config file prior to running the tag:

/opt/kometa/config.yml

There is a Docker-based walkthrough on the Kometa wiki here that you can use to learn how to create this file. Once you've created it, move the file into /opt/kometa/ and then run the tag.

Role Defaults

Use the Inventory to customize variables. (1)

1. This role supports multiple instances via kometa_instances.

   Example override

   Role-levelInstance-level

   kometa_role_web_subdomain: "custom"
   

   Applies to all instances of kometa

   kometa2_web_subdomain: "custom2"
   

   Applies to the instance named kometa2

   Avoid overriding variables ending in _default

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

BasicsSettingsDockerDocker+Global Override Options

kometa_instances

# Type: list
kometa_instances: ["kometa"]

Example Override

# Type: list
kometa_instances: ["kometa", "kometa2"]

kometa_role_timekometa2_time

# Type: string
kometa_role_time: "03:00"

# Type: string
kometa2_time: "03:00"

Container

kometa_role_docker_containerkometa2_docker_container

# Type: string
kometa_role_docker_container: "{{ kometa_name }}"

# Type: string
kometa2_docker_container: "{{ kometa_name }}"

Image

kometa_role_docker_image_pullkometa2_docker_image_pull

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

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

kometa_role_docker_image_repokometa2_docker_image_repo

# Type: string
kometa_role_docker_image_repo: "kometateam/kometa"

# Type: string
kometa2_docker_image_repo: "kometateam/kometa"

kometa_role_docker_image_tagkometa2_docker_image_tag

# Type: string
kometa_role_docker_image_tag: "latest"

# Type: string
kometa2_docker_image_tag: "latest"

kometa_role_docker_imagekometa2_docker_image

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

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

Envs

kometa_role_docker_envs_defaultkometa2_docker_envs_default

# Type: dict
kometa_role_docker_envs_default:
  TZ: "{{ tz }}"
  LOG_LEVEL: "DEBUG"
  KOMETA_TIMES: "{{ lookup('role_var', '_time', role='kometa') }}"

# Type: dict
kometa2_docker_envs_default:
  TZ: "{{ tz }}"
  LOG_LEVEL: "DEBUG"
  KOMETA_TIMES: "{{ lookup('role_var', '_time', role='kometa') }}"

kometa_role_docker_envs_customkometa2_docker_envs_custom

# Type: dict
kometa_role_docker_envs_custom: {}

# Type: dict
kometa2_docker_envs_custom: {}

Volumes

kometa_role_docker_volumes_defaultkometa2_docker_volumes_default

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

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

kometa_role_docker_volumes_customkometa2_docker_volumes_custom

# Type: list
kometa_role_docker_volumes_custom: []

# Type: list
kometa2_docker_volumes_custom: []

Hostname

kometa_role_docker_hostnamekometa2_docker_hostname

# Type: string
kometa_role_docker_hostname: "{{ kometa_name }}"

# Type: string
kometa2_docker_hostname: "{{ kometa_name }}"

Networks

kometa_role_docker_networks_aliaskometa2_docker_networks_alias

# Type: string
kometa_role_docker_networks_alias: "{{ kometa_name }}"

# Type: string
kometa2_docker_networks_alias: "{{ kometa_name }}"

kometa_role_docker_networks_defaultkometa2_docker_networks_default

# Type: list
kometa_role_docker_networks_default: []

# Type: list
kometa2_docker_networks_default: []

kometa_role_docker_networks_customkometa2_docker_networks_custom

# Type: list
kometa_role_docker_networks_custom: []

# Type: list
kometa2_docker_networks_custom: []

Restart Policy

kometa_role_docker_restart_policykometa2_docker_restart_policy

# Type: string
kometa_role_docker_restart_policy: unless-stopped

# Type: string
kometa2_docker_restart_policy: unless-stopped

State

kometa_role_docker_statekometa2_docker_state

# Type: string
kometa_role_docker_state: started

# Type: string
kometa2_docker_state: started

User

kometa_role_docker_userkometa2_docker_user

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

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

kometa_role_docker_blkio_weightkometa2_docker_blkio_weight

# Type: int
kometa_role_docker_blkio_weight:

# Type: int
kometa2_docker_blkio_weight:

kometa_role_docker_cpu_periodkometa2_docker_cpu_period

# Type: int
kometa_role_docker_cpu_period:

# Type: int
kometa2_docker_cpu_period:

kometa_role_docker_cpu_quotakometa2_docker_cpu_quota

# Type: int
kometa_role_docker_cpu_quota:

# Type: int
kometa2_docker_cpu_quota:

kometa_role_docker_cpu_shareskometa2_docker_cpu_shares

# Type: int
kometa_role_docker_cpu_shares:

# Type: int
kometa2_docker_cpu_shares:

kometa_role_docker_cpuskometa2_docker_cpus

# Type: string
kometa_role_docker_cpus:

# Type: string
kometa2_docker_cpus:

kometa_role_docker_cpuset_cpuskometa2_docker_cpuset_cpus

# Type: string
kometa_role_docker_cpuset_cpus:

# Type: string
kometa2_docker_cpuset_cpus:

kometa_role_docker_cpuset_memskometa2_docker_cpuset_mems

# Type: string
kometa_role_docker_cpuset_mems:

# Type: string
kometa2_docker_cpuset_mems:

kometa_role_docker_kernel_memorykometa2_docker_kernel_memory

# Type: string
kometa_role_docker_kernel_memory:

# Type: string
kometa2_docker_kernel_memory:

kometa_role_docker_memorykometa2_docker_memory

# Type: string
kometa_role_docker_memory:

# Type: string
kometa2_docker_memory:

kometa_role_docker_memory_reservationkometa2_docker_memory_reservation

# Type: string
kometa_role_docker_memory_reservation:

# Type: string
kometa2_docker_memory_reservation:

kometa_role_docker_memory_swapkometa2_docker_memory_swap

# Type: string
kometa_role_docker_memory_swap:

# Type: string
kometa2_docker_memory_swap:

kometa_role_docker_memory_swappinesskometa2_docker_memory_swappiness

# Type: int
kometa_role_docker_memory_swappiness:

# Type: int
kometa2_docker_memory_swappiness:

kometa_role_docker_shm_sizekometa2_docker_shm_size

# Type: string
kometa_role_docker_shm_size:

# Type: string
kometa2_docker_shm_size:

Security & Devices

kometa_role_docker_cap_dropkometa2_docker_cap_drop

# Type: list
kometa_role_docker_cap_drop:

# Type: list
kometa2_docker_cap_drop:

kometa_role_docker_cgroupns_modekometa2_docker_cgroupns_mode

# Type: string
kometa_role_docker_cgroupns_mode:

# Type: string
kometa2_docker_cgroupns_mode:

kometa_role_docker_device_cgroup_ruleskometa2_docker_device_cgroup_rules

# Type: list
kometa_role_docker_device_cgroup_rules:

# Type: list
kometa2_docker_device_cgroup_rules:

kometa_role_docker_device_read_bpskometa2_docker_device_read_bps

# Type: list
kometa_role_docker_device_read_bps:

# Type: list
kometa2_docker_device_read_bps:

kometa_role_docker_device_read_iopskometa2_docker_device_read_iops

# Type: list
kometa_role_docker_device_read_iops:

# Type: list
kometa2_docker_device_read_iops:

kometa_role_docker_device_requestskometa2_docker_device_requests

# Type: list
kometa_role_docker_device_requests:

# Type: list
kometa2_docker_device_requests:

kometa_role_docker_device_write_bpskometa2_docker_device_write_bps

# Type: list
kometa_role_docker_device_write_bps:

# Type: list
kometa2_docker_device_write_bps:

kometa_role_docker_device_write_iopskometa2_docker_device_write_iops

# Type: list
kometa_role_docker_device_write_iops:

# Type: list
kometa2_docker_device_write_iops:

kometa_role_docker_deviceskometa2_docker_devices

# Type: list
kometa_role_docker_devices:

# Type: list
kometa2_docker_devices:

kometa_role_docker_devices_defaultkometa2_docker_devices_default

# Type: string
kometa_role_docker_devices_default:

# Type: string
kometa2_docker_devices_default:

kometa_role_docker_groupskometa2_docker_groups

# Type: list
kometa_role_docker_groups:

# Type: list
kometa2_docker_groups:

kometa_role_docker_privilegedkometa2_docker_privileged

# Type: bool (true/false)
kometa_role_docker_privileged:

# Type: bool (true/false)
kometa2_docker_privileged:

kometa_role_docker_security_optskometa2_docker_security_opts

# Type: list
kometa_role_docker_security_opts:

# Type: list
kometa2_docker_security_opts:

kometa_role_docker_userns_modekometa2_docker_userns_mode

# Type: string
kometa_role_docker_userns_mode:

# Type: string
kometa2_docker_userns_mode:

Networking

kometa_role_docker_dns_optskometa2_docker_dns_opts

# Type: list
kometa_role_docker_dns_opts:

# Type: list
kometa2_docker_dns_opts:

kometa_role_docker_dns_search_domainskometa2_docker_dns_search_domains

# Type: list
kometa_role_docker_dns_search_domains:

# Type: list
kometa2_docker_dns_search_domains:

kometa_role_docker_dns_serverskometa2_docker_dns_servers

# Type: list
kometa_role_docker_dns_servers:

# Type: list
kometa2_docker_dns_servers:

kometa_role_docker_domainnamekometa2_docker_domainname

# Type: string
kometa_role_docker_domainname:

# Type: string
kometa2_docker_domainname:

kometa_role_docker_exposed_portskometa2_docker_exposed_ports

# Type: list
kometa_role_docker_exposed_ports:

# Type: list
kometa2_docker_exposed_ports:

kometa_role_docker_hostskometa2_docker_hosts

# Type: dict
kometa_role_docker_hosts:

# Type: dict
kometa2_docker_hosts:

kometa_role_docker_hosts_use_commonkometa2_docker_hosts_use_common

# Type: bool (true/false)
kometa_role_docker_hosts_use_common:

# Type: bool (true/false)
kometa2_docker_hosts_use_common:

kometa_role_docker_ipc_modekometa2_docker_ipc_mode

# Type: string
kometa_role_docker_ipc_mode:

# Type: string
kometa2_docker_ipc_mode:

kometa_role_docker_linkskometa2_docker_links

# Type: list
kometa_role_docker_links:

# Type: list
kometa2_docker_links:

kometa_role_docker_network_modekometa2_docker_network_mode

# Type: string
kometa_role_docker_network_mode:

# Type: string
kometa2_docker_network_mode:

kometa_role_docker_pid_modekometa2_docker_pid_mode

# Type: string
kometa_role_docker_pid_mode:

# Type: string
kometa2_docker_pid_mode:

kometa_role_docker_portskometa2_docker_ports

# Type: list
kometa_role_docker_ports:

# Type: list
kometa2_docker_ports:

kometa_role_docker_utskometa2_docker_uts

# Type: string
kometa_role_docker_uts:

# Type: string
kometa2_docker_uts:

Storage

kometa_role_docker_keep_volumeskometa2_docker_keep_volumes

# Type: bool (true/false)
kometa_role_docker_keep_volumes:

# Type: bool (true/false)
kometa2_docker_keep_volumes:

kometa_role_docker_mountskometa2_docker_mounts

# Type: list
kometa_role_docker_mounts:

# Type: list
kometa2_docker_mounts:

kometa_role_docker_storage_optskometa2_docker_storage_opts

# Type: dict
kometa_role_docker_storage_opts:

# Type: dict
kometa2_docker_storage_opts:

kometa_role_docker_tmpfskometa2_docker_tmpfs

# Type: list
kometa_role_docker_tmpfs:

# Type: list
kometa2_docker_tmpfs:

kometa_role_docker_volume_driverkometa2_docker_volume_driver

# Type: string
kometa_role_docker_volume_driver:

# Type: string
kometa2_docker_volume_driver:

kometa_role_docker_volumes_fromkometa2_docker_volumes_from

# Type: list
kometa_role_docker_volumes_from:

# Type: list
kometa2_docker_volumes_from:

kometa_role_docker_volumes_globalkometa2_docker_volumes_global

# Type: bool (true/false)
kometa_role_docker_volumes_global:

# Type: bool (true/false)
kometa2_docker_volumes_global:

kometa_role_docker_working_dirkometa2_docker_working_dir

# Type: string
kometa_role_docker_working_dir:

# Type: string
kometa2_docker_working_dir:

Monitoring & Lifecycle

kometa_role_docker_auto_removekometa2_docker_auto_remove

# Type: bool (true/false)
kometa_role_docker_auto_remove:

# Type: bool (true/false)
kometa2_docker_auto_remove:

kometa_role_docker_cleanupkometa2_docker_cleanup

# Type: bool (true/false)
kometa_role_docker_cleanup:

# Type: bool (true/false)
kometa2_docker_cleanup:

kometa_role_docker_force_killkometa2_docker_force_kill

# Type: string
kometa_role_docker_force_kill:

# Type: string
kometa2_docker_force_kill:

kometa_role_docker_healthcheckkometa2_docker_healthcheck

# Type: dict
kometa_role_docker_healthcheck:

# Type: dict
kometa2_docker_healthcheck:

kometa_role_docker_healthy_wait_timeoutkometa2_docker_healthy_wait_timeout

# Type: int
kometa_role_docker_healthy_wait_timeout:

# Type: int
kometa2_docker_healthy_wait_timeout:

kometa_role_docker_initkometa2_docker_init

# Type: bool (true/false)
kometa_role_docker_init:

# Type: bool (true/false)
kometa2_docker_init:

kometa_role_docker_kill_signalkometa2_docker_kill_signal

# Type: string
kometa_role_docker_kill_signal:

# Type: string
kometa2_docker_kill_signal:

kometa_role_docker_log_driverkometa2_docker_log_driver

# Type: string
kometa_role_docker_log_driver:

# Type: string
kometa2_docker_log_driver:

kometa_role_docker_log_optionskometa2_docker_log_options

# Type: dict
kometa_role_docker_log_options:

# Type: dict
kometa2_docker_log_options:

kometa_role_docker_oom_killerkometa2_docker_oom_killer

# Type: bool (true/false)
kometa_role_docker_oom_killer:

# Type: bool (true/false)
kometa2_docker_oom_killer:

kometa_role_docker_oom_score_adjkometa2_docker_oom_score_adj

# Type: int
kometa_role_docker_oom_score_adj:

# Type: int
kometa2_docker_oom_score_adj:

kometa_role_docker_output_logskometa2_docker_output_logs

# Type: bool (true/false)
kometa_role_docker_output_logs:

# Type: bool (true/false)
kometa2_docker_output_logs:

kometa_role_docker_pausedkometa2_docker_paused

# Type: bool (true/false)
kometa_role_docker_paused:

# Type: bool (true/false)
kometa2_docker_paused:

kometa_role_docker_recreatekometa2_docker_recreate

# Type: bool (true/false)
kometa_role_docker_recreate:

# Type: bool (true/false)
kometa2_docker_recreate:

kometa_role_docker_restart_retrieskometa2_docker_restart_retries

# Type: int
kometa_role_docker_restart_retries:

# Type: int
kometa2_docker_restart_retries:

kometa_role_docker_stop_timeoutkometa2_docker_stop_timeout

# Type: int
kometa_role_docker_stop_timeout:

# Type: int
kometa2_docker_stop_timeout:

Other Options

kometa_role_docker_capabilitieskometa2_docker_capabilities

# Type: list
kometa_role_docker_capabilities:

# Type: list
kometa2_docker_capabilities:

kometa_role_docker_cgroup_parentkometa2_docker_cgroup_parent

# Type: string
kometa_role_docker_cgroup_parent:

# Type: string
kometa2_docker_cgroup_parent:

kometa_role_docker_commandskometa2_docker_commands

# Type: list
kometa_role_docker_commands:

# Type: list
kometa2_docker_commands:

kometa_role_docker_create_timeoutkometa2_docker_create_timeout

# Type: int
kometa_role_docker_create_timeout:

# Type: int
kometa2_docker_create_timeout:

kometa_role_docker_entrypointkometa2_docker_entrypoint

# Type: string
kometa_role_docker_entrypoint:

# Type: string
kometa2_docker_entrypoint:

kometa_role_docker_env_filekometa2_docker_env_file

# Type: string
kometa_role_docker_env_file:

# Type: string
kometa2_docker_env_file:

kometa_role_docker_labelskometa2_docker_labels

# Type: dict
kometa_role_docker_labels:

# Type: dict
kometa2_docker_labels:

kometa_role_docker_labels_use_commonkometa2_docker_labels_use_common

# Type: bool (true/false)
kometa_role_docker_labels_use_common:

# Type: bool (true/false)
kometa2_docker_labels_use_common:

kometa_role_docker_read_onlykometa2_docker_read_only

# Type: bool (true/false)
kometa_role_docker_read_only:

# Type: bool (true/false)
kometa2_docker_read_only:

kometa_role_docker_runtimekometa2_docker_runtime

# Type: string
kometa_role_docker_runtime:

# Type: string
kometa2_docker_runtime:

kometa_role_docker_sysctlskometa2_docker_sysctls

# Type: list
kometa_role_docker_sysctls:

# Type: list
kometa2_docker_sysctls:

kometa_role_docker_ulimitskometa2_docker_ulimits

# Type: list
kometa_role_docker_ulimits:

# Type: list
kometa2_docker_ulimits:

kometa_role_autoheal_enabledkometa2_autoheal_enabled

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

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

kometa_role_depends_onkometa2_depends_on

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

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

kometa_role_depends_on_delaykometa2_depends_on_delay

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

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

kometa_role_depends_on_healthcheckskometa2_depends_on_healthchecks

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

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

kometa_role_diun_enabledkometa2_diun_enabled

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

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

kometa_role_docker_controllerkometa2_docker_controller

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

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

kometa_role_docker_image_repokometa2_docker_image_repo

# Type: string
kometa_role_docker_image_repo:

# Type: string
kometa2_docker_image_repo:

kometa_role_docker_image_tagkometa2_docker_image_tag

# Type: string
kometa_role_docker_image_tag:

# Type: string
kometa2_docker_image_tag:

kometa_role_docker_volumes_downloadkometa2_docker_volumes_download

# Type: bool (true/false)
kometa_role_docker_volumes_download:

# Type: bool (true/false)
kometa2_docker_volumes_download:

kometa_role_paths_locationkometa2_paths_location

# Type: string
kometa_role_paths_location:

# Type: string
kometa2_paths_location:

kometa_role_timekometa2_time

# Type: string
kometa_role_time:

# Type: string
kometa2_time: