Plex Utills

Description / name	Input element
Your domain name

Overview

Plex Utills is a web-based utility collection for managing and maintaining your Plex Media Server. It provides various tools and helpers for common Plex administration tasks.

Manual

Releases

Community

---

Deployment

sb install sandbox-plex-utills

Usage

Visit https://plex-utills.iYOUR_DOMAIN_NAMEi.

Basics

• Configuration files are stored in /opt/plex-utills
• Application logs are stored in /opt/plex-utills/logs
• The /mnt directory is mounted at /films for media access
• The web interface runs on port 80 internally

Tip

Configure the application through the web interface after your first login.

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   plex_utills_name: "custom_value"
   

   Avoid overriding variables ending in _default

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

BasicsWebDNSTraefikDockerDocker+Global Override Options

plex_utills_name

# Type: string
plex_utills_name: plex-utills

plex_utills_role_web_subdomain

# Type: string
plex_utills_role_web_subdomain: "{{ plex_utills_name }}"

plex_utills_role_web_domain

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

plex_utills_role_web_port

# Type: string
plex_utills_role_web_port: "80"

plex_utills_role_web_url

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

plex_utills_role_dns_record

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

plex_utills_role_dns_zone

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

plex_utills_role_dns_proxy

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

plex_utills_role_traefik_sso_middleware

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

plex_utills_role_traefik_middleware_default

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

plex_utills_role_traefik_middleware_custom

# Type: string
plex_utills_role_traefik_middleware_custom: ""

plex_utills_role_traefik_certresolver

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

plex_utills_role_traefik_enabled

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

plex_utills_role_traefik_api_enabled

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

plex_utills_role_traefik_api_endpoint

# Type: string
plex_utills_role_traefik_api_endpoint: ""

Container

plex_utills_role_docker_container

# Type: string
plex_utills_role_docker_container: "{{ plex_utills_name }}"

Image

plex_utills_role_docker_image_pull

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

plex_utills_role_docker_image_tag

# Type: string
plex_utills_role_docker_image_tag: "latest"

plex_utills_role_docker_image_repo

# Type: string
plex_utills_role_docker_image_repo: "jkirkcaldy/plex-utills"

plex_utills_role_docker_image

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

Envs

plex_utills_role_docker_envs_default

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

plex_utills_role_docker_envs_custom

# Type: dict
plex_utills_role_docker_envs_custom: {}

Volumes

plex_utills_role_docker_volumes_default

# Type: list
plex_utills_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='plex_utills') }}:/config"
  - "{{ lookup('role_var', '_paths_location', role='plex_utills') }}/logs:/logs"
  - "/mnt:/films"

plex_utills_role_docker_volumes_custom

# Type: list
plex_utills_role_docker_volumes_custom: []

Hostname

plex_utills_role_docker_hostname

# Type: string
plex_utills_role_docker_hostname: "{{ plex_utills_name }}"

Networks

plex_utills_role_docker_networks_alias

# Type: string
plex_utills_role_docker_networks_alias: "{{ plex_utills_name }}"

plex_utills_role_docker_networks_default

# Type: list
plex_utills_role_docker_networks_default: []

plex_utills_role_docker_networks_custom

# Type: list
plex_utills_role_docker_networks_custom: []

Restart Policy

plex_utills_role_docker_restart_policy

# Type: string
plex_utills_role_docker_restart_policy: unless-stopped

State

plex_utills_role_docker_state

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

plex_utills_role_docker_blkio_weight

# Type: int
plex_utills_role_docker_blkio_weight:

plex_utills_role_docker_cpu_period

# Type: int
plex_utills_role_docker_cpu_period:

plex_utills_role_docker_cpu_quota

# Type: int
plex_utills_role_docker_cpu_quota:

plex_utills_role_docker_cpu_shares

# Type: int
plex_utills_role_docker_cpu_shares:

plex_utills_role_docker_cpus

# Type: string
plex_utills_role_docker_cpus:

plex_utills_role_docker_cpuset_cpus

# Type: string
plex_utills_role_docker_cpuset_cpus:

plex_utills_role_docker_cpuset_mems

# Type: string
plex_utills_role_docker_cpuset_mems:

plex_utills_role_docker_kernel_memory

# Type: string
plex_utills_role_docker_kernel_memory:

plex_utills_role_docker_memory

# Type: string
plex_utills_role_docker_memory:

plex_utills_role_docker_memory_reservation

# Type: string
plex_utills_role_docker_memory_reservation:

plex_utills_role_docker_memory_swap

# Type: string
plex_utills_role_docker_memory_swap:

plex_utills_role_docker_memory_swappiness

# Type: int
plex_utills_role_docker_memory_swappiness:

plex_utills_role_docker_shm_size

# Type: string
plex_utills_role_docker_shm_size:

Security & Devices

plex_utills_role_docker_cap_drop

# Type: list
plex_utills_role_docker_cap_drop:

plex_utills_role_docker_cgroupns_mode

# Type: string
plex_utills_role_docker_cgroupns_mode:

plex_utills_role_docker_device_cgroup_rules

# Type: list
plex_utills_role_docker_device_cgroup_rules:

plex_utills_role_docker_device_read_bps

# Type: list
plex_utills_role_docker_device_read_bps:

plex_utills_role_docker_device_read_iops

# Type: list
plex_utills_role_docker_device_read_iops:

plex_utills_role_docker_device_requests

# Type: list
plex_utills_role_docker_device_requests:

plex_utills_role_docker_device_write_bps

# Type: list
plex_utills_role_docker_device_write_bps:

plex_utills_role_docker_device_write_iops

# Type: list
plex_utills_role_docker_device_write_iops:

plex_utills_role_docker_devices

# Type: list
plex_utills_role_docker_devices:

plex_utills_role_docker_devices_default

# Type: string
plex_utills_role_docker_devices_default:

plex_utills_role_docker_groups

# Type: list
plex_utills_role_docker_groups:

plex_utills_role_docker_privileged

# Type: bool (true/false)
plex_utills_role_docker_privileged:

plex_utills_role_docker_security_opts

# Type: list
plex_utills_role_docker_security_opts:

plex_utills_role_docker_user

# Type: string
plex_utills_role_docker_user:

plex_utills_role_docker_userns_mode

# Type: string
plex_utills_role_docker_userns_mode:

Networking

plex_utills_role_docker_dns_opts

# Type: list
plex_utills_role_docker_dns_opts:

plex_utills_role_docker_dns_search_domains

# Type: list
plex_utills_role_docker_dns_search_domains:

plex_utills_role_docker_dns_servers

# Type: list
plex_utills_role_docker_dns_servers:

plex_utills_role_docker_domainname

# Type: string
plex_utills_role_docker_domainname:

plex_utills_role_docker_exposed_ports

# Type: list
plex_utills_role_docker_exposed_ports:

plex_utills_role_docker_hosts

# Type: dict
plex_utills_role_docker_hosts:

plex_utills_role_docker_hosts_use_common

# Type: bool (true/false)
plex_utills_role_docker_hosts_use_common:

plex_utills_role_docker_ipc_mode

# Type: string
plex_utills_role_docker_ipc_mode:

plex_utills_role_docker_links

# Type: list
plex_utills_role_docker_links:

plex_utills_role_docker_network_mode

# Type: string
plex_utills_role_docker_network_mode:

plex_utills_role_docker_pid_mode

# Type: string
plex_utills_role_docker_pid_mode:

plex_utills_role_docker_ports

# Type: list
plex_utills_role_docker_ports:

plex_utills_role_docker_uts

# Type: string
plex_utills_role_docker_uts:

Storage

plex_utills_role_docker_keep_volumes

# Type: bool (true/false)
plex_utills_role_docker_keep_volumes:

plex_utills_role_docker_mounts

# Type: list
plex_utills_role_docker_mounts:

plex_utills_role_docker_storage_opts

# Type: dict
plex_utills_role_docker_storage_opts:

plex_utills_role_docker_tmpfs

# Type: list
plex_utills_role_docker_tmpfs:

plex_utills_role_docker_volume_driver

# Type: string
plex_utills_role_docker_volume_driver:

plex_utills_role_docker_volumes_from

# Type: list
plex_utills_role_docker_volumes_from:

plex_utills_role_docker_volumes_global

# Type: bool (true/false)
plex_utills_role_docker_volumes_global:

plex_utills_role_docker_working_dir

# Type: string
plex_utills_role_docker_working_dir:

Monitoring & Lifecycle

plex_utills_role_docker_auto_remove

# Type: bool (true/false)
plex_utills_role_docker_auto_remove:

plex_utills_role_docker_cleanup

# Type: bool (true/false)
plex_utills_role_docker_cleanup:

plex_utills_role_docker_force_kill

# Type: string
plex_utills_role_docker_force_kill:

plex_utills_role_docker_healthcheck

# Type: dict
plex_utills_role_docker_healthcheck:

plex_utills_role_docker_healthy_wait_timeout

# Type: int
plex_utills_role_docker_healthy_wait_timeout:

plex_utills_role_docker_init

# Type: bool (true/false)
plex_utills_role_docker_init:

plex_utills_role_docker_kill_signal

# Type: string
plex_utills_role_docker_kill_signal:

plex_utills_role_docker_log_driver

# Type: string
plex_utills_role_docker_log_driver:

plex_utills_role_docker_log_options

# Type: dict
plex_utills_role_docker_log_options:

plex_utills_role_docker_oom_killer

# Type: bool (true/false)
plex_utills_role_docker_oom_killer:

plex_utills_role_docker_oom_score_adj

# Type: int
plex_utills_role_docker_oom_score_adj:

plex_utills_role_docker_output_logs

# Type: bool (true/false)
plex_utills_role_docker_output_logs:

plex_utills_role_docker_paused

# Type: bool (true/false)
plex_utills_role_docker_paused:

plex_utills_role_docker_recreate

# Type: bool (true/false)
plex_utills_role_docker_recreate:

plex_utills_role_docker_restart_retries

# Type: int
plex_utills_role_docker_restart_retries:

plex_utills_role_docker_stop_timeout

# Type: int
plex_utills_role_docker_stop_timeout:

Other Options

plex_utills_role_docker_capabilities

# Type: list
plex_utills_role_docker_capabilities:

plex_utills_role_docker_cgroup_parent

# Type: string
plex_utills_role_docker_cgroup_parent:

plex_utills_role_docker_commands

# Type: list
plex_utills_role_docker_commands:

plex_utills_role_docker_create_timeout

# Type: int
plex_utills_role_docker_create_timeout:

plex_utills_role_docker_entrypoint

# Type: string
plex_utills_role_docker_entrypoint:

plex_utills_role_docker_env_file

# Type: string
plex_utills_role_docker_env_file:

plex_utills_role_docker_labels

# Type: dict
plex_utills_role_docker_labels:

plex_utills_role_docker_labels_use_common

# Type: bool (true/false)
plex_utills_role_docker_labels_use_common:

plex_utills_role_docker_read_only

# Type: bool (true/false)
plex_utills_role_docker_read_only:

plex_utills_role_docker_runtime

# Type: string
plex_utills_role_docker_runtime:

plex_utills_role_docker_sysctls

# Type: list
plex_utills_role_docker_sysctls:

plex_utills_role_docker_ulimits

# Type: list
plex_utills_role_docker_ulimits:

plex_utills_role_autoheal_enabled

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

plex_utills_role_depends_on

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

plex_utills_role_depends_on_delay

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

plex_utills_role_depends_on_healthchecks

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

plex_utills_role_diun_enabled

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

plex_utills_role_dns_enabled

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

plex_utills_role_docker_controller

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

plex_utills_role_docker_image_repo

# Type: string
plex_utills_role_docker_image_repo:

plex_utills_role_docker_image_tag

# Type: string
plex_utills_role_docker_image_tag:

plex_utills_role_docker_volumes_download

# Type: bool (true/false)
plex_utills_role_docker_volumes_download:

plex_utills_role_paths_location

# Type: string
plex_utills_role_paths_location:

plex_utills_role_themepark_addons

# Type: string
plex_utills_role_themepark_addons:

plex_utills_role_themepark_app

# Type: string
plex_utills_role_themepark_app:

plex_utills_role_themepark_theme

# Type: string
plex_utills_role_themepark_theme:

plex_utills_role_traefik_api_endpoint

# Type: dict/omit
plex_utills_role_traefik_api_endpoint:

plex_utills_role_traefik_api_middleware

# Type: string
plex_utills_role_traefik_api_middleware:

plex_utills_role_traefik_api_middleware_http

# Type: string
plex_utills_role_traefik_api_middleware_http:

plex_utills_role_traefik_autodetect_enabled

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

plex_utills_role_traefik_certresolver

# Type: string
plex_utills_role_traefik_certresolver:

plex_utills_role_traefik_crowdsec_enabled

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

plex_utills_role_traefik_error_pages_enabled

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

plex_utills_role_traefik_gzip_enabled

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

plex_utills_role_traefik_middleware_http

# Type: string
plex_utills_role_traefik_middleware_http:

plex_utills_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
plex_utills_role_traefik_middleware_http_api_insecure:

plex_utills_role_traefik_middleware_http_insecure

# Type: bool (true/false)
plex_utills_role_traefik_middleware_http_insecure:

plex_utills_role_traefik_priority

# Type: string
plex_utills_role_traefik_priority:

plex_utills_role_traefik_robot_enabled

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

plex_utills_role_traefik_tailscale_enabled

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

plex_utills_role_traefik_wildcard_enabled

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

plex_utills_role_web_domain

# Type: string
plex_utills_role_web_domain:

plex_utills_role_web_fqdn_override

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

Example Override

plex_utills_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "plex_utills2.{{ user.domain }}"
  - "plex_utills.otherdomain.tld"

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

plex_utills_role_web_host_override

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

Example Override

plex_utills_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'plex_utills2.' + user.domain }}`)"

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

plex_utills_role_web_http_port

# Type: string (quoted number)
plex_utills_role_web_http_port:

plex_utills_role_web_http_scheme

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

plex_utills_role_web_http_serverstransport

# Type: dict/omit
plex_utills_role_web_http_serverstransport:

plex_utills_role_web_scheme

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

plex_utills_role_web_serverstransport

# Type: dict/omit
plex_utills_role_web_serverstransport:

plex_utills_role_web_subdomain

# Type: string
plex_utills_role_web_subdomain: