Overseerr¶

Description / name	Input element
Your domain name

Overview¶

Overseerr is a free and open-source request management and media discovery tool designed to work with the Plex ecosystem.

Manual

Releases

Community

Saltbox Setup Process

Opting out of Plex Media Server?
Opting for another requests manager?

Explore alternatives

Skip to Portainer

Deployment¶

sb install overseerr

Usage¶

Visit https://overseerr.iYOUR_DOMAIN_NAMEi.

Basics¶

Settings¶

This setup needs to take place AFTER you've set up Plex, Radarr, and Sonarr, since it involves connections to all three of those.

You will need your API Keys from both Radarr and Sonarr.

Click "Sign In" and sign into your Plex account.

Click the "refresh" icon, then select your Plex server from the dropdown. Click "Save Changes" to retrieve the libraries from Plex.

Scroll down and flip the switch on the libraries you want to expose for requests and discovery. Click "Continue".

Click "Add Radarr Server".

On this screen:
1. Check "Default server"
2. Enter a name
3. Enter radarr as the hostname
4. Enter your Radarr API Key
5. Click "Test" to connect to Radarr and retrieve Quality Profiles, etc.

Select a Quality, Root Folder, and Minimum Availability, then click "Add Server". This will return you to the screen from the previous step. Click "Add Sonarr Server"

On this screen:
1. Check "Default server"
2. Enter a name
3. Enter sonarr as the hostname
4. Enter your Sonarr API Key
5. Scroll down and click "Test" to connect to Sonarr and retrieve Quality Profiles, etc.

Select a Quality, Root Folder, and Minimum Availability for standard and Anime series. Click "Add Server".

Click "Finish Setup"

Click "Settings" over on the left.

Click "Users" on the left, then "Import Users From Plex"

Setup is complete.

Next¶

Are you setting Saltbox up for the first time?

Continue to Portainer

Role Defaults¶

Use the Inventory to customize variables. (1)

This role supports multiple instances via overseerr_instances.
Example override
Role-levelInstance-level
overseerr_role_web_subdomain: "custom"

Applies to all instances of overseerr
overseerr2_web_subdomain: "custom2"

Applies to the instance named overseerr2
Avoid overriding variables ending in _default

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

BasicsSettingsWebDNSTraefikThemeDockerDocker+Global Override Options

overseerr_instances

# Type: list
overseerr_instances: ["overseerr"]

Example Override

# Type: list
overseerr_instances: ["overseerr", "overseerr2"]

overseerr_role_log_leveloverseerr2_log_level

# Type: string
overseerr_role_log_level: "info"

# Type: string
overseerr2_log_level: "info"

overseerr_role_web_subdomainoverseerr2_web_subdomain

# Type: string
overseerr_role_web_subdomain: "{{ overseerr_name }}"

# Type: string
overseerr2_web_subdomain: "{{ overseerr_name }}"

overseerr_role_web_domainoverseerr2_web_domain

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

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

overseerr_role_web_portoverseerr2_web_port

# Type: string
overseerr_role_web_port: "5055"

# Type: string
overseerr2_web_port: "5055"

overseerr_role_web_urloverseerr2_web_url

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

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

overseerr_role_dns_recordoverseerr2_dns_record

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

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

overseerr_role_dns_zoneoverseerr2_dns_zone

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

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

overseerr_role_dns_proxyoverseerr2_dns_proxy

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

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

overseerr_role_traefik_sso_middlewareoverseerr2_traefik_sso_middleware

# Type: string
overseerr_role_traefik_sso_middleware: ""

# Type: string
overseerr2_traefik_sso_middleware: ""

overseerr_role_traefik_middleware_defaultoverseerr2_traefik_middleware_default

# Type: string
overseerr_role_traefik_middleware_default: "{{ traefik_default_middleware
                                               + (',themepark-' + overseerr_name
                                                 if (lookup('role_var', '_themepark_enabled', role='overseerr') and global_themepark_plugin_enabled)
                                                 else '') }}"

# Type: string
overseerr2_traefik_middleware_default: "{{ traefik_default_middleware
                                           + (',themepark-' + overseerr_name
                                             if (lookup('role_var', '_themepark_enabled', role='overseerr') and global_themepark_plugin_enabled)
                                             else '') }}"

overseerr_role_traefik_middleware_customoverseerr2_traefik_middleware_custom

# Type: string
overseerr_role_traefik_middleware_custom: ""

# Type: string
overseerr2_traefik_middleware_custom: ""

overseerr_role_traefik_certresolveroverseerr2_traefik_certresolver

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

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

overseerr_role_traefik_enabledoverseerr2_traefik_enabled

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

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

overseerr_role_traefik_api_enabledoverseerr2_traefik_api_enabled

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

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

overseerr_role_traefik_api_endpointoverseerr2_traefik_api_endpoint

# Type: string
overseerr_role_traefik_api_endpoint: ""

# Type: string
overseerr2_traefik_api_endpoint: ""

overseerr_role_themepark_enabledoverseerr2_themepark_enabled

# Options can be found at https://github.com/themepark-dev/theme.park
# Type: bool (true/false)
overseerr_role_themepark_enabled: false

# Options can be found at https://github.com/themepark-dev/theme.park
# Type: bool (true/false)
overseerr2_themepark_enabled: false

overseerr_role_themepark_appoverseerr2_themepark_app

# Type: string
overseerr_role_themepark_app: "overseerr"

# Type: string
overseerr2_themepark_app: "overseerr"

overseerr_role_themepark_themeoverseerr2_themepark_theme

# Type: string
overseerr_role_themepark_theme: "{{ global_themepark_theme }}"

# Type: string
overseerr2_themepark_theme: "{{ global_themepark_theme }}"

overseerr_role_themepark_domainoverseerr2_themepark_domain

# Type: string
overseerr_role_themepark_domain: "{{ global_themepark_domain }}"

# Type: string
overseerr2_themepark_domain: "{{ global_themepark_domain }}"

overseerr_role_themepark_addonsoverseerr2_themepark_addons

# Type: list
overseerr_role_themepark_addons: []

# Type: list
overseerr2_themepark_addons: []

Container

overseerr_role_docker_containeroverseerr2_docker_container

# Type: string
overseerr_role_docker_container: "{{ overseerr_name }}"

# Type: string
overseerr2_docker_container: "{{ overseerr_name }}"

Image

overseerr_role_docker_image_pulloverseerr2_docker_image_pull

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

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

overseerr_role_docker_image_repooverseerr2_docker_image_repo

# Type: string
overseerr_role_docker_image_repo: "sctx/overseerr"

# Type: string
overseerr2_docker_image_repo: "sctx/overseerr"

overseerr_role_docker_image_tagoverseerr2_docker_image_tag

# Type: string
overseerr_role_docker_image_tag: "latest"

# Type: string
overseerr2_docker_image_tag: "latest"

overseerr_role_docker_imageoverseerr2_docker_image

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

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

Envs

overseerr_role_docker_envs_defaultoverseerr2_docker_envs_default

# Type: dict
overseerr_role_docker_envs_default:
  UMASK: "002"
  TZ: "{{ tz }}"
  LOG_LEVEL: "{{ lookup('role_var', '_log_level', role='overseerr') }}"

# Type: dict
overseerr2_docker_envs_default:
  UMASK: "002"
  TZ: "{{ tz }}"
  LOG_LEVEL: "{{ lookup('role_var', '_log_level', role='overseerr') }}"

overseerr_role_docker_envs_customoverseerr2_docker_envs_custom

# Type: dict
overseerr_role_docker_envs_custom: {}

# Type: dict
overseerr2_docker_envs_custom: {}

Volumes

overseerr_role_docker_volumes_defaultoverseerr2_docker_volumes_default

# Type: list
overseerr_role_docker_volumes_default:
  - "{{ overseerr_role_paths_location }}:/app/config"

# Type: list
overseerr2_docker_volumes_default:
  - "{{ overseerr_role_paths_location }}:/app/config"

overseerr_role_docker_volumes_customoverseerr2_docker_volumes_custom

# Type: list
overseerr_role_docker_volumes_custom: []

# Type: list
overseerr2_docker_volumes_custom: []

Labels

overseerr_role_docker_labels_defaultoverseerr2_docker_labels_default

# Type: dict
overseerr_role_docker_labels_default: {}

# Type: dict
overseerr2_docker_labels_default: {}

overseerr_role_docker_labels_customoverseerr2_docker_labels_custom

# Type: dict
overseerr_role_docker_labels_custom: {}

# Type: dict
overseerr2_docker_labels_custom: {}

Hostname

overseerr_role_docker_hostnameoverseerr2_docker_hostname

# Type: string
overseerr_role_docker_hostname: "{{ overseerr_name }}"

# Type: string
overseerr2_docker_hostname: "{{ overseerr_name }}"

Networks

overseerr_role_docker_networks_aliasoverseerr2_docker_networks_alias

# Type: string
overseerr_role_docker_networks_alias: "{{ overseerr_name }}"

# Type: string
overseerr2_docker_networks_alias: "{{ overseerr_name }}"

overseerr_role_docker_networks_defaultoverseerr2_docker_networks_default

# Type: list
overseerr_role_docker_networks_default: []

# Type: list
overseerr2_docker_networks_default: []

overseerr_role_docker_networks_customoverseerr2_docker_networks_custom

# Type: list
overseerr_role_docker_networks_custom: []

# Type: list
overseerr2_docker_networks_custom: []

Restart Policy

overseerr_role_docker_restart_policyoverseerr2_docker_restart_policy

# Type: string
overseerr_role_docker_restart_policy: unless-stopped

# Type: string
overseerr2_docker_restart_policy: unless-stopped

State

overseerr_role_docker_stateoverseerr2_docker_state

# Type: string
overseerr_role_docker_state: started

# Type: string
overseerr2_docker_state: started

User

overseerr_role_docker_useroverseerr2_docker_user

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

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

overseerr_role_docker_blkio_weightoverseerr2_docker_blkio_weight

# Type: int
overseerr_role_docker_blkio_weight:

# Type: int
overseerr2_docker_blkio_weight:

overseerr_role_docker_cpu_periodoverseerr2_docker_cpu_period

# Type: int
overseerr_role_docker_cpu_period:

# Type: int
overseerr2_docker_cpu_period:

overseerr_role_docker_cpu_quotaoverseerr2_docker_cpu_quota

# Type: int
overseerr_role_docker_cpu_quota:

# Type: int
overseerr2_docker_cpu_quota:

overseerr_role_docker_cpu_sharesoverseerr2_docker_cpu_shares

# Type: int
overseerr_role_docker_cpu_shares:

# Type: int
overseerr2_docker_cpu_shares:

overseerr_role_docker_cpusoverseerr2_docker_cpus

# Type: string
overseerr_role_docker_cpus:

# Type: string
overseerr2_docker_cpus:

overseerr_role_docker_cpuset_cpusoverseerr2_docker_cpuset_cpus

# Type: string
overseerr_role_docker_cpuset_cpus:

# Type: string
overseerr2_docker_cpuset_cpus:

overseerr_role_docker_cpuset_memsoverseerr2_docker_cpuset_mems

# Type: string
overseerr_role_docker_cpuset_mems:

# Type: string
overseerr2_docker_cpuset_mems:

overseerr_role_docker_kernel_memoryoverseerr2_docker_kernel_memory

# Type: string
overseerr_role_docker_kernel_memory:

# Type: string
overseerr2_docker_kernel_memory:

overseerr_role_docker_memoryoverseerr2_docker_memory

# Type: string
overseerr_role_docker_memory:

# Type: string
overseerr2_docker_memory:

overseerr_role_docker_memory_reservationoverseerr2_docker_memory_reservation

# Type: string
overseerr_role_docker_memory_reservation:

# Type: string
overseerr2_docker_memory_reservation:

overseerr_role_docker_memory_swapoverseerr2_docker_memory_swap

# Type: string
overseerr_role_docker_memory_swap:

# Type: string
overseerr2_docker_memory_swap:

overseerr_role_docker_memory_swappinessoverseerr2_docker_memory_swappiness

# Type: int
overseerr_role_docker_memory_swappiness:

# Type: int
overseerr2_docker_memory_swappiness:

overseerr_role_docker_shm_sizeoverseerr2_docker_shm_size

# Type: string
overseerr_role_docker_shm_size:

# Type: string
overseerr2_docker_shm_size:

Security & Devices

overseerr_role_docker_cap_dropoverseerr2_docker_cap_drop

# Type: list
overseerr_role_docker_cap_drop:

# Type: list
overseerr2_docker_cap_drop:

overseerr_role_docker_cgroupns_modeoverseerr2_docker_cgroupns_mode

# Type: string
overseerr_role_docker_cgroupns_mode:

# Type: string
overseerr2_docker_cgroupns_mode:

overseerr_role_docker_device_cgroup_rulesoverseerr2_docker_device_cgroup_rules

# Type: list
overseerr_role_docker_device_cgroup_rules:

# Type: list
overseerr2_docker_device_cgroup_rules:

overseerr_role_docker_device_read_bpsoverseerr2_docker_device_read_bps

# Type: list
overseerr_role_docker_device_read_bps:

# Type: list
overseerr2_docker_device_read_bps:

overseerr_role_docker_device_read_iopsoverseerr2_docker_device_read_iops

# Type: list
overseerr_role_docker_device_read_iops:

# Type: list
overseerr2_docker_device_read_iops:

overseerr_role_docker_device_requestsoverseerr2_docker_device_requests

# Type: list
overseerr_role_docker_device_requests:

# Type: list
overseerr2_docker_device_requests:

overseerr_role_docker_device_write_bpsoverseerr2_docker_device_write_bps

# Type: list
overseerr_role_docker_device_write_bps:

# Type: list
overseerr2_docker_device_write_bps:

overseerr_role_docker_device_write_iopsoverseerr2_docker_device_write_iops

# Type: list
overseerr_role_docker_device_write_iops:

# Type: list
overseerr2_docker_device_write_iops:

overseerr_role_docker_devicesoverseerr2_docker_devices

# Type: list
overseerr_role_docker_devices:

# Type: list
overseerr2_docker_devices:

overseerr_role_docker_devices_defaultoverseerr2_docker_devices_default

# Type: string
overseerr_role_docker_devices_default:

# Type: string
overseerr2_docker_devices_default:

overseerr_role_docker_groupsoverseerr2_docker_groups

# Type: list
overseerr_role_docker_groups:

# Type: list
overseerr2_docker_groups:

overseerr_role_docker_privilegedoverseerr2_docker_privileged

# Type: bool (true/false)
overseerr_role_docker_privileged:

# Type: bool (true/false)
overseerr2_docker_privileged:

overseerr_role_docker_security_optsoverseerr2_docker_security_opts

# Type: list
overseerr_role_docker_security_opts:

# Type: list
overseerr2_docker_security_opts:

overseerr_role_docker_userns_modeoverseerr2_docker_userns_mode

# Type: string
overseerr_role_docker_userns_mode:

# Type: string
overseerr2_docker_userns_mode:

Networking

overseerr_role_docker_dns_optsoverseerr2_docker_dns_opts

# Type: list
overseerr_role_docker_dns_opts:

# Type: list
overseerr2_docker_dns_opts:

overseerr_role_docker_dns_search_domainsoverseerr2_docker_dns_search_domains

# Type: list
overseerr_role_docker_dns_search_domains:

# Type: list
overseerr2_docker_dns_search_domains:

overseerr_role_docker_dns_serversoverseerr2_docker_dns_servers

# Type: list
overseerr_role_docker_dns_servers:

# Type: list
overseerr2_docker_dns_servers:

overseerr_role_docker_domainnameoverseerr2_docker_domainname

# Type: string
overseerr_role_docker_domainname:

# Type: string
overseerr2_docker_domainname:

overseerr_role_docker_exposed_portsoverseerr2_docker_exposed_ports

# Type: list
overseerr_role_docker_exposed_ports:

# Type: list
overseerr2_docker_exposed_ports:

overseerr_role_docker_hostsoverseerr2_docker_hosts

# Type: dict
overseerr_role_docker_hosts:

# Type: dict
overseerr2_docker_hosts:

overseerr_role_docker_hosts_use_commonoverseerr2_docker_hosts_use_common

# Type: bool (true/false)
overseerr_role_docker_hosts_use_common:

# Type: bool (true/false)
overseerr2_docker_hosts_use_common:

overseerr_role_docker_ipc_modeoverseerr2_docker_ipc_mode

# Type: string
overseerr_role_docker_ipc_mode:

# Type: string
overseerr2_docker_ipc_mode:

overseerr_role_docker_linksoverseerr2_docker_links

# Type: list
overseerr_role_docker_links:

# Type: list
overseerr2_docker_links:

overseerr_role_docker_network_modeoverseerr2_docker_network_mode

# Type: string
overseerr_role_docker_network_mode:

# Type: string
overseerr2_docker_network_mode:

overseerr_role_docker_pid_modeoverseerr2_docker_pid_mode

# Type: string
overseerr_role_docker_pid_mode:

# Type: string
overseerr2_docker_pid_mode:

overseerr_role_docker_portsoverseerr2_docker_ports

# Type: list
overseerr_role_docker_ports:

# Type: list
overseerr2_docker_ports:

overseerr_role_docker_utsoverseerr2_docker_uts

# Type: string
overseerr_role_docker_uts:

# Type: string
overseerr2_docker_uts:

Storage

overseerr_role_docker_keep_volumesoverseerr2_docker_keep_volumes

# Type: bool (true/false)
overseerr_role_docker_keep_volumes:

# Type: bool (true/false)
overseerr2_docker_keep_volumes:

overseerr_role_docker_mountsoverseerr2_docker_mounts

# Type: list
overseerr_role_docker_mounts:

# Type: list
overseerr2_docker_mounts:

overseerr_role_docker_storage_optsoverseerr2_docker_storage_opts

# Type: dict
overseerr_role_docker_storage_opts:

# Type: dict
overseerr2_docker_storage_opts:

overseerr_role_docker_tmpfsoverseerr2_docker_tmpfs

# Type: list
overseerr_role_docker_tmpfs:

# Type: list
overseerr2_docker_tmpfs:

overseerr_role_docker_volume_driveroverseerr2_docker_volume_driver

# Type: string
overseerr_role_docker_volume_driver:

# Type: string
overseerr2_docker_volume_driver:

overseerr_role_docker_volumes_fromoverseerr2_docker_volumes_from

# Type: list
overseerr_role_docker_volumes_from:

# Type: list
overseerr2_docker_volumes_from:

overseerr_role_docker_volumes_globaloverseerr2_docker_volumes_global

# Type: bool (true/false)
overseerr_role_docker_volumes_global:

# Type: bool (true/false)
overseerr2_docker_volumes_global:

overseerr_role_docker_working_diroverseerr2_docker_working_dir

# Type: string
overseerr_role_docker_working_dir:

# Type: string
overseerr2_docker_working_dir:

Monitoring & Lifecycle

overseerr_role_docker_auto_removeoverseerr2_docker_auto_remove

# Type: bool (true/false)
overseerr_role_docker_auto_remove:

# Type: bool (true/false)
overseerr2_docker_auto_remove:

overseerr_role_docker_cleanupoverseerr2_docker_cleanup

# Type: bool (true/false)
overseerr_role_docker_cleanup:

# Type: bool (true/false)
overseerr2_docker_cleanup:

overseerr_role_docker_force_killoverseerr2_docker_force_kill

# Type: string
overseerr_role_docker_force_kill:

# Type: string
overseerr2_docker_force_kill:

overseerr_role_docker_healthcheckoverseerr2_docker_healthcheck

# Type: dict
overseerr_role_docker_healthcheck:

# Type: dict
overseerr2_docker_healthcheck:

overseerr_role_docker_healthy_wait_timeoutoverseerr2_docker_healthy_wait_timeout

# Type: int
overseerr_role_docker_healthy_wait_timeout:

# Type: int
overseerr2_docker_healthy_wait_timeout:

overseerr_role_docker_initoverseerr2_docker_init

# Type: bool (true/false)
overseerr_role_docker_init:

# Type: bool (true/false)
overseerr2_docker_init:

overseerr_role_docker_kill_signaloverseerr2_docker_kill_signal

# Type: string
overseerr_role_docker_kill_signal:

# Type: string
overseerr2_docker_kill_signal:

overseerr_role_docker_log_driveroverseerr2_docker_log_driver

# Type: string
overseerr_role_docker_log_driver:

# Type: string
overseerr2_docker_log_driver:

overseerr_role_docker_log_optionsoverseerr2_docker_log_options

# Type: dict
overseerr_role_docker_log_options:

# Type: dict
overseerr2_docker_log_options:

overseerr_role_docker_oom_killeroverseerr2_docker_oom_killer

# Type: bool (true/false)
overseerr_role_docker_oom_killer:

# Type: bool (true/false)
overseerr2_docker_oom_killer:

overseerr_role_docker_oom_score_adjoverseerr2_docker_oom_score_adj

# Type: int
overseerr_role_docker_oom_score_adj:

# Type: int
overseerr2_docker_oom_score_adj:

overseerr_role_docker_output_logsoverseerr2_docker_output_logs

# Type: bool (true/false)
overseerr_role_docker_output_logs:

# Type: bool (true/false)
overseerr2_docker_output_logs:

overseerr_role_docker_pausedoverseerr2_docker_paused

# Type: bool (true/false)
overseerr_role_docker_paused:

# Type: bool (true/false)
overseerr2_docker_paused:

overseerr_role_docker_recreateoverseerr2_docker_recreate

# Type: bool (true/false)
overseerr_role_docker_recreate:

# Type: bool (true/false)
overseerr2_docker_recreate:

overseerr_role_docker_restart_retriesoverseerr2_docker_restart_retries

# Type: int
overseerr_role_docker_restart_retries:

# Type: int
overseerr2_docker_restart_retries:

overseerr_role_docker_stop_timeoutoverseerr2_docker_stop_timeout

# Type: int
overseerr_role_docker_stop_timeout:

# Type: int
overseerr2_docker_stop_timeout:

Other Options

overseerr_role_docker_capabilitiesoverseerr2_docker_capabilities

# Type: list
overseerr_role_docker_capabilities:

# Type: list
overseerr2_docker_capabilities:

overseerr_role_docker_cgroup_parentoverseerr2_docker_cgroup_parent

# Type: string
overseerr_role_docker_cgroup_parent:

# Type: string
overseerr2_docker_cgroup_parent:

overseerr_role_docker_commandsoverseerr2_docker_commands

# Type: list
overseerr_role_docker_commands:

# Type: list
overseerr2_docker_commands:

overseerr_role_docker_create_timeoutoverseerr2_docker_create_timeout

# Type: int
overseerr_role_docker_create_timeout:

# Type: int
overseerr2_docker_create_timeout:

overseerr_role_docker_entrypointoverseerr2_docker_entrypoint

# Type: string
overseerr_role_docker_entrypoint:

# Type: string
overseerr2_docker_entrypoint:

overseerr_role_docker_env_fileoverseerr2_docker_env_file

# Type: string
overseerr_role_docker_env_file:

# Type: string
overseerr2_docker_env_file:

overseerr_role_docker_labels_use_commonoverseerr2_docker_labels_use_common

# Type: bool (true/false)
overseerr_role_docker_labels_use_common:

# Type: bool (true/false)
overseerr2_docker_labels_use_common:

overseerr_role_docker_read_onlyoverseerr2_docker_read_only

# Type: bool (true/false)
overseerr_role_docker_read_only:

# Type: bool (true/false)
overseerr2_docker_read_only:

overseerr_role_docker_runtimeoverseerr2_docker_runtime

# Type: string
overseerr_role_docker_runtime:

# Type: string
overseerr2_docker_runtime:

overseerr_role_docker_sysctlsoverseerr2_docker_sysctls

# Type: list
overseerr_role_docker_sysctls:

# Type: list
overseerr2_docker_sysctls:

overseerr_role_docker_ulimitsoverseerr2_docker_ulimits

# Type: list
overseerr_role_docker_ulimits:

# Type: list
overseerr2_docker_ulimits:

overseerr_role_autoheal_enabledoverseerr2_autoheal_enabled

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

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

overseerr_role_depends_onoverseerr2_depends_on

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

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

overseerr_role_depends_on_delayoverseerr2_depends_on_delay

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

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

overseerr_role_depends_on_healthchecksoverseerr2_depends_on_healthchecks

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

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

overseerr_role_diun_enabledoverseerr2_diun_enabled

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

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

overseerr_role_dns_enabledoverseerr2_dns_enabled

# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
overseerr_role_dns_enabled: true

# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
overseerr2_dns_enabled: true

overseerr_role_docker_controlleroverseerr2_docker_controller

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

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

overseerr_role_docker_image_repooverseerr2_docker_image_repo

# Type: string
overseerr_role_docker_image_repo:

# Type: string
overseerr2_docker_image_repo:

overseerr_role_docker_image_tagoverseerr2_docker_image_tag

# Type: string
overseerr_role_docker_image_tag:

# Type: string
overseerr2_docker_image_tag:

overseerr_role_docker_volumes_downloadoverseerr2_docker_volumes_download

# Type: bool (true/false)
overseerr_role_docker_volumes_download:

# Type: bool (true/false)
overseerr2_docker_volumes_download:

overseerr_role_log_leveloverseerr2_log_level

# Type: string
overseerr_role_log_level:

# Type: string
overseerr2_log_level:

overseerr_role_themepark_addonsoverseerr2_themepark_addons

# Type: string
overseerr_role_themepark_addons:

# Type: string
overseerr2_themepark_addons:

overseerr_role_themepark_appoverseerr2_themepark_app

# Type: string
overseerr_role_themepark_app:

# Type: string
overseerr2_themepark_app:

overseerr_role_themepark_enabledoverseerr2_themepark_enabled

# Type: bool (true/false)
overseerr_role_themepark_enabled:

# Type: bool (true/false)
overseerr2_themepark_enabled:

overseerr_role_themepark_themeoverseerr2_themepark_theme

# Type: string
overseerr_role_themepark_theme:

# Type: string
overseerr2_themepark_theme:

overseerr_role_traefik_api_endpointoverseerr2_traefik_api_endpoint

# Type: dict/omit
overseerr_role_traefik_api_endpoint:

# Type: dict/omit
overseerr2_traefik_api_endpoint:

overseerr_role_traefik_api_middlewareoverseerr2_traefik_api_middleware

# Type: string
overseerr_role_traefik_api_middleware:

# Type: string
overseerr2_traefik_api_middleware:

overseerr_role_traefik_api_middleware_httpoverseerr2_traefik_api_middleware_http

# Type: string
overseerr_role_traefik_api_middleware_http:

# Type: string
overseerr2_traefik_api_middleware_http:

overseerr_role_traefik_autodetect_enabledoverseerr2_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
overseerr_role_traefik_autodetect_enabled: false

# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
overseerr2_traefik_autodetect_enabled: false

overseerr_role_traefik_certresolveroverseerr2_traefik_certresolver

# Type: string
overseerr_role_traefik_certresolver:

# Type: string
overseerr2_traefik_certresolver:

overseerr_role_traefik_crowdsec_enabledoverseerr2_traefik_crowdsec_enabled

# Enable CrowdSec middleware for containers
# Type: bool (true/false)
overseerr_role_traefik_crowdsec_enabled: false

# Enable CrowdSec middleware for containers
# Type: bool (true/false)
overseerr2_traefik_crowdsec_enabled: false

overseerr_role_traefik_error_pages_enabledoverseerr2_traefik_error_pages_enabled

# Enable custom error pages middleware for containers
# Type: bool (true/false)
overseerr_role_traefik_error_pages_enabled: false

# Enable custom error pages middleware for containers
# Type: bool (true/false)
overseerr2_traefik_error_pages_enabled: false

overseerr_role_traefik_gzip_enabledoverseerr2_traefik_gzip_enabled

# Enable gzip compression middleware for containers
# Type: bool (true/false)
overseerr_role_traefik_gzip_enabled: false

# Enable gzip compression middleware for containers
# Type: bool (true/false)
overseerr2_traefik_gzip_enabled: false

overseerr_role_traefik_middleware_httpoverseerr2_traefik_middleware_http

# Type: string
overseerr_role_traefik_middleware_http:

# Type: string
overseerr2_traefik_middleware_http:

overseerr_role_traefik_middleware_http_api_insecureoverseerr2_traefik_middleware_http_api_insecure

# Type: bool (true/false)
overseerr_role_traefik_middleware_http_api_insecure:

# Type: bool (true/false)
overseerr2_traefik_middleware_http_api_insecure:

overseerr_role_traefik_middleware_http_insecureoverseerr2_traefik_middleware_http_insecure

# Type: bool (true/false)
overseerr_role_traefik_middleware_http_insecure:

# Type: bool (true/false)
overseerr2_traefik_middleware_http_insecure:

overseerr_role_traefik_priorityoverseerr2_traefik_priority

# Type: string
overseerr_role_traefik_priority:

# Type: string
overseerr2_traefik_priority:

overseerr_role_traefik_robot_enabledoverseerr2_traefik_robot_enabled

# Enable robots.txt middleware for containers
# Type: bool (true/false)
overseerr_role_traefik_robot_enabled: true

# Enable robots.txt middleware for containers
# Type: bool (true/false)
overseerr2_traefik_robot_enabled: true

overseerr_role_traefik_tailscale_enabledoverseerr2_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
overseerr_role_traefik_tailscale_enabled: false

# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
overseerr2_traefik_tailscale_enabled: false

overseerr_role_traefik_wildcard_enabledoverseerr2_traefik_wildcard_enabled

# Enable wildcard certificate for containers
# Type: bool (true/false)
overseerr_role_traefik_wildcard_enabled: true

# Enable wildcard certificate for containers
# Type: bool (true/false)
overseerr2_traefik_wildcard_enabled: true

overseerr_role_web_domainoverseerr2_web_domain

# Type: string
overseerr_role_web_domain:

# Type: string
overseerr2_web_domain:

overseerr_role_web_fqdn_overrideoverseerr2_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
overseerr_role_web_fqdn_override:

# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
overseerr2_web_fqdn_override:

Example Override

overseerr_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "overseerr2.{{ user.domain }}"
  - "overseerr.otherdomain.tld"

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

Example Override

overseerr2_web_fqdn_override:
  - "{{ traefik_host }}"
  - "overseerr2.{{ user.domain }}"
  - "overseerr.otherdomain.tld"

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

overseerr_role_web_host_overrideoverseerr2_web_host_override

# Override the Traefik web host configuration for containers
# Type: string
overseerr_role_web_host_override:

# Override the Traefik web host configuration for containers
# Type: string
overseerr2_web_host_override:

Example Override

overseerr_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'overseerr2.' + user.domain }}`)"

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

Example Override

overseerr2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'overseerr2.' + user.domain }}`)"

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

overseerr_role_web_http_portoverseerr2_web_http_port

# Type: string (quoted number)
overseerr_role_web_http_port:

# Type: string (quoted number)
overseerr2_web_http_port:

overseerr_role_web_http_schemeoverseerr2_web_http_scheme

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

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

overseerr_role_web_http_serverstransportoverseerr2_web_http_serverstransport

# Type: dict/omit
overseerr_role_web_http_serverstransport:

# Type: dict/omit
overseerr2_web_http_serverstransport:

overseerr_role_web_schemeoverseerr2_web_scheme

# URL scheme to use for web access to containers
# Type: string ("http"/"https")
overseerr_role_web_scheme:

# URL scheme to use for web access to containers
# Type: string ("http"/"https")
overseerr2_web_scheme:

overseerr_role_web_serverstransportoverseerr2_web_serverstransport

# Type: dict/omit
overseerr_role_web_serverstransport:

# Type: dict/omit
overseerr2_web_serverstransport:

overseerr_role_web_subdomainoverseerr2_web_subdomain

# Type: string
overseerr_role_web_subdomain:

# Type: string
overseerr2_web_subdomain: