Jellyfin¶
| Description / name | Input element |
|---|---|
| Your domain name |
Overview¶
Jellyfin is a free and open-source media server and suite of multimedia applications designed to organize, manage, and share digital media files across networked devices.
Deployment¶
sb install jellyfin
Usage¶
Visit https://jellyfin.iYOUR_DOMAIN_NAMEi.
Role Defaults¶
Use the Inventory to customize variables. (1)
-
This role supports multiple instances via
jellyfin_instances.Example override
jellyfin_role_web_subdomain: "custom"Applies to all instances of jellyfin
jellyfin2_web_subdomain: "custom2"Applies to the instance named jellyfin2
Avoid overriding variables ending in
_defaultWhen overriding variables that end in
_default(likejellyfin_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
_customvariable (likejellyfin_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.
jellyfin_instances
# Type: list
jellyfin_instances: ["jellyfin"]
Example Override
# Type: list
jellyfin_instances: ["jellyfin", "jellyfin2"]
jellyfin_role_system_settings_public_portjellyfin2_system_settings_public_port
# System
# Type: string
jellyfin_role_system_settings_public_port: "80"
# System
# Type: string
jellyfin2_system_settings_public_port: "80"
jellyfin_role_system_settings_public_https_portjellyfin2_system_settings_public_https_port
# Type: string
jellyfin_role_system_settings_public_https_port: "443"
# Type: string
jellyfin2_system_settings_public_https_port: "443"
jellyfin_role_system_settings_enable_folder_viewjellyfin2_system_settings_enable_folder_view
# Type: string
jellyfin_role_system_settings_enable_folder_view: "true"
# Type: string
jellyfin2_system_settings_enable_folder_view: "true"
jellyfin_role_system_settings_quick_connect_availablejellyfin2_system_settings_quick_connect_available
# Type: string
jellyfin_role_system_settings_quick_connect_available: "true"
# Type: string
jellyfin2_system_settings_quick_connect_available: "true"
jellyfin_role_system_settings_enable_remote_accessjellyfin2_system_settings_enable_remote_access
# Type: string
jellyfin_role_system_settings_enable_remote_access: "true"
# Type: string
jellyfin2_system_settings_enable_remote_access: "true"
jellyfin_role_system_settings_server_namejellyfin2_system_settings_server_name
# Type: string
jellyfin_role_system_settings_server_name: "saltbox"
# Type: string
jellyfin2_system_settings_server_name: "saltbox"
jellyfin_role_network_settings_public_http_portjellyfin2_network_settings_public_http_port
# Network
# Type: string
jellyfin_role_network_settings_public_http_port: "80"
# Network
# Type: string
jellyfin2_network_settings_public_http_port: "80"
jellyfin_role_network_settings_public_https_portjellyfin2_network_settings_public_https_port
# Type: string
jellyfin_role_network_settings_public_https_port: "443"
# Type: string
jellyfin2_network_settings_public_https_port: "443"
jellyfin_role_network_settings_known_proxiesjellyfin2_network_settings_known_proxies
# Type: list
jellyfin_role_network_settings_known_proxies:
- traefik
# Type: list
jellyfin2_network_settings_known_proxies:
- traefik
jellyfin_role_network_settings_published_server_uri_by_subnetjellyfin2_network_settings_published_server_uri_by_subnet
# Type: list
jellyfin_role_network_settings_published_server_uri_by_subnet:
- "external={{ lookup('role_var', '_web_url', role='jellyfin') }}:443"
# Type: list
jellyfin2_network_settings_published_server_uri_by_subnet:
- "external={{ lookup('role_var', '_web_url', role='jellyfin') }}:443"
jellyfin_role_web_subdomainjellyfin2_web_subdomain
# Type: string
jellyfin_role_web_subdomain: "{{ jellyfin_name }}"
# Type: string
jellyfin2_web_subdomain: "{{ jellyfin_name }}"
jellyfin_role_web_domainjellyfin2_web_domain
# Type: string
jellyfin_role_web_domain: "{{ user.domain }}"
# Type: string
jellyfin2_web_domain: "{{ user.domain }}"
jellyfin_role_web_portjellyfin2_web_port
# Type: string
jellyfin_role_web_port: "8096"
# Type: string
jellyfin2_web_port: "8096"
jellyfin_role_web_urljellyfin2_web_url
# Type: string
jellyfin_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='jellyfin') + '.' + lookup('role_var', '_web_domain', role='jellyfin')
if (lookup('role_var', '_web_subdomain', role='jellyfin') | length > 0)
else lookup('role_var', '_web_domain', role='jellyfin')) }}"
# Type: string
jellyfin2_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='jellyfin') + '.' + lookup('role_var', '_web_domain', role='jellyfin')
if (lookup('role_var', '_web_subdomain', role='jellyfin') | length > 0)
else lookup('role_var', '_web_domain', role='jellyfin')) }}"
jellyfin_role_dns_recordjellyfin2_dns_record
# Type: string
jellyfin_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='jellyfin') }}"
# Type: string
jellyfin2_dns_record: "{{ lookup('role_var', '_web_subdomain', role='jellyfin') }}"
jellyfin_role_dns_zonejellyfin2_dns_zone
# Type: string
jellyfin_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='jellyfin') }}"
# Type: string
jellyfin2_dns_zone: "{{ lookup('role_var', '_web_domain', role='jellyfin') }}"
jellyfin_role_dns_proxyjellyfin2_dns_proxy
# Type: bool (true/false)
jellyfin_role_dns_proxy: "{{ dns_proxied }}"
# Type: bool (true/false)
jellyfin2_dns_proxy: "{{ dns_proxied }}"
jellyfin_role_traefik_sso_middlewarejellyfin2_traefik_sso_middleware
# Type: string
jellyfin_role_traefik_sso_middleware: ""
# Type: string
jellyfin2_traefik_sso_middleware: ""
jellyfin_role_traefik_middleware_defaultjellyfin2_traefik_middleware_default
# Type: string
jellyfin_role_traefik_middleware_default: "{{ traefik_default_middleware }}"
# Type: string
jellyfin2_traefik_middleware_default: "{{ traefik_default_middleware }}"
jellyfin_role_traefik_middleware_customjellyfin2_traefik_middleware_custom
# Type: string
jellyfin_role_traefik_middleware_custom: ""
# Type: string
jellyfin2_traefik_middleware_custom: ""
jellyfin_role_traefik_certresolverjellyfin2_traefik_certresolver
# Type: string
jellyfin_role_traefik_certresolver: "{{ traefik_default_certresolver }}"
# Type: string
jellyfin2_traefik_certresolver: "{{ traefik_default_certresolver }}"
jellyfin_role_traefik_enabledjellyfin2_traefik_enabled
# Type: bool (true/false)
jellyfin_role_traefik_enabled: true
# Type: bool (true/false)
jellyfin2_traefik_enabled: true
jellyfin_role_traefik_api_enabledjellyfin2_traefik_api_enabled
# Type: bool (true/false)
jellyfin_role_traefik_api_enabled: false
# Type: bool (true/false)
jellyfin2_traefik_api_enabled: false
jellyfin_role_traefik_api_endpointjellyfin2_traefik_api_endpoint
# Type: string
jellyfin_role_traefik_api_endpoint: ""
# Type: string
jellyfin2_traefik_api_endpoint: ""
jellyfin_role_traefik_gzip_enabledjellyfin2_traefik_gzip_enabled
# Type: bool (true/false)
jellyfin_role_traefik_gzip_enabled: false
# Type: bool (true/false)
jellyfin2_traefik_gzip_enabled: false
jellyfin_role_system_settings_defaultjellyfin2_system_settings_default
# Type: list
jellyfin_role_system_settings_default:
- xpath: 'PublicPort'
value: "{{ lookup('role_var', '_system_settings_public_port', role='jellyfin') }}"
- xpath: 'PublicHttpsPort'
value: "{{ lookup('role_var', '_system_settings_public_https_port', role='jellyfin') }}"
- xpath: 'EnableFolderView'
value: "{{ lookup('role_var', '_system_settings_enable_folder_view', role='jellyfin') }}"
- xpath: 'QuickConnectAvailable'
value: "{{ lookup('role_var', '_system_settings_quick_connect_available', role='jellyfin') }}"
- xpath: 'EnableRemoteAccess'
value: "{{ lookup('role_var', '_system_settings_enable_remote_access', role='jellyfin') }}"
- xpath: 'ServerName'
value: "{{ lookup('role_var', '_system_settings_server_name', role='jellyfin') }}"
# Type: list
jellyfin2_system_settings_default:
- xpath: 'PublicPort'
value: "{{ lookup('role_var', '_system_settings_public_port', role='jellyfin') }}"
- xpath: 'PublicHttpsPort'
value: "{{ lookup('role_var', '_system_settings_public_https_port', role='jellyfin') }}"
- xpath: 'EnableFolderView'
value: "{{ lookup('role_var', '_system_settings_enable_folder_view', role='jellyfin') }}"
- xpath: 'QuickConnectAvailable'
value: "{{ lookup('role_var', '_system_settings_quick_connect_available', role='jellyfin') }}"
- xpath: 'EnableRemoteAccess'
value: "{{ lookup('role_var', '_system_settings_enable_remote_access', role='jellyfin') }}"
- xpath: 'ServerName'
value: "{{ lookup('role_var', '_system_settings_server_name', role='jellyfin') }}"
jellyfin_role_system_settings_customjellyfin2_system_settings_custom
# Type: list
jellyfin_role_system_settings_custom: []
# Type: list
jellyfin2_system_settings_custom: []
jellyfin_role_system_settings_listjellyfin2_system_settings_list
# Type: string
jellyfin_role_system_settings_list: "{{ lookup('role_var', '_system_settings_default', role='jellyfin') + lookup('role_var', '_system_settings_custom', role='jellyfin') }}"
# Type: string
jellyfin2_system_settings_list: "{{ lookup('role_var', '_system_settings_default', role='jellyfin') + lookup('role_var', '_system_settings_custom', role='jellyfin') }}"
jellyfin_role_network_settings_defaultjellyfin2_network_settings_default
# Type: list
jellyfin_role_network_settings_default:
- xpath: 'PublicPort'
value: "{{ lookup('role_var', '_network_settings_public_http_port', role='jellyfin') }}"
- xpath: 'PublicHttpsPort'
value: "{{ lookup('role_var', '_network_settings_public_https_port', role='jellyfin') }}"
- xpath: 'KnownProxies'
set_children: "{{ lookup('role_var', '_network_settings_known_proxies', role='jellyfin') | map('community.general.dict_kv', 'string') | list }}"
- xpath: 'PublishedServerUriBySubnet'
set_children: "{{ lookup('role_var', '_network_settings_published_server_uri_by_subnet', role='jellyfin') | map('community.general.dict_kv', 'string') | list }}"
# Type: list
jellyfin2_network_settings_default:
- xpath: 'PublicPort'
value: "{{ lookup('role_var', '_network_settings_public_http_port', role='jellyfin') }}"
- xpath: 'PublicHttpsPort'
value: "{{ lookup('role_var', '_network_settings_public_https_port', role='jellyfin') }}"
- xpath: 'KnownProxies'
set_children: "{{ lookup('role_var', '_network_settings_known_proxies', role='jellyfin') | map('community.general.dict_kv', 'string') | list }}"
- xpath: 'PublishedServerUriBySubnet'
set_children: "{{ lookup('role_var', '_network_settings_published_server_uri_by_subnet', role='jellyfin') | map('community.general.dict_kv', 'string') | list }}"
jellyfin_role_network_settings_customjellyfin2_network_settings_custom
# Type: list
jellyfin_role_network_settings_custom: []
# Type: list
jellyfin2_network_settings_custom: []
jellyfin_role_network_settings_listjellyfin2_network_settings_list
# Type: string
jellyfin_role_network_settings_list: "{{ lookup('role_var', '_network_settings_default', role='jellyfin') + lookup('role_var', '_network_settings_custom', role='jellyfin') }}"
# Type: string
jellyfin2_network_settings_list: "{{ lookup('role_var', '_network_settings_default', role='jellyfin') + lookup('role_var', '_network_settings_custom', role='jellyfin') }}"
Container
jellyfin_role_docker_containerjellyfin2_docker_container
# Type: string
jellyfin_role_docker_container: "{{ jellyfin_name }}"
# Type: string
jellyfin2_docker_container: "{{ jellyfin_name }}"
Image
jellyfin_role_docker_image_pulljellyfin2_docker_image_pull
# Type: bool (true/false)
jellyfin_role_docker_image_pull: true
# Type: bool (true/false)
jellyfin2_docker_image_pull: true
jellyfin_role_docker_image_repojellyfin2_docker_image_repo
# Type: string
jellyfin_role_docker_image_repo: "ghcr.io/hotio/jellyfin"
# Type: string
jellyfin2_docker_image_repo: "ghcr.io/hotio/jellyfin"
jellyfin_role_docker_image_tagjellyfin2_docker_image_tag
# Type: string
jellyfin_role_docker_image_tag: "release"
# Type: string
jellyfin2_docker_image_tag: "release"
jellyfin_role_docker_imagejellyfin2_docker_image
# Type: string
jellyfin_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='jellyfin') }}:{{ lookup('role_var', '_docker_image_tag', role='jellyfin') }}"
# Type: string
jellyfin2_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='jellyfin') }}:{{ lookup('role_var', '_docker_image_tag', role='jellyfin') }}"
Envs
jellyfin_role_docker_envs_defaultjellyfin2_docker_envs_default
# Type: dict
jellyfin_role_docker_envs_default:
PUID: "{{ uid }}"
PGID: "{{ gid }}"
TZ: "{{ tz }}"
DOTNET_USE_POLLING_FILE_WATCHER: "1"
# Type: dict
jellyfin2_docker_envs_default:
PUID: "{{ uid }}"
PGID: "{{ gid }}"
TZ: "{{ tz }}"
DOTNET_USE_POLLING_FILE_WATCHER: "1"
jellyfin_role_docker_envs_customjellyfin2_docker_envs_custom
# Type: dict
jellyfin_role_docker_envs_custom: {}
# Type: dict
jellyfin2_docker_envs_custom: {}
Volumes
jellyfin_role_docker_volumes_defaultjellyfin2_docker_volumes_default
# Type: list
jellyfin_role_docker_volumes_default:
- "{{ jellyfin_role_paths_location }}:/config:rw"
- "{{ server_appdata_path }}/scripts:/scripts"
- "/dev/shm:/dev/shm"
- "{{ jellyfin_role_paths_transcodes_location }}:/transcode"
# Type: list
jellyfin2_docker_volumes_default:
- "{{ jellyfin_role_paths_location }}:/config:rw"
- "{{ server_appdata_path }}/scripts:/scripts"
- "/dev/shm:/dev/shm"
- "{{ jellyfin_role_paths_transcodes_location }}:/transcode"
jellyfin_role_docker_volumes_legacyjellyfin2_docker_volumes_legacy
# Type: list
jellyfin_role_docker_volumes_legacy:
- "/mnt/unionfs/Media:/data"
# Type: list
jellyfin2_docker_volumes_legacy:
- "/mnt/unionfs/Media:/data"
jellyfin_role_docker_volumes_customjellyfin2_docker_volumes_custom
# Type: list
jellyfin_role_docker_volumes_custom: []
# Type: list
jellyfin2_docker_volumes_custom: []
Mounts
jellyfin_role_docker_mounts_defaultjellyfin2_docker_mounts_default
# Type: list
jellyfin_role_docker_mounts_default:
- target: /tmp
type: tmpfs
# Type: list
jellyfin2_docker_mounts_default:
- target: /tmp
type: tmpfs
jellyfin_role_docker_mounts_customjellyfin2_docker_mounts_custom
# Type: list
jellyfin_role_docker_mounts_custom: []
# Type: list
jellyfin2_docker_mounts_custom: []
Hostname
jellyfin_role_docker_hostnamejellyfin2_docker_hostname
# Type: string
jellyfin_role_docker_hostname: "{{ jellyfin_name }}"
# Type: string
jellyfin2_docker_hostname: "{{ jellyfin_name }}"
Networks
jellyfin_role_docker_networks_aliasjellyfin2_docker_networks_alias
# Type: string
jellyfin_role_docker_networks_alias: "{{ jellyfin_name }}"
# Type: string
jellyfin2_docker_networks_alias: "{{ jellyfin_name }}"
jellyfin_role_docker_networks_defaultjellyfin2_docker_networks_default
# Type: list
jellyfin_role_docker_networks_default: []
# Type: list
jellyfin2_docker_networks_default: []
jellyfin_role_docker_networks_customjellyfin2_docker_networks_custom
# Type: list
jellyfin_role_docker_networks_custom: []
# Type: list
jellyfin2_docker_networks_custom: []
Restart Policy
jellyfin_role_docker_restart_policyjellyfin2_docker_restart_policy
# Type: string
jellyfin_role_docker_restart_policy: unless-stopped
# Type: string
jellyfin2_docker_restart_policy: unless-stopped
State
jellyfin_role_docker_statejellyfin2_docker_state
# Type: string
jellyfin_role_docker_state: started
# Type: string
jellyfin2_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
jellyfin_role_docker_blkio_weightjellyfin2_docker_blkio_weight
# Type: int
jellyfin_role_docker_blkio_weight:
# Type: int
jellyfin2_docker_blkio_weight:
jellyfin_role_docker_cpu_periodjellyfin2_docker_cpu_period
# Type: int
jellyfin_role_docker_cpu_period:
# Type: int
jellyfin2_docker_cpu_period:
jellyfin_role_docker_cpu_quotajellyfin2_docker_cpu_quota
# Type: int
jellyfin_role_docker_cpu_quota:
# Type: int
jellyfin2_docker_cpu_quota:
jellyfin_role_docker_cpu_sharesjellyfin2_docker_cpu_shares
# Type: int
jellyfin_role_docker_cpu_shares:
# Type: int
jellyfin2_docker_cpu_shares:
jellyfin_role_docker_cpusjellyfin2_docker_cpus
# Type: string
jellyfin_role_docker_cpus:
# Type: string
jellyfin2_docker_cpus:
jellyfin_role_docker_cpuset_cpusjellyfin2_docker_cpuset_cpus
# Type: string
jellyfin_role_docker_cpuset_cpus:
# Type: string
jellyfin2_docker_cpuset_cpus:
jellyfin_role_docker_cpuset_memsjellyfin2_docker_cpuset_mems
# Type: string
jellyfin_role_docker_cpuset_mems:
# Type: string
jellyfin2_docker_cpuset_mems:
jellyfin_role_docker_kernel_memoryjellyfin2_docker_kernel_memory
# Type: string
jellyfin_role_docker_kernel_memory:
# Type: string
jellyfin2_docker_kernel_memory:
jellyfin_role_docker_memoryjellyfin2_docker_memory
# Type: string
jellyfin_role_docker_memory:
# Type: string
jellyfin2_docker_memory:
jellyfin_role_docker_memory_reservationjellyfin2_docker_memory_reservation
# Type: string
jellyfin_role_docker_memory_reservation:
# Type: string
jellyfin2_docker_memory_reservation:
jellyfin_role_docker_memory_swapjellyfin2_docker_memory_swap
# Type: string
jellyfin_role_docker_memory_swap:
# Type: string
jellyfin2_docker_memory_swap:
jellyfin_role_docker_memory_swappinessjellyfin2_docker_memory_swappiness
# Type: int
jellyfin_role_docker_memory_swappiness:
# Type: int
jellyfin2_docker_memory_swappiness:
jellyfin_role_docker_shm_sizejellyfin2_docker_shm_size
# Type: string
jellyfin_role_docker_shm_size:
# Type: string
jellyfin2_docker_shm_size:
Security & Devices
jellyfin_role_docker_cap_dropjellyfin2_docker_cap_drop
# Type: list
jellyfin_role_docker_cap_drop:
# Type: list
jellyfin2_docker_cap_drop:
jellyfin_role_docker_cgroupns_modejellyfin2_docker_cgroupns_mode
# Type: string
jellyfin_role_docker_cgroupns_mode:
# Type: string
jellyfin2_docker_cgroupns_mode:
jellyfin_role_docker_device_cgroup_rulesjellyfin2_docker_device_cgroup_rules
# Type: list
jellyfin_role_docker_device_cgroup_rules:
# Type: list
jellyfin2_docker_device_cgroup_rules:
jellyfin_role_docker_device_read_bpsjellyfin2_docker_device_read_bps
# Type: list
jellyfin_role_docker_device_read_bps:
# Type: list
jellyfin2_docker_device_read_bps:
jellyfin_role_docker_device_read_iopsjellyfin2_docker_device_read_iops
# Type: list
jellyfin_role_docker_device_read_iops:
# Type: list
jellyfin2_docker_device_read_iops:
jellyfin_role_docker_device_requestsjellyfin2_docker_device_requests
# Type: list
jellyfin_role_docker_device_requests:
# Type: list
jellyfin2_docker_device_requests:
jellyfin_role_docker_device_write_bpsjellyfin2_docker_device_write_bps
# Type: list
jellyfin_role_docker_device_write_bps:
# Type: list
jellyfin2_docker_device_write_bps:
jellyfin_role_docker_device_write_iopsjellyfin2_docker_device_write_iops
# Type: list
jellyfin_role_docker_device_write_iops:
# Type: list
jellyfin2_docker_device_write_iops:
jellyfin_role_docker_devicesjellyfin2_docker_devices
# Type: list
jellyfin_role_docker_devices:
# Type: list
jellyfin2_docker_devices:
jellyfin_role_docker_devices_defaultjellyfin2_docker_devices_default
# Type: string
jellyfin_role_docker_devices_default:
# Type: string
jellyfin2_docker_devices_default:
jellyfin_role_docker_groupsjellyfin2_docker_groups
# Type: list
jellyfin_role_docker_groups:
# Type: list
jellyfin2_docker_groups:
jellyfin_role_docker_privilegedjellyfin2_docker_privileged
# Type: bool (true/false)
jellyfin_role_docker_privileged:
# Type: bool (true/false)
jellyfin2_docker_privileged:
jellyfin_role_docker_security_optsjellyfin2_docker_security_opts
# Type: list
jellyfin_role_docker_security_opts:
# Type: list
jellyfin2_docker_security_opts:
jellyfin_role_docker_userjellyfin2_docker_user
# Type: string
jellyfin_role_docker_user:
# Type: string
jellyfin2_docker_user:
jellyfin_role_docker_userns_modejellyfin2_docker_userns_mode
# Type: string
jellyfin_role_docker_userns_mode:
# Type: string
jellyfin2_docker_userns_mode:
Networking
jellyfin_role_docker_dns_optsjellyfin2_docker_dns_opts
# Type: list
jellyfin_role_docker_dns_opts:
# Type: list
jellyfin2_docker_dns_opts:
jellyfin_role_docker_dns_search_domainsjellyfin2_docker_dns_search_domains
# Type: list
jellyfin_role_docker_dns_search_domains:
# Type: list
jellyfin2_docker_dns_search_domains:
jellyfin_role_docker_dns_serversjellyfin2_docker_dns_servers
# Type: list
jellyfin_role_docker_dns_servers:
# Type: list
jellyfin2_docker_dns_servers:
jellyfin_role_docker_domainnamejellyfin2_docker_domainname
# Type: string
jellyfin_role_docker_domainname:
# Type: string
jellyfin2_docker_domainname:
jellyfin_role_docker_exposed_portsjellyfin2_docker_exposed_ports
# Type: list
jellyfin_role_docker_exposed_ports:
# Type: list
jellyfin2_docker_exposed_ports:
jellyfin_role_docker_hostsjellyfin2_docker_hosts
# Type: dict
jellyfin_role_docker_hosts:
# Type: dict
jellyfin2_docker_hosts:
jellyfin_role_docker_hosts_use_commonjellyfin2_docker_hosts_use_common
# Type: bool (true/false)
jellyfin_role_docker_hosts_use_common:
# Type: bool (true/false)
jellyfin2_docker_hosts_use_common:
jellyfin_role_docker_ipc_modejellyfin2_docker_ipc_mode
# Type: string
jellyfin_role_docker_ipc_mode:
# Type: string
jellyfin2_docker_ipc_mode:
jellyfin_role_docker_linksjellyfin2_docker_links
# Type: list
jellyfin_role_docker_links:
# Type: list
jellyfin2_docker_links:
jellyfin_role_docker_network_modejellyfin2_docker_network_mode
# Type: string
jellyfin_role_docker_network_mode:
# Type: string
jellyfin2_docker_network_mode:
jellyfin_role_docker_pid_modejellyfin2_docker_pid_mode
# Type: string
jellyfin_role_docker_pid_mode:
# Type: string
jellyfin2_docker_pid_mode:
jellyfin_role_docker_portsjellyfin2_docker_ports
# Type: list
jellyfin_role_docker_ports:
# Type: list
jellyfin2_docker_ports:
jellyfin_role_docker_utsjellyfin2_docker_uts
# Type: string
jellyfin_role_docker_uts:
# Type: string
jellyfin2_docker_uts:
Storage
jellyfin_role_docker_keep_volumesjellyfin2_docker_keep_volumes
# Type: bool (true/false)
jellyfin_role_docker_keep_volumes:
# Type: bool (true/false)
jellyfin2_docker_keep_volumes:
jellyfin_role_docker_storage_optsjellyfin2_docker_storage_opts
# Type: dict
jellyfin_role_docker_storage_opts:
# Type: dict
jellyfin2_docker_storage_opts:
jellyfin_role_docker_tmpfsjellyfin2_docker_tmpfs
# Type: list
jellyfin_role_docker_tmpfs:
# Type: list
jellyfin2_docker_tmpfs:
jellyfin_role_docker_volume_driverjellyfin2_docker_volume_driver
# Type: string
jellyfin_role_docker_volume_driver:
# Type: string
jellyfin2_docker_volume_driver:
jellyfin_role_docker_volumes_fromjellyfin2_docker_volumes_from
# Type: list
jellyfin_role_docker_volumes_from:
# Type: list
jellyfin2_docker_volumes_from:
jellyfin_role_docker_volumes_globaljellyfin2_docker_volumes_global
# Type: bool (true/false)
jellyfin_role_docker_volumes_global:
# Type: bool (true/false)
jellyfin2_docker_volumes_global:
jellyfin_role_docker_working_dirjellyfin2_docker_working_dir
# Type: string
jellyfin_role_docker_working_dir:
# Type: string
jellyfin2_docker_working_dir:
Monitoring & Lifecycle
jellyfin_role_docker_auto_removejellyfin2_docker_auto_remove
# Type: bool (true/false)
jellyfin_role_docker_auto_remove:
# Type: bool (true/false)
jellyfin2_docker_auto_remove:
jellyfin_role_docker_cleanupjellyfin2_docker_cleanup
# Type: bool (true/false)
jellyfin_role_docker_cleanup:
# Type: bool (true/false)
jellyfin2_docker_cleanup:
jellyfin_role_docker_force_killjellyfin2_docker_force_kill
# Type: string
jellyfin_role_docker_force_kill:
# Type: string
jellyfin2_docker_force_kill:
jellyfin_role_docker_healthcheckjellyfin2_docker_healthcheck
# Type: dict
jellyfin_role_docker_healthcheck:
# Type: dict
jellyfin2_docker_healthcheck:
jellyfin_role_docker_healthy_wait_timeoutjellyfin2_docker_healthy_wait_timeout
# Type: int
jellyfin_role_docker_healthy_wait_timeout:
# Type: int
jellyfin2_docker_healthy_wait_timeout:
jellyfin_role_docker_initjellyfin2_docker_init
# Type: bool (true/false)
jellyfin_role_docker_init:
# Type: bool (true/false)
jellyfin2_docker_init:
jellyfin_role_docker_kill_signaljellyfin2_docker_kill_signal
# Type: string
jellyfin_role_docker_kill_signal:
# Type: string
jellyfin2_docker_kill_signal:
jellyfin_role_docker_log_driverjellyfin2_docker_log_driver
# Type: string
jellyfin_role_docker_log_driver:
# Type: string
jellyfin2_docker_log_driver:
jellyfin_role_docker_log_optionsjellyfin2_docker_log_options
# Type: dict
jellyfin_role_docker_log_options:
# Type: dict
jellyfin2_docker_log_options:
jellyfin_role_docker_oom_killerjellyfin2_docker_oom_killer
# Type: bool (true/false)
jellyfin_role_docker_oom_killer:
# Type: bool (true/false)
jellyfin2_docker_oom_killer:
jellyfin_role_docker_oom_score_adjjellyfin2_docker_oom_score_adj
# Type: int
jellyfin_role_docker_oom_score_adj:
# Type: int
jellyfin2_docker_oom_score_adj:
jellyfin_role_docker_output_logsjellyfin2_docker_output_logs
# Type: bool (true/false)
jellyfin_role_docker_output_logs:
# Type: bool (true/false)
jellyfin2_docker_output_logs:
jellyfin_role_docker_pausedjellyfin2_docker_paused
# Type: bool (true/false)
jellyfin_role_docker_paused:
# Type: bool (true/false)
jellyfin2_docker_paused:
jellyfin_role_docker_recreatejellyfin2_docker_recreate
# Type: bool (true/false)
jellyfin_role_docker_recreate:
# Type: bool (true/false)
jellyfin2_docker_recreate:
jellyfin_role_docker_restart_retriesjellyfin2_docker_restart_retries
# Type: int
jellyfin_role_docker_restart_retries:
# Type: int
jellyfin2_docker_restart_retries:
jellyfin_role_docker_stop_timeoutjellyfin2_docker_stop_timeout
# Type: int
jellyfin_role_docker_stop_timeout:
# Type: int
jellyfin2_docker_stop_timeout:
Other Options
jellyfin_role_docker_capabilitiesjellyfin2_docker_capabilities
# Type: list
jellyfin_role_docker_capabilities:
# Type: list
jellyfin2_docker_capabilities:
jellyfin_role_docker_cgroup_parentjellyfin2_docker_cgroup_parent
# Type: string
jellyfin_role_docker_cgroup_parent:
# Type: string
jellyfin2_docker_cgroup_parent:
jellyfin_role_docker_commandsjellyfin2_docker_commands
# Type: list
jellyfin_role_docker_commands:
# Type: list
jellyfin2_docker_commands:
jellyfin_role_docker_create_timeoutjellyfin2_docker_create_timeout
# Type: int
jellyfin_role_docker_create_timeout:
# Type: int
jellyfin2_docker_create_timeout:
jellyfin_role_docker_entrypointjellyfin2_docker_entrypoint
# Type: string
jellyfin_role_docker_entrypoint:
# Type: string
jellyfin2_docker_entrypoint:
jellyfin_role_docker_env_filejellyfin2_docker_env_file
# Type: string
jellyfin_role_docker_env_file:
# Type: string
jellyfin2_docker_env_file:
jellyfin_role_docker_labelsjellyfin2_docker_labels
# Type: dict
jellyfin_role_docker_labels:
# Type: dict
jellyfin2_docker_labels:
jellyfin_role_docker_labels_use_commonjellyfin2_docker_labels_use_common
# Type: bool (true/false)
jellyfin_role_docker_labels_use_common:
# Type: bool (true/false)
jellyfin2_docker_labels_use_common:
jellyfin_role_docker_read_onlyjellyfin2_docker_read_only
# Type: bool (true/false)
jellyfin_role_docker_read_only:
# Type: bool (true/false)
jellyfin2_docker_read_only:
jellyfin_role_docker_runtimejellyfin2_docker_runtime
# Type: string
jellyfin_role_docker_runtime:
# Type: string
jellyfin2_docker_runtime:
jellyfin_role_docker_sysctlsjellyfin2_docker_sysctls
# Type: list
jellyfin_role_docker_sysctls:
# Type: list
jellyfin2_docker_sysctls:
jellyfin_role_docker_ulimitsjellyfin2_docker_ulimits
# Type: list
jellyfin_role_docker_ulimits:
# Type: list
jellyfin2_docker_ulimits:
jellyfin_role_autoheal_enabledjellyfin2_autoheal_enabled
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
jellyfin_role_autoheal_enabled: true
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
jellyfin2_autoheal_enabled: true
jellyfin_role_depends_onjellyfin2_depends_on
# List of container dependencies that must be running before containers start
# Type: string
jellyfin_role_depends_on: ""
# List of container dependencies that must be running before containers start
# Type: string
jellyfin2_depends_on: ""
jellyfin_role_depends_on_delayjellyfin2_depends_on_delay
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
jellyfin_role_depends_on_delay: "0"
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
jellyfin2_depends_on_delay: "0"
jellyfin_role_depends_on_healthchecksjellyfin2_depends_on_healthchecks
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
jellyfin_role_depends_on_healthchecks:
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
jellyfin2_depends_on_healthchecks:
jellyfin_role_diun_enabledjellyfin2_diun_enabled
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
jellyfin_role_diun_enabled: true
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
jellyfin2_diun_enabled: true
jellyfin_role_dns_enabledjellyfin2_dns_enabled
# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
jellyfin_role_dns_enabled: true
# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
jellyfin2_dns_enabled: true
jellyfin_role_docker_controllerjellyfin2_docker_controller
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
jellyfin_role_docker_controller: true
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
jellyfin2_docker_controller: true
jellyfin_role_docker_image_repojellyfin2_docker_image_repo
# Type: string
jellyfin_role_docker_image_repo:
# Type: string
jellyfin2_docker_image_repo:
jellyfin_role_docker_image_tagjellyfin2_docker_image_tag
# Type: string
jellyfin_role_docker_image_tag:
# Type: string
jellyfin2_docker_image_tag:
jellyfin_role_docker_volumes_downloadjellyfin2_docker_volumes_download
# Type: bool (true/false)
jellyfin_role_docker_volumes_download:
# Type: bool (true/false)
jellyfin2_docker_volumes_download:
jellyfin_role_network_settings_customjellyfin2_network_settings_custom
# Type: string
jellyfin_role_network_settings_custom:
# Type: string
jellyfin2_network_settings_custom:
jellyfin_role_network_settings_defaultjellyfin2_network_settings_default
# Type: string
jellyfin_role_network_settings_default:
# Type: string
jellyfin2_network_settings_default:
jellyfin_role_network_settings_known_proxiesjellyfin2_network_settings_known_proxies
# Type: string
jellyfin_role_network_settings_known_proxies:
# Type: string
jellyfin2_network_settings_known_proxies:
jellyfin_role_network_settings_public_http_portjellyfin2_network_settings_public_http_port
# Type: string (quoted number)
jellyfin_role_network_settings_public_http_port:
# Type: string (quoted number)
jellyfin2_network_settings_public_http_port:
jellyfin_role_network_settings_public_https_portjellyfin2_network_settings_public_https_port
# Type: string (quoted number)
jellyfin_role_network_settings_public_https_port:
# Type: string (quoted number)
jellyfin2_network_settings_public_https_port:
jellyfin_role_network_settings_published_server_uri_by_subnetjellyfin2_network_settings_published_server_uri_by_subnet
# Type: string
jellyfin_role_network_settings_published_server_uri_by_subnet:
# Type: string
jellyfin2_network_settings_published_server_uri_by_subnet:
jellyfin_role_system_settings_customjellyfin2_system_settings_custom
# Type: string
jellyfin_role_system_settings_custom:
# Type: string
jellyfin2_system_settings_custom:
jellyfin_role_system_settings_defaultjellyfin2_system_settings_default
# Type: string
jellyfin_role_system_settings_default:
# Type: string
jellyfin2_system_settings_default:
jellyfin_role_system_settings_enable_folder_viewjellyfin2_system_settings_enable_folder_view
# Type: string
jellyfin_role_system_settings_enable_folder_view:
# Type: string
jellyfin2_system_settings_enable_folder_view:
jellyfin_role_system_settings_enable_remote_accessjellyfin2_system_settings_enable_remote_access
# Type: string
jellyfin_role_system_settings_enable_remote_access:
# Type: string
jellyfin2_system_settings_enable_remote_access:
jellyfin_role_system_settings_public_https_portjellyfin2_system_settings_public_https_port
# Type: string (quoted number)
jellyfin_role_system_settings_public_https_port:
# Type: string (quoted number)
jellyfin2_system_settings_public_https_port:
jellyfin_role_system_settings_public_portjellyfin2_system_settings_public_port
# Type: string (quoted number)
jellyfin_role_system_settings_public_port:
# Type: string (quoted number)
jellyfin2_system_settings_public_port:
jellyfin_role_system_settings_quick_connect_availablejellyfin2_system_settings_quick_connect_available
# Type: string
jellyfin_role_system_settings_quick_connect_available:
# Type: string
jellyfin2_system_settings_quick_connect_available:
jellyfin_role_system_settings_server_namejellyfin2_system_settings_server_name
# Type: string
jellyfin_role_system_settings_server_name:
# Type: string
jellyfin2_system_settings_server_name:
jellyfin_role_themepark_addonsjellyfin2_themepark_addons
# Type: string
jellyfin_role_themepark_addons:
# Type: string
jellyfin2_themepark_addons:
jellyfin_role_themepark_appjellyfin2_themepark_app
# Type: string
jellyfin_role_themepark_app:
# Type: string
jellyfin2_themepark_app:
jellyfin_role_themepark_themejellyfin2_themepark_theme
# Type: string
jellyfin_role_themepark_theme:
# Type: string
jellyfin2_themepark_theme:
jellyfin_role_traefik_api_endpointjellyfin2_traefik_api_endpoint
# Type: dict/omit
jellyfin_role_traefik_api_endpoint:
# Type: dict/omit
jellyfin2_traefik_api_endpoint:
jellyfin_role_traefik_api_middlewarejellyfin2_traefik_api_middleware
# Type: string
jellyfin_role_traefik_api_middleware:
# Type: string
jellyfin2_traefik_api_middleware:
jellyfin_role_traefik_api_middleware_httpjellyfin2_traefik_api_middleware_http
# Type: string
jellyfin_role_traefik_api_middleware_http:
# Type: string
jellyfin2_traefik_api_middleware_http:
jellyfin_role_traefik_autodetect_enabledjellyfin2_traefik_autodetect_enabled
# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
jellyfin_role_traefik_autodetect_enabled: false
# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
jellyfin2_traefik_autodetect_enabled: false
jellyfin_role_traefik_certresolverjellyfin2_traefik_certresolver
# Type: string
jellyfin_role_traefik_certresolver:
# Type: string
jellyfin2_traefik_certresolver:
jellyfin_role_traefik_crowdsec_enabledjellyfin2_traefik_crowdsec_enabled
# Enable CrowdSec middleware for containers
# Type: bool (true/false)
jellyfin_role_traefik_crowdsec_enabled: false
# Enable CrowdSec middleware for containers
# Type: bool (true/false)
jellyfin2_traefik_crowdsec_enabled: false
jellyfin_role_traefik_error_pages_enabledjellyfin2_traefik_error_pages_enabled
# Enable custom error pages middleware for containers
# Type: bool (true/false)
jellyfin_role_traefik_error_pages_enabled: false
# Enable custom error pages middleware for containers
# Type: bool (true/false)
jellyfin2_traefik_error_pages_enabled: false
jellyfin_role_traefik_gzip_enabledjellyfin2_traefik_gzip_enabled
# Enable gzip compression middleware for containers
# Type: bool (true/false)
jellyfin_role_traefik_gzip_enabled: false
# Enable gzip compression middleware for containers
# Type: bool (true/false)
jellyfin2_traefik_gzip_enabled: false
jellyfin_role_traefik_middleware_httpjellyfin2_traefik_middleware_http
# Type: string
jellyfin_role_traefik_middleware_http:
# Type: string
jellyfin2_traefik_middleware_http:
jellyfin_role_traefik_middleware_http_api_insecurejellyfin2_traefik_middleware_http_api_insecure
# Type: bool (true/false)
jellyfin_role_traefik_middleware_http_api_insecure:
# Type: bool (true/false)
jellyfin2_traefik_middleware_http_api_insecure:
jellyfin_role_traefik_middleware_http_insecurejellyfin2_traefik_middleware_http_insecure
# Type: bool (true/false)
jellyfin_role_traefik_middleware_http_insecure:
# Type: bool (true/false)
jellyfin2_traefik_middleware_http_insecure:
jellyfin_role_traefik_priorityjellyfin2_traefik_priority
# Type: string
jellyfin_role_traefik_priority:
# Type: string
jellyfin2_traefik_priority:
jellyfin_role_traefik_robot_enabledjellyfin2_traefik_robot_enabled
# Enable robots.txt middleware for containers
# Type: bool (true/false)
jellyfin_role_traefik_robot_enabled: true
# Enable robots.txt middleware for containers
# Type: bool (true/false)
jellyfin2_traefik_robot_enabled: true
jellyfin_role_traefik_tailscale_enabledjellyfin2_traefik_tailscale_enabled
# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
jellyfin_role_traefik_tailscale_enabled: false
# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
jellyfin2_traefik_tailscale_enabled: false
jellyfin_role_traefik_wildcard_enabledjellyfin2_traefik_wildcard_enabled
# Enable wildcard certificate for containers
# Type: bool (true/false)
jellyfin_role_traefik_wildcard_enabled: true
# Enable wildcard certificate for containers
# Type: bool (true/false)
jellyfin2_traefik_wildcard_enabled: true
jellyfin_role_web_domainjellyfin2_web_domain
# Type: string
jellyfin_role_web_domain:
# Type: string
jellyfin2_web_domain:
jellyfin_role_web_fqdn_overridejellyfin2_web_fqdn_override
# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
jellyfin_role_web_fqdn_override:
# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
jellyfin2_web_fqdn_override:
Example Override
jellyfin_role_web_fqdn_override:
- "{{ traefik_host }}"
- "jellyfin2.{{ user.domain }}"
- "jellyfin.otherdomain.tld"
Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries
Example Override
jellyfin2_web_fqdn_override:
- "{{ traefik_host }}"
- "jellyfin2.{{ user.domain }}"
- "jellyfin.otherdomain.tld"
Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries
jellyfin_role_web_host_overridejellyfin2_web_host_override
# Override the Traefik web host configuration for containers
# Type: string
jellyfin_role_web_host_override:
# Override the Traefik web host configuration for containers
# Type: string
jellyfin2_web_host_override:
Example Override
jellyfin_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'jellyfin2.' + user.domain }}`)"
Note: Use {{ traefik_host }} to include the default host configuration in your custom rule
Example Override
jellyfin2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'jellyfin2.' + user.domain }}`)"
Note: Use {{ traefik_host }} to include the default host configuration in your custom rule
jellyfin_role_web_http_portjellyfin2_web_http_port
# Type: string (quoted number)
jellyfin_role_web_http_port:
# Type: string (quoted number)
jellyfin2_web_http_port:
jellyfin_role_web_http_schemejellyfin2_web_http_scheme
# Type: string ("http"/"https")
jellyfin_role_web_http_scheme:
# Type: string ("http"/"https")
jellyfin2_web_http_scheme:
jellyfin_role_web_http_serverstransportjellyfin2_web_http_serverstransport
# Type: dict/omit
jellyfin_role_web_http_serverstransport:
# Type: dict/omit
jellyfin2_web_http_serverstransport:
jellyfin_role_web_schemejellyfin2_web_scheme
# URL scheme to use for web access to containers
# Type: string ("http"/"https")
jellyfin_role_web_scheme:
# URL scheme to use for web access to containers
# Type: string ("http"/"https")
jellyfin2_web_scheme:
jellyfin_role_web_serverstransportjellyfin2_web_serverstransport
# Type: dict/omit
jellyfin_role_web_serverstransport:
# Type: dict/omit
jellyfin2_web_serverstransport:
jellyfin_role_web_subdomainjellyfin2_web_subdomain
# Type: string
jellyfin_role_web_subdomain:
# Type: string
jellyfin2_web_subdomain:
jellyfin_role_web_urljellyfin2_web_url
# Type: string
jellyfin_role_web_url:
# Type: string
jellyfin2_web_url: