--- icon: material/docker hide: - tags tags: - overseerr saltbox_automation: app_links: - name: Manual url: https://docs.overseerr.dev type: documentation - name: Releases url: https://hub.docker.com/r/sctx/overseerr/tags type: docker - name: Community url: https://discord.gg/seerr type: discord project_description: name: Overseerr summary: |- a free and open-source request management and media discovery tool designed to work with the Plex ecosystem. link: https://overseerr.dev/ --- # Overseerr ## Overview [Overseerr](https://overseerr.dev/) is a free and open-source request management and media discovery tool designed to work with the Plex ecosystem.
[:fontawesome-solid-book-open:**Manual**](https://docs.overseerr.dev){ .md-button .md-button--stretch } [:fontawesome-brands-docker:**Releases**](https://hub.docker.com/r/sctx/overseerr/tags){ .md-button .md-button--stretch } [:fontawesome-brands-discord:**Community**](https://discord.gg/seerr){ .md-button .md-button--stretch }
--- ???+ warning "Deprecation notice" Overseerr is being phased out in favor of [Seerr](seerr.md). The role and documentation remain for a limited time. ## Deployment ```shell sb install overseerr ``` ## Usage Visit . ## 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. 1. Click "Sign In" and sign into your Plex account. ![](../images/overseerr/01-overseerr.png) 1. Click the "refresh" icon, then select your Plex server from the dropdown. Click "Save Changes" to retrieve the libraries from Plex. ![](../images/overseerr/02-overseerr.png) 1. Scroll down and flip the switch on the libraries you want to expose for requests and discovery. Click "Continue". ![](../images/overseerr/03-overseerr.png) 1. Click "Add Radarr Server". ![](../images/overseerr/04-overseerr.png) 1. 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. ![](../images/overseerr/05-overseerr.png) 1. 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" ![](../images/overseerr/06-overseerr.png) 1. 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. ![](../images/overseerr/07-overseerr.png) 1. Select a Quality, Root Folder, and Minimum Availability for standard and Anime series. Click "Add Server". ![](../images/overseerr/08-overseerr.png) 1. Click "Finish Setup" ![](../images/overseerr/09-overseerr.png) 1. Click "Settings" over on the left. ![](../images/overseerr/10-overseerr.png) 1. Click "Users" on the left, then "Import Users From Plex" ![](../images/overseerr/11-overseerr.png) 1. Setup is complete. ![](../images/overseerr/12-overseerr.png) ## Role Defaults Variables can be customized using the [Inventory](/saltbox/inventory/index.md#overriding-variables){ data-preview }. (1) { .annotate .sb-annotated } 1. **This role supports multiple instances via `overseerr_instances`.** !!! example "Example override" === "Role-scoped" ```yaml overseerr_role_web_subdomain: "custom" ``` :material-arrow-right-bottom-bold: Applies to all instances of overseerr === "Instance-scoped" ```yaml overseerr2_web_subdomain: "custom2" ``` :material-arrow-right-bottom-bold: Applies to the instance named overseerr2 !!! warning "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. === "Basics" ??? variable list "`overseerr_instances`" ```yaml # Type: list overseerr_instances: ["overseerr"] ``` !!! example "Example Override" ```yaml # Type: list overseerr_instances: ["overseerr", "overseerr2"] ``` === "Settings" ??? variable string "`overseerr_role_log_level`{ .sb-show-on-unchecked }`overseerr2_log_level`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_log_level: "info" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_log_level: "info" ``` === "Web" ??? variable string "`overseerr_role_web_subdomain`{ .sb-show-on-unchecked }`overseerr2_web_subdomain`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_web_subdomain: "{{ overseerr_name }}" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_web_subdomain: "{{ overseerr_name }}" ``` ??? variable string "`overseerr_role_web_domain`{ .sb-show-on-unchecked }`overseerr2_web_domain`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_web_domain: "{{ user.domain }}" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_web_domain: "{{ user.domain }}" ``` ??? variable string "`overseerr_role_web_port`{ .sb-show-on-unchecked }`overseerr2_web_port`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_web_port: "5055" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_web_port: "5055" ``` ??? variable string "`overseerr_role_web_url`{ .sb-show-on-unchecked }`overseerr2_web_url`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # 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')) }}" ``` ```yaml { .sb-show-on-checked } # 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')) }}" ``` === "DNS" ??? variable string "`overseerr_role_dns_record`{ .sb-show-on-unchecked }`overseerr2_dns_record`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='overseerr') }}" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_dns_record: "{{ lookup('role_var', '_web_subdomain', role='overseerr') }}" ``` ??? variable string "`overseerr_role_dns_zone`{ .sb-show-on-unchecked }`overseerr2_dns_zone`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='overseerr') }}" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_dns_zone: "{{ lookup('role_var', '_web_domain', role='overseerr') }}" ``` ??? variable bool "`overseerr_role_dns_proxy`{ .sb-show-on-unchecked }`overseerr2_dns_proxy`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_dns_proxy: "{{ dns_proxied }}" ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_dns_proxy: "{{ dns_proxied }}" ``` === "Traefik" ??? variable string "`overseerr_role_traefik_sso_middleware`{ .sb-show-on-unchecked }`overseerr2_traefik_sso_middleware`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_traefik_sso_middleware: "" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_traefik_sso_middleware: "" ``` ??? variable string "`overseerr_role_traefik_middleware_default`{ .sb-show-on-unchecked }`overseerr2_traefik_middleware_default`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # 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 '') }}" ``` ```yaml { .sb-show-on-checked } # 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 '') }}" ``` ??? variable string "`overseerr_role_traefik_middleware_custom`{ .sb-show-on-unchecked }`overseerr2_traefik_middleware_custom`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_traefik_middleware_custom: "" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_traefik_middleware_custom: "" ``` ??? variable string "`overseerr_role_traefik_certresolver`{ .sb-show-on-unchecked }`overseerr2_traefik_certresolver`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_traefik_certresolver: "{{ traefik_default_certresolver }}" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_traefik_certresolver: "{{ traefik_default_certresolver }}" ``` ??? variable bool "`overseerr_role_traefik_enabled`{ .sb-show-on-unchecked }`overseerr2_traefik_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_traefik_enabled: true ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_traefik_enabled: true ``` ??? variable bool "`overseerr_role_traefik_api_enabled`{ .sb-show-on-unchecked }`overseerr2_traefik_api_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_traefik_api_enabled: false ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_traefik_api_enabled: false ``` ??? variable string "`overseerr_role_traefik_api_endpoint`{ .sb-show-on-unchecked }`overseerr2_traefik_api_endpoint`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_traefik_api_endpoint: "" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_traefik_api_endpoint: "" ``` === "Theme" ??? variable bool "`overseerr_role_themepark_enabled`{ .sb-show-on-unchecked }`overseerr2_themepark_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Options can be found at https://github.com/themepark-dev/theme.park # Type: bool (true/false) overseerr_role_themepark_enabled: false ``` ```yaml { .sb-show-on-checked } # Options can be found at https://github.com/themepark-dev/theme.park # Type: bool (true/false) overseerr2_themepark_enabled: false ``` ??? variable string "`overseerr_role_themepark_app`{ .sb-show-on-unchecked }`overseerr2_themepark_app`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_themepark_app: "overseerr" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_themepark_app: "overseerr" ``` ??? variable string "`overseerr_role_themepark_theme`{ .sb-show-on-unchecked }`overseerr2_themepark_theme`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_themepark_theme: "{{ global_themepark_theme }}" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_themepark_theme: "{{ global_themepark_theme }}" ``` ??? variable string "`overseerr_role_themepark_domain`{ .sb-show-on-unchecked }`overseerr2_themepark_domain`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_themepark_domain: "{{ global_themepark_domain }}" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_themepark_domain: "{{ global_themepark_domain }}" ``` ??? variable list "`overseerr_role_themepark_addons`{ .sb-show-on-unchecked }`overseerr2_themepark_addons`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_themepark_addons: [] ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_themepark_addons: [] ``` === "Docker"
Container
??? variable string "`overseerr_role_docker_container`{ .sb-show-on-unchecked }`overseerr2_docker_container`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_container: "{{ overseerr_name }}" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_container: "{{ overseerr_name }}" ```
Image
??? variable bool "`overseerr_role_docker_image_pull`{ .sb-show-on-unchecked }`overseerr2_docker_image_pull`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_image_pull: true ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_image_pull: true ``` ??? variable string "`overseerr_role_docker_image_repo`{ .sb-show-on-unchecked }`overseerr2_docker_image_repo`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_image_repo: "sctx/overseerr" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_image_repo: "sctx/overseerr" ``` ??? variable string "`overseerr_role_docker_image_tag`{ .sb-show-on-unchecked }`overseerr2_docker_image_tag`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_image_tag: "latest" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_image_tag: "latest" ``` ??? variable string "`overseerr_role_docker_image`{ .sb-show-on-unchecked }`overseerr2_docker_image`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='overseerr') }}:{{ lookup('role_var', '_docker_image_tag', role='overseerr') }}" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='overseerr') }}:{{ lookup('role_var', '_docker_image_tag', role='overseerr') }}" ```
Envs
??? variable dict "`overseerr_role_docker_envs_default`{ .sb-show-on-unchecked }`overseerr2_docker_envs_default`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict overseerr_role_docker_envs_default: UMASK: "002" TZ: "{{ tz }}" LOG_LEVEL: "{{ lookup('role_var', '_log_level', role='overseerr') }}" ``` ```yaml { .sb-show-on-checked } # Type: dict overseerr2_docker_envs_default: UMASK: "002" TZ: "{{ tz }}" LOG_LEVEL: "{{ lookup('role_var', '_log_level', role='overseerr') }}" ``` ??? variable dict "`overseerr_role_docker_envs_custom`{ .sb-show-on-unchecked }`overseerr2_docker_envs_custom`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict overseerr_role_docker_envs_custom: {} ``` ```yaml { .sb-show-on-checked } # Type: dict overseerr2_docker_envs_custom: {} ```
Volumes
??? variable list "`overseerr_role_docker_volumes_default`{ .sb-show-on-unchecked }`overseerr2_docker_volumes_default`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_volumes_default: - "{{ overseerr_role_paths_location }}:/app/config" ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_volumes_default: - "{{ overseerr_role_paths_location }}:/app/config" ``` ??? variable list "`overseerr_role_docker_volumes_custom`{ .sb-show-on-unchecked }`overseerr2_docker_volumes_custom`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_volumes_custom: [] ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_volumes_custom: [] ```
Labels
??? variable dict "`overseerr_role_docker_labels_default`{ .sb-show-on-unchecked }`overseerr2_docker_labels_default`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict overseerr_role_docker_labels_default: {} ``` ```yaml { .sb-show-on-checked } # Type: dict overseerr2_docker_labels_default: {} ``` ??? variable dict "`overseerr_role_docker_labels_custom`{ .sb-show-on-unchecked }`overseerr2_docker_labels_custom`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict overseerr_role_docker_labels_custom: {} ``` ```yaml { .sb-show-on-checked } # Type: dict overseerr2_docker_labels_custom: {} ```
Hostname
??? variable string "`overseerr_role_docker_hostname`{ .sb-show-on-unchecked }`overseerr2_docker_hostname`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_hostname: "{{ overseerr_name }}" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_hostname: "{{ overseerr_name }}" ```
Networks
??? variable string "`overseerr_role_docker_networks_alias`{ .sb-show-on-unchecked }`overseerr2_docker_networks_alias`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_networks_alias: "{{ overseerr_name }}" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_networks_alias: "{{ overseerr_name }}" ``` ??? variable list "`overseerr_role_docker_networks_default`{ .sb-show-on-unchecked }`overseerr2_docker_networks_default`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_networks_default: [] ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_networks_default: [] ``` ??? variable list "`overseerr_role_docker_networks_custom`{ .sb-show-on-unchecked }`overseerr2_docker_networks_custom`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_networks_custom: [] ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_networks_custom: [] ```
Restart Policy
??? variable string "`overseerr_role_docker_restart_policy`{ .sb-show-on-unchecked }`overseerr2_docker_restart_policy`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_restart_policy: unless-stopped ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_restart_policy: unless-stopped ```
State
??? variable string "`overseerr_role_docker_state`{ .sb-show-on-unchecked }`overseerr2_docker_state`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_state: started ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_state: started ```
User
??? variable string "`overseerr_role_docker_user`{ .sb-show-on-unchecked }`overseerr2_docker_user`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_user: "{{ uid }}:{{ gid }}" ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_user: "{{ uid }}:{{ gid }}" ``` === "Docker+" The following advanced options are available via create_docker_container but are not defined in the role. See: [docker_container module](https://docs.ansible.com/ansible/latest/collections/community/docker/docker_container_module.html)
Resource Limits
??? variable int "`overseerr_role_docker_blkio_weight`{ .sb-show-on-unchecked }`overseerr2_docker_blkio_weight`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int overseerr_role_docker_blkio_weight: ``` ```yaml { .sb-show-on-checked } # Type: int overseerr2_docker_blkio_weight: ``` ??? variable int "`overseerr_role_docker_cpu_period`{ .sb-show-on-unchecked }`overseerr2_docker_cpu_period`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int overseerr_role_docker_cpu_period: ``` ```yaml { .sb-show-on-checked } # Type: int overseerr2_docker_cpu_period: ``` ??? variable int "`overseerr_role_docker_cpu_quota`{ .sb-show-on-unchecked }`overseerr2_docker_cpu_quota`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int overseerr_role_docker_cpu_quota: ``` ```yaml { .sb-show-on-checked } # Type: int overseerr2_docker_cpu_quota: ``` ??? variable int "`overseerr_role_docker_cpu_shares`{ .sb-show-on-unchecked }`overseerr2_docker_cpu_shares`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int overseerr_role_docker_cpu_shares: ``` ```yaml { .sb-show-on-checked } # Type: int overseerr2_docker_cpu_shares: ``` ??? variable string "`overseerr_role_docker_cpus`{ .sb-show-on-unchecked }`overseerr2_docker_cpus`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_cpus: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_cpus: ``` ??? variable string "`overseerr_role_docker_cpuset_cpus`{ .sb-show-on-unchecked }`overseerr2_docker_cpuset_cpus`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_cpuset_cpus: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_cpuset_cpus: ``` ??? variable string "`overseerr_role_docker_cpuset_mems`{ .sb-show-on-unchecked }`overseerr2_docker_cpuset_mems`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_cpuset_mems: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_cpuset_mems: ``` ??? variable string "`overseerr_role_docker_kernel_memory`{ .sb-show-on-unchecked }`overseerr2_docker_kernel_memory`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_kernel_memory: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_kernel_memory: ``` ??? variable string "`overseerr_role_docker_memory`{ .sb-show-on-unchecked }`overseerr2_docker_memory`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_memory: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_memory: ``` ??? variable string "`overseerr_role_docker_memory_reservation`{ .sb-show-on-unchecked }`overseerr2_docker_memory_reservation`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_memory_reservation: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_memory_reservation: ``` ??? variable string "`overseerr_role_docker_memory_swap`{ .sb-show-on-unchecked }`overseerr2_docker_memory_swap`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_memory_swap: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_memory_swap: ``` ??? variable int "`overseerr_role_docker_memory_swappiness`{ .sb-show-on-unchecked }`overseerr2_docker_memory_swappiness`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int overseerr_role_docker_memory_swappiness: ``` ```yaml { .sb-show-on-checked } # Type: int overseerr2_docker_memory_swappiness: ``` ??? variable string "`overseerr_role_docker_shm_size`{ .sb-show-on-unchecked }`overseerr2_docker_shm_size`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_shm_size: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_shm_size: ```
Security & Devices
??? variable list "`overseerr_role_docker_cap_drop`{ .sb-show-on-unchecked }`overseerr2_docker_cap_drop`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_cap_drop: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_cap_drop: ``` ??? variable string "`overseerr_role_docker_cgroupns_mode`{ .sb-show-on-unchecked }`overseerr2_docker_cgroupns_mode`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_cgroupns_mode: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_cgroupns_mode: ``` ??? variable list "`overseerr_role_docker_device_cgroup_rules`{ .sb-show-on-unchecked }`overseerr2_docker_device_cgroup_rules`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_device_cgroup_rules: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_device_cgroup_rules: ``` ??? variable list "`overseerr_role_docker_device_read_bps`{ .sb-show-on-unchecked }`overseerr2_docker_device_read_bps`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_device_read_bps: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_device_read_bps: ``` ??? variable list "`overseerr_role_docker_device_read_iops`{ .sb-show-on-unchecked }`overseerr2_docker_device_read_iops`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_device_read_iops: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_device_read_iops: ``` ??? variable list "`overseerr_role_docker_device_requests`{ .sb-show-on-unchecked }`overseerr2_docker_device_requests`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_device_requests: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_device_requests: ``` ??? variable list "`overseerr_role_docker_device_write_bps`{ .sb-show-on-unchecked }`overseerr2_docker_device_write_bps`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_device_write_bps: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_device_write_bps: ``` ??? variable list "`overseerr_role_docker_device_write_iops`{ .sb-show-on-unchecked }`overseerr2_docker_device_write_iops`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_device_write_iops: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_device_write_iops: ``` ??? variable list "`overseerr_role_docker_devices`{ .sb-show-on-unchecked }`overseerr2_docker_devices`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_devices: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_devices: ``` ??? variable list "`overseerr_role_docker_groups`{ .sb-show-on-unchecked }`overseerr2_docker_groups`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_groups: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_groups: ``` ??? variable bool "`overseerr_role_docker_privileged`{ .sb-show-on-unchecked }`overseerr2_docker_privileged`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_privileged: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_privileged: ``` ??? variable list "`overseerr_role_docker_security_opts`{ .sb-show-on-unchecked }`overseerr2_docker_security_opts`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_security_opts: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_security_opts: ``` ??? variable string "`overseerr_role_docker_userns_mode`{ .sb-show-on-unchecked }`overseerr2_docker_userns_mode`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_userns_mode: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_userns_mode: ```
Networking
??? variable list "`overseerr_role_docker_dns_opts`{ .sb-show-on-unchecked }`overseerr2_docker_dns_opts`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_dns_opts: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_dns_opts: ``` ??? variable list "`overseerr_role_docker_dns_search_domains`{ .sb-show-on-unchecked }`overseerr2_docker_dns_search_domains`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_dns_search_domains: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_dns_search_domains: ``` ??? variable list "`overseerr_role_docker_dns_servers`{ .sb-show-on-unchecked }`overseerr2_docker_dns_servers`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_dns_servers: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_dns_servers: ``` ??? variable string "`overseerr_role_docker_domainname`{ .sb-show-on-unchecked }`overseerr2_docker_domainname`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_domainname: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_domainname: ``` ??? variable list "`overseerr_role_docker_exposed_ports`{ .sb-show-on-unchecked }`overseerr2_docker_exposed_ports`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_exposed_ports: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_exposed_ports: ``` ??? variable dict "`overseerr_role_docker_hosts`{ .sb-show-on-unchecked }`overseerr2_docker_hosts`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict overseerr_role_docker_hosts: ``` ```yaml { .sb-show-on-checked } # Type: dict overseerr2_docker_hosts: ``` ??? variable bool "`overseerr_role_docker_hosts_use_common`{ .sb-show-on-unchecked }`overseerr2_docker_hosts_use_common`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_hosts_use_common: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_hosts_use_common: ``` ??? variable string "`overseerr_role_docker_ipc_mode`{ .sb-show-on-unchecked }`overseerr2_docker_ipc_mode`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_ipc_mode: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_ipc_mode: ``` ??? variable list "`overseerr_role_docker_links`{ .sb-show-on-unchecked }`overseerr2_docker_links`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_links: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_links: ``` ??? variable string "`overseerr_role_docker_network_mode`{ .sb-show-on-unchecked }`overseerr2_docker_network_mode`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_network_mode: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_network_mode: ``` ??? variable string "`overseerr_role_docker_pid_mode`{ .sb-show-on-unchecked }`overseerr2_docker_pid_mode`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_pid_mode: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_pid_mode: ``` ??? variable list "`overseerr_role_docker_ports`{ .sb-show-on-unchecked }`overseerr2_docker_ports`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_ports: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_ports: ``` ??? variable string "`overseerr_role_docker_uts`{ .sb-show-on-unchecked }`overseerr2_docker_uts`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_uts: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_uts: ```
Storage
??? variable bool "`overseerr_role_docker_keep_volumes`{ .sb-show-on-unchecked }`overseerr2_docker_keep_volumes`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_keep_volumes: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_keep_volumes: ``` ??? variable list "`overseerr_role_docker_mounts`{ .sb-show-on-unchecked }`overseerr2_docker_mounts`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_mounts: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_mounts: ``` ??? variable dict "`overseerr_role_docker_storage_opts`{ .sb-show-on-unchecked }`overseerr2_docker_storage_opts`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict overseerr_role_docker_storage_opts: ``` ```yaml { .sb-show-on-checked } # Type: dict overseerr2_docker_storage_opts: ``` ??? variable list "`overseerr_role_docker_tmpfs`{ .sb-show-on-unchecked }`overseerr2_docker_tmpfs`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_tmpfs: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_tmpfs: ``` ??? variable string "`overseerr_role_docker_volume_driver`{ .sb-show-on-unchecked }`overseerr2_docker_volume_driver`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_volume_driver: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_volume_driver: ``` ??? variable list "`overseerr_role_docker_volumes_from`{ .sb-show-on-unchecked }`overseerr2_docker_volumes_from`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_volumes_from: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_volumes_from: ``` ??? variable bool "`overseerr_role_docker_volumes_global`{ .sb-show-on-unchecked }`overseerr2_docker_volumes_global`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_volumes_global: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_volumes_global: ``` ??? variable string "`overseerr_role_docker_working_dir`{ .sb-show-on-unchecked }`overseerr2_docker_working_dir`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_working_dir: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_working_dir: ```
Monitoring & Lifecycle
??? variable bool "`overseerr_role_docker_auto_remove`{ .sb-show-on-unchecked }`overseerr2_docker_auto_remove`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_auto_remove: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_auto_remove: ``` ??? variable bool "`overseerr_role_docker_cleanup`{ .sb-show-on-unchecked }`overseerr2_docker_cleanup`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_cleanup: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_cleanup: ``` ??? variable string "`overseerr_role_docker_force_kill`{ .sb-show-on-unchecked }`overseerr2_docker_force_kill`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_force_kill: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_force_kill: ``` ??? variable dict "`overseerr_role_docker_healthcheck`{ .sb-show-on-unchecked }`overseerr2_docker_healthcheck`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict overseerr_role_docker_healthcheck: ``` ```yaml { .sb-show-on-checked } # Type: dict overseerr2_docker_healthcheck: ``` ??? variable int "`overseerr_role_docker_healthy_wait_timeout`{ .sb-show-on-unchecked }`overseerr2_docker_healthy_wait_timeout`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int overseerr_role_docker_healthy_wait_timeout: ``` ```yaml { .sb-show-on-checked } # Type: int overseerr2_docker_healthy_wait_timeout: ``` ??? variable bool "`overseerr_role_docker_init`{ .sb-show-on-unchecked }`overseerr2_docker_init`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_init: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_init: ``` ??? variable string "`overseerr_role_docker_kill_signal`{ .sb-show-on-unchecked }`overseerr2_docker_kill_signal`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_kill_signal: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_kill_signal: ``` ??? variable string "`overseerr_role_docker_log_driver`{ .sb-show-on-unchecked }`overseerr2_docker_log_driver`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_log_driver: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_log_driver: ``` ??? variable dict "`overseerr_role_docker_log_options`{ .sb-show-on-unchecked }`overseerr2_docker_log_options`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict overseerr_role_docker_log_options: ``` ```yaml { .sb-show-on-checked } # Type: dict overseerr2_docker_log_options: ``` ??? variable bool "`overseerr_role_docker_oom_killer`{ .sb-show-on-unchecked }`overseerr2_docker_oom_killer`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_oom_killer: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_oom_killer: ``` ??? variable int "`overseerr_role_docker_oom_score_adj`{ .sb-show-on-unchecked }`overseerr2_docker_oom_score_adj`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int overseerr_role_docker_oom_score_adj: ``` ```yaml { .sb-show-on-checked } # Type: int overseerr2_docker_oom_score_adj: ``` ??? variable bool "`overseerr_role_docker_output_logs`{ .sb-show-on-unchecked }`overseerr2_docker_output_logs`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_output_logs: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_output_logs: ``` ??? variable bool "`overseerr_role_docker_paused`{ .sb-show-on-unchecked }`overseerr2_docker_paused`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_paused: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_paused: ``` ??? variable bool "`overseerr_role_docker_recreate`{ .sb-show-on-unchecked }`overseerr2_docker_recreate`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_recreate: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_recreate: ``` ??? variable int "`overseerr_role_docker_restart_retries`{ .sb-show-on-unchecked }`overseerr2_docker_restart_retries`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int overseerr_role_docker_restart_retries: ``` ```yaml { .sb-show-on-checked } # Type: int overseerr2_docker_restart_retries: ``` ??? variable string "`overseerr_role_docker_stop_signal`{ .sb-show-on-unchecked }`overseerr2_docker_stop_signal`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_stop_signal: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_stop_signal: ``` ??? variable int "`overseerr_role_docker_stop_timeout`{ .sb-show-on-unchecked }`overseerr2_docker_stop_timeout`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int overseerr_role_docker_stop_timeout: ``` ```yaml { .sb-show-on-checked } # Type: int overseerr2_docker_stop_timeout: ```
Other Options
??? variable list "`overseerr_role_docker_capabilities`{ .sb-show-on-unchecked }`overseerr2_docker_capabilities`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_capabilities: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_capabilities: ``` ??? variable string "`overseerr_role_docker_cgroup_parent`{ .sb-show-on-unchecked }`overseerr2_docker_cgroup_parent`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_cgroup_parent: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_cgroup_parent: ``` ??? variable list "`overseerr_role_docker_commands`{ .sb-show-on-unchecked }`overseerr2_docker_commands`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_commands: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_commands: ``` ??? variable int "`overseerr_role_docker_create_timeout`{ .sb-show-on-unchecked }`overseerr2_docker_create_timeout`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: int overseerr_role_docker_create_timeout: ``` ```yaml { .sb-show-on-checked } # Type: int overseerr2_docker_create_timeout: ``` ??? variable string "`overseerr_role_docker_entrypoint`{ .sb-show-on-unchecked }`overseerr2_docker_entrypoint`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_entrypoint: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_entrypoint: ``` ??? variable string "`overseerr_role_docker_env_file`{ .sb-show-on-unchecked }`overseerr2_docker_env_file`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_env_file: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_env_file: ``` ??? variable bool "`overseerr_role_docker_labels_use_common`{ .sb-show-on-unchecked }`overseerr2_docker_labels_use_common`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_labels_use_common: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_labels_use_common: ``` ??? variable bool "`overseerr_role_docker_read_only`{ .sb-show-on-unchecked }`overseerr2_docker_read_only`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_read_only: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_read_only: ``` ??? variable string "`overseerr_role_docker_runtime`{ .sb-show-on-unchecked }`overseerr2_docker_runtime`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_docker_runtime: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_docker_runtime: ``` ??? variable list "`overseerr_role_docker_sysctls`{ .sb-show-on-unchecked }`overseerr2_docker_sysctls`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_sysctls: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_sysctls: ``` ??? variable list "`overseerr_role_docker_ulimits`{ .sb-show-on-unchecked }`overseerr2_docker_ulimits`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_ulimits: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_ulimits: ``` === "Global Override Options" ??? variable bool "`overseerr_role_autoheal_enabled`{ .sb-show-on-unchecked }`overseerr2_autoheal_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable or disable Autoheal monitoring for containers created when deploying # Type: bool (true/false) overseerr_role_autoheal_enabled: true ``` ```yaml { .sb-show-on-checked } # Enable or disable Autoheal monitoring for containers created when deploying # Type: bool (true/false) overseerr2_autoheal_enabled: true ``` ??? variable string "`overseerr_role_depends_on`{ .sb-show-on-unchecked }`overseerr2_depends_on`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # List of container dependencies that must be running before containers start # Type: string overseerr_role_depends_on: "" ``` ```yaml { .sb-show-on-checked } # List of container dependencies that must be running before containers start # Type: string overseerr2_depends_on: "" ``` ??? variable string "`overseerr_role_depends_on_delay`{ .sb-show-on-unchecked }`overseerr2_depends_on_delay`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Delay in seconds before starting containers after dependencies are ready # Type: string (quoted number) overseerr_role_depends_on_delay: "0" ``` ```yaml { .sb-show-on-checked } # Delay in seconds before starting containers after dependencies are ready # Type: string (quoted number) overseerr2_depends_on_delay: "0" ``` ??? variable string "`overseerr_role_depends_on_healthchecks`{ .sb-show-on-unchecked }`overseerr2_depends_on_healthchecks`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable healthcheck waiting for container dependencies # Type: string ("true"/"false") overseerr_role_depends_on_healthchecks: ``` ```yaml { .sb-show-on-checked } # Enable healthcheck waiting for container dependencies # Type: string ("true"/"false") overseerr2_depends_on_healthchecks: ``` ??? variable bool "`overseerr_role_diun_enabled`{ .sb-show-on-unchecked }`overseerr2_diun_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable or disable Diun update notifications for containers created when deploying # Type: bool (true/false) overseerr_role_diun_enabled: true ``` ```yaml { .sb-show-on-checked } # Enable or disable Diun update notifications for containers created when deploying # Type: bool (true/false) overseerr2_diun_enabled: true ``` ??? variable bool "`overseerr_role_dns_enabled`{ .sb-show-on-unchecked }`overseerr2_dns_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable or disable automatic DNS record creation for containers # Type: bool (true/false) overseerr_role_dns_enabled: true ``` ```yaml { .sb-show-on-checked } # Enable or disable automatic DNS record creation for containers # Type: bool (true/false) overseerr2_dns_enabled: true ``` ??? variable bool "`overseerr_role_docker_controller`{ .sb-show-on-unchecked }`overseerr2_docker_controller`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable or disable Saltbox Docker Controller management for containers # Type: bool (true/false) overseerr_role_docker_controller: true ``` ```yaml { .sb-show-on-checked } # Enable or disable Saltbox Docker Controller management for containers # Type: bool (true/false) overseerr2_docker_controller: true ``` ??? variable list "`overseerr_role_docker_networks_alias_custom`{ .sb-show-on-unchecked }`overseerr2_docker_networks_alias_custom`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: list overseerr_role_docker_networks_alias_custom: ``` ```yaml { .sb-show-on-checked } # Type: list overseerr2_docker_networks_alias_custom: ``` ??? variable bool "`overseerr_role_docker_volumes_download`{ .sb-show-on-unchecked }`overseerr2_docker_volumes_download`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_docker_volumes_download: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_docker_volumes_download: ``` ??? variable string "`overseerr_role_traefik_api_middleware`{ .sb-show-on-unchecked }`overseerr2_traefik_api_middleware`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_traefik_api_middleware: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_traefik_api_middleware: ``` ??? variable string "`overseerr_role_traefik_api_middleware_http`{ .sb-show-on-unchecked }`overseerr2_traefik_api_middleware_http`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_traefik_api_middleware_http: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_traefik_api_middleware_http: ``` ??? variable bool "`overseerr_role_traefik_autodetect_enabled`{ .sb-show-on-unchecked }`overseerr2_traefik_autodetect_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable Traefik autodetect middleware for containers # Type: bool (true/false) overseerr_role_traefik_autodetect_enabled: false ``` ```yaml { .sb-show-on-checked } # Enable Traefik autodetect middleware for containers # Type: bool (true/false) overseerr2_traefik_autodetect_enabled: false ``` ??? variable bool "`overseerr_role_traefik_crowdsec_enabled`{ .sb-show-on-unchecked }`overseerr2_traefik_crowdsec_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable CrowdSec middleware for containers # Type: bool (true/false) overseerr_role_traefik_crowdsec_enabled: false ``` ```yaml { .sb-show-on-checked } # Enable CrowdSec middleware for containers # Type: bool (true/false) overseerr2_traefik_crowdsec_enabled: false ``` ??? variable bool "`overseerr_role_traefik_error_pages_enabled`{ .sb-show-on-unchecked }`overseerr2_traefik_error_pages_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable custom error pages middleware for containers # Type: bool (true/false) overseerr_role_traefik_error_pages_enabled: false ``` ```yaml { .sb-show-on-checked } # Enable custom error pages middleware for containers # Type: bool (true/false) overseerr2_traefik_error_pages_enabled: false ``` ??? variable bool "`overseerr_role_traefik_gzip_enabled`{ .sb-show-on-unchecked }`overseerr2_traefik_gzip_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable gzip compression middleware for containers # Type: bool (true/false) overseerr_role_traefik_gzip_enabled: false ``` ```yaml { .sb-show-on-checked } # Enable gzip compression middleware for containers # Type: bool (true/false) overseerr2_traefik_gzip_enabled: false ``` ??? variable string "`overseerr_role_traefik_middleware_http`{ .sb-show-on-unchecked }`overseerr2_traefik_middleware_http`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_traefik_middleware_http: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_traefik_middleware_http: ``` ??? variable bool "`overseerr_role_traefik_middleware_http_api_insecure`{ .sb-show-on-unchecked }`overseerr2_traefik_middleware_http_api_insecure`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_traefik_middleware_http_api_insecure: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_traefik_middleware_http_api_insecure: ``` ??? variable bool "`overseerr_role_traefik_middleware_http_insecure`{ .sb-show-on-unchecked }`overseerr2_traefik_middleware_http_insecure`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: bool (true/false) overseerr_role_traefik_middleware_http_insecure: ``` ```yaml { .sb-show-on-checked } # Type: bool (true/false) overseerr2_traefik_middleware_http_insecure: ``` ??? variable string "`overseerr_role_traefik_priority`{ .sb-show-on-unchecked }`overseerr2_traefik_priority`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string overseerr_role_traefik_priority: ``` ```yaml { .sb-show-on-checked } # Type: string overseerr2_traefik_priority: ``` ??? variable bool "`overseerr_role_traefik_robot_enabled`{ .sb-show-on-unchecked }`overseerr2_traefik_robot_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable robots.txt middleware for containers # Type: bool (true/false) overseerr_role_traefik_robot_enabled: true ``` ```yaml { .sb-show-on-checked } # Enable robots.txt middleware for containers # Type: bool (true/false) overseerr2_traefik_robot_enabled: true ``` ??? variable bool "`overseerr_role_traefik_tailscale_enabled`{ .sb-show-on-unchecked }`overseerr2_traefik_tailscale_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable Tailscale-specific Traefik configuration for containers # Type: bool (true/false) overseerr_role_traefik_tailscale_enabled: false ``` ```yaml { .sb-show-on-checked } # Enable Tailscale-specific Traefik configuration for containers # Type: bool (true/false) overseerr2_traefik_tailscale_enabled: false ``` ??? variable bool "`overseerr_role_traefik_wildcard_enabled`{ .sb-show-on-unchecked }`overseerr2_traefik_wildcard_enabled`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Enable wildcard certificate for containers # Type: bool (true/false) overseerr_role_traefik_wildcard_enabled: true ``` ```yaml { .sb-show-on-checked } # Enable wildcard certificate for containers # Type: bool (true/false) overseerr2_traefik_wildcard_enabled: true ``` ??? variable string "`overseerr_role_web_api_http_port`{ .sb-show-on-unchecked }`overseerr2_web_api_http_port`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string (quoted number) overseerr_role_web_api_http_port: ``` ```yaml { .sb-show-on-checked } # Type: string (quoted number) overseerr2_web_api_http_port: ``` ??? variable string "`overseerr_role_web_api_http_scheme`{ .sb-show-on-unchecked }`overseerr2_web_api_http_scheme`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string ("http"/"https") overseerr_role_web_api_http_scheme: ``` ```yaml { .sb-show-on-checked } # Type: string ("http"/"https") overseerr2_web_api_http_scheme: ``` ??? variable dict "`overseerr_role_web_api_http_serverstransport`{ .sb-show-on-unchecked }`overseerr2_web_api_http_serverstransport`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict/omit overseerr_role_web_api_http_serverstransport: ``` ```yaml { .sb-show-on-checked } # Type: dict/omit overseerr2_web_api_http_serverstransport: ``` ??? variable string "`overseerr_role_web_api_port`{ .sb-show-on-unchecked }`overseerr2_web_api_port`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string (quoted number) overseerr_role_web_api_port: ``` ```yaml { .sb-show-on-checked } # Type: string (quoted number) overseerr2_web_api_port: ``` ??? variable string "`overseerr_role_web_api_scheme`{ .sb-show-on-unchecked }`overseerr2_web_api_scheme`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string ("http"/"https") overseerr_role_web_api_scheme: ``` ```yaml { .sb-show-on-checked } # Type: string ("http"/"https") overseerr2_web_api_scheme: ``` ??? variable dict "`overseerr_role_web_api_serverstransport`{ .sb-show-on-unchecked }`overseerr2_web_api_serverstransport`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict/omit overseerr_role_web_api_serverstransport: ``` ```yaml { .sb-show-on-checked } # Type: dict/omit overseerr2_web_api_serverstransport: ``` ??? variable list "`overseerr_role_web_fqdn_override`{ .sb-show-on-unchecked }`overseerr2_web_fqdn_override`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Override the Traefik fully qualified domain name (FQDN) for containers # Type: list overseerr_role_web_fqdn_override: ``` ```yaml { .sb-show-on-checked } # Override the Traefik fully qualified domain name (FQDN) for containers # Type: list overseerr2_web_fqdn_override: ``` !!! example sb-show-on-unchecked "Example Override" ```yaml 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 sb-show-on-checked "Example Override" ```yaml 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 ??? variable string "`overseerr_role_web_host_override`{ .sb-show-on-unchecked }`overseerr2_web_host_override`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Override the Traefik web host configuration for containers # Type: string overseerr_role_web_host_override: ``` ```yaml { .sb-show-on-checked } # Override the Traefik web host configuration for containers # Type: string overseerr2_web_host_override: ``` !!! example sb-show-on-unchecked "Example Override" ```yaml 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 sb-show-on-checked "Example Override" ```yaml 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 ??? variable string "`overseerr_role_web_http_port`{ .sb-show-on-unchecked }`overseerr2_web_http_port`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string (quoted number) overseerr_role_web_http_port: ``` ```yaml { .sb-show-on-checked } # Type: string (quoted number) overseerr2_web_http_port: ``` ??? variable string "`overseerr_role_web_http_scheme`{ .sb-show-on-unchecked }`overseerr2_web_http_scheme`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: string ("http"/"https") overseerr_role_web_http_scheme: ``` ```yaml { .sb-show-on-checked } # Type: string ("http"/"https") overseerr2_web_http_scheme: ``` ??? variable dict "`overseerr_role_web_http_serverstransport`{ .sb-show-on-unchecked }`overseerr2_web_http_serverstransport`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict/omit overseerr_role_web_http_serverstransport: ``` ```yaml { .sb-show-on-checked } # Type: dict/omit overseerr2_web_http_serverstransport: ``` ??? variable string "`overseerr_role_web_scheme`{ .sb-show-on-unchecked }`overseerr2_web_scheme`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # URL scheme to use for web access to containers # Type: string ("http"/"https") overseerr_role_web_scheme: ``` ```yaml { .sb-show-on-checked } # URL scheme to use for web access to containers # Type: string ("http"/"https") overseerr2_web_scheme: ``` ??? variable dict "`overseerr_role_web_serverstransport`{ .sb-show-on-unchecked }`overseerr2_web_serverstransport`{ .sb-show-on-checked }" ```yaml { .sb-show-on-unchecked } # Type: dict/omit overseerr_role_web_serverstransport: ``` ```yaml { .sb-show-on-checked } # Type: dict/omit overseerr2_web_serverstransport: ```