Maintainerr¶
| Description / name | Input element |
|---|---|
| Your domain name |
Overview¶
Maintainerr is an automated media management tool designed to help users free up storage space on their media servers by identifying and removing unwatched or unwanted content.
Deployment¶
sb install sandbox-maintainerr
Usage¶
Visit https://maintainerr.iYOUR_DOMAIN_NAMEi.
Basics¶
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.
-
Log into your maintainerr url and the inital page will be the plex settings
-
Authenticate into plex
-
Click the refresh button to have maintainer find all plex servers
-
Click on the drop down and choose manual
-
Name it whatever you want
-
Hostname or IP is the name of your container. Default is plex
-
Port of plex server. Default is 32400
-
Leave SSL unchecked
-
Save Changes and Test changes
-
Navigate to Overseerr tab
-
Hostname of overseerr container. Default is overseerr
-
Port of container. Default is 5055
-
API key from overseerr
-
Save and test changes
-
Navigate to Sonarr tab
-
Hostname of sonarr container. Default is sonarr
-
Port of sonarr container. Default is 8989
-
API key from sonarr
-
Save and test changes
-
Navigate to Radarr tab
-
Hostname of radarr container. Default is radarr
-
Port of radarr container. Default is 7878
-
API key from radarr
-
Save and test changes
-
Once Overseerr, Plex, Sonarr, Radarr configurations are in place, you can use the app to you preferences.
Role Defaults¶
Use the Inventory to customize variables. (1)
-
This role supports multiple instances via
maintainerr_instances.Example override
maintainerr_role_web_subdomain: "custom"Applies to all instances of maintainerr
maintainerr2_web_subdomain: "custom2"Applies to the instance named maintainerr2
Avoid overriding variables ending in
_defaultWhen overriding variables that end in
_default(likemaintainerr_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 (likemaintainerr_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.
maintainerr_instances
# Type: list
maintainerr_instances: ["maintainerr"]
Example Override
# Type: list
maintainerr_instances: ["maintainerr", "maintainerr2"]
maintainerr_role_web_subdomainmaintainerr2_web_subdomain
# Type: string
maintainerr_role_web_subdomain: "{{ maintainerr_name }}"
# Type: string
maintainerr2_web_subdomain: "{{ maintainerr_name }}"
maintainerr_role_web_domainmaintainerr2_web_domain
# Type: string
maintainerr_role_web_domain: "{{ user.domain }}"
# Type: string
maintainerr2_web_domain: "{{ user.domain }}"
maintainerr_role_web_portmaintainerr2_web_port
# Type: string
maintainerr_role_web_port: "6246"
# Type: string
maintainerr2_web_port: "6246"
maintainerr_role_web_urlmaintainerr2_web_url
# Type: string
maintainerr_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='maintainerr') + '.' + lookup('role_var', '_web_domain', role='maintainerr')
if (lookup('role_var', '_web_subdomain', role='maintainerr') | length > 0)
else lookup('role_var', '_web_domain', role='maintainerr')) }}"
# Type: string
maintainerr2_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='maintainerr') + '.' + lookup('role_var', '_web_domain', role='maintainerr')
if (lookup('role_var', '_web_subdomain', role='maintainerr') | length > 0)
else lookup('role_var', '_web_domain', role='maintainerr')) }}"
maintainerr_role_dns_recordmaintainerr2_dns_record
# Type: string
maintainerr_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='maintainerr') }}"
# Type: string
maintainerr2_dns_record: "{{ lookup('role_var', '_web_subdomain', role='maintainerr') }}"
maintainerr_role_dns_zonemaintainerr2_dns_zone
# Type: string
maintainerr_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='maintainerr') }}"
# Type: string
maintainerr2_dns_zone: "{{ lookup('role_var', '_web_domain', role='maintainerr') }}"
maintainerr_role_dns_proxymaintainerr2_dns_proxy
# Type: bool (true/false)
maintainerr_role_dns_proxy: "{{ dns_proxied }}"
# Type: bool (true/false)
maintainerr2_dns_proxy: "{{ dns_proxied }}"
maintainerr_role_traefik_sso_middlewaremaintainerr2_traefik_sso_middleware
# Type: string
maintainerr_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"
# Type: string
maintainerr2_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"
maintainerr_role_traefik_middleware_defaultmaintainerr2_traefik_middleware_default
# Type: string
maintainerr_role_traefik_middleware_default: "{{ traefik_default_middleware }}"
# Type: string
maintainerr2_traefik_middleware_default: "{{ traefik_default_middleware }}"
maintainerr_role_traefik_middleware_custommaintainerr2_traefik_middleware_custom
# Type: string
maintainerr_role_traefik_middleware_custom: ""
# Type: string
maintainerr2_traefik_middleware_custom: ""
maintainerr_role_traefik_certresolvermaintainerr2_traefik_certresolver
# Type: string
maintainerr_role_traefik_certresolver: "{{ traefik_default_certresolver }}"
# Type: string
maintainerr2_traefik_certresolver: "{{ traefik_default_certresolver }}"
maintainerr_role_traefik_enabledmaintainerr2_traefik_enabled
# Type: bool (true/false)
maintainerr_role_traefik_enabled: true
# Type: bool (true/false)
maintainerr2_traefik_enabled: true
maintainerr_role_traefik_api_enabledmaintainerr2_traefik_api_enabled
# Type: bool (true/false)
maintainerr_role_traefik_api_enabled: false
# Type: bool (true/false)
maintainerr2_traefik_api_enabled: false
maintainerr_role_traefik_api_endpointmaintainerr2_traefik_api_endpoint
# Type: string
maintainerr_role_traefik_api_endpoint: ""
# Type: string
maintainerr2_traefik_api_endpoint: ""
Container
maintainerr_role_docker_containermaintainerr2_docker_container
# Type: string
maintainerr_role_docker_container: "{{ maintainerr_name }}"
# Type: string
maintainerr2_docker_container: "{{ maintainerr_name }}"
Image
maintainerr_role_docker_image_pullmaintainerr2_docker_image_pull
# Type: bool (true/false)
maintainerr_role_docker_image_pull: true
# Type: bool (true/false)
maintainerr2_docker_image_pull: true
maintainerr_role_docker_image_repomaintainerr2_docker_image_repo
# Type: string
maintainerr_role_docker_image_repo: "jorenn92/maintainerr"
# Type: string
maintainerr2_docker_image_repo: "jorenn92/maintainerr"
maintainerr_role_docker_image_tagmaintainerr2_docker_image_tag
# Type: string
maintainerr_role_docker_image_tag: "latest"
# Type: string
maintainerr2_docker_image_tag: "latest"
maintainerr_role_docker_imagemaintainerr2_docker_image
# Type: string
maintainerr_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='maintainerr') }}:{{ lookup('role_var', '_docker_image_tag', role='maintainerr') }}"
# Type: string
maintainerr2_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='maintainerr') }}:{{ lookup('role_var', '_docker_image_tag', role='maintainerr') }}"
Envs
maintainerr_role_docker_envs_defaultmaintainerr2_docker_envs_default
# Type: dict
maintainerr_role_docker_envs_default:
TZ: "{{ tz }}"
# Type: dict
maintainerr2_docker_envs_default:
TZ: "{{ tz }}"
maintainerr_role_docker_envs_custommaintainerr2_docker_envs_custom
# Type: dict
maintainerr_role_docker_envs_custom: {}
# Type: dict
maintainerr2_docker_envs_custom: {}
Volumes
maintainerr_role_docker_volumes_defaultmaintainerr2_docker_volumes_default
# Type: list
maintainerr_role_docker_volumes_default:
- "{{ lookup('role_var', '_paths_location', role='maintainerr') }}:/opt/data"
# Type: list
maintainerr2_docker_volumes_default:
- "{{ lookup('role_var', '_paths_location', role='maintainerr') }}:/opt/data"
maintainerr_role_docker_volumes_custommaintainerr2_docker_volumes_custom
# Type: list
maintainerr_role_docker_volumes_custom: []
# Type: list
maintainerr2_docker_volumes_custom: []
Hostname
maintainerr_role_docker_hostnamemaintainerr2_docker_hostname
# Type: string
maintainerr_role_docker_hostname: "{{ maintainerr_name }}"
# Type: string
maintainerr2_docker_hostname: "{{ maintainerr_name }}"
Networks
maintainerr_role_docker_networks_aliasmaintainerr2_docker_networks_alias
# Type: string
maintainerr_role_docker_networks_alias: "{{ maintainerr_name }}"
# Type: string
maintainerr2_docker_networks_alias: "{{ maintainerr_name }}"
maintainerr_role_docker_networks_defaultmaintainerr2_docker_networks_default
# Type: list
maintainerr_role_docker_networks_default: []
# Type: list
maintainerr2_docker_networks_default: []
maintainerr_role_docker_networks_custommaintainerr2_docker_networks_custom
# Type: list
maintainerr_role_docker_networks_custom: []
# Type: list
maintainerr2_docker_networks_custom: []
Restart Policy
maintainerr_role_docker_restart_policymaintainerr2_docker_restart_policy
# Type: string
maintainerr_role_docker_restart_policy: unless-stopped
# Type: string
maintainerr2_docker_restart_policy: unless-stopped
State
maintainerr_role_docker_statemaintainerr2_docker_state
# Type: string
maintainerr_role_docker_state: started
# Type: string
maintainerr2_docker_state: started
User
maintainerr_role_docker_usermaintainerr2_docker_user
# Type: string
maintainerr_role_docker_user: "{{ uid }}:{{ gid }}"
# Type: string
maintainerr2_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
maintainerr_role_docker_blkio_weightmaintainerr2_docker_blkio_weight
# Type: int
maintainerr_role_docker_blkio_weight:
# Type: int
maintainerr2_docker_blkio_weight:
maintainerr_role_docker_cpu_periodmaintainerr2_docker_cpu_period
# Type: int
maintainerr_role_docker_cpu_period:
# Type: int
maintainerr2_docker_cpu_period:
maintainerr_role_docker_cpu_quotamaintainerr2_docker_cpu_quota
# Type: int
maintainerr_role_docker_cpu_quota:
# Type: int
maintainerr2_docker_cpu_quota:
maintainerr_role_docker_cpu_sharesmaintainerr2_docker_cpu_shares
# Type: int
maintainerr_role_docker_cpu_shares:
# Type: int
maintainerr2_docker_cpu_shares:
maintainerr_role_docker_cpusmaintainerr2_docker_cpus
# Type: string
maintainerr_role_docker_cpus:
# Type: string
maintainerr2_docker_cpus:
maintainerr_role_docker_cpuset_cpusmaintainerr2_docker_cpuset_cpus
# Type: string
maintainerr_role_docker_cpuset_cpus:
# Type: string
maintainerr2_docker_cpuset_cpus:
maintainerr_role_docker_cpuset_memsmaintainerr2_docker_cpuset_mems
# Type: string
maintainerr_role_docker_cpuset_mems:
# Type: string
maintainerr2_docker_cpuset_mems:
maintainerr_role_docker_kernel_memorymaintainerr2_docker_kernel_memory
# Type: string
maintainerr_role_docker_kernel_memory:
# Type: string
maintainerr2_docker_kernel_memory:
maintainerr_role_docker_memorymaintainerr2_docker_memory
# Type: string
maintainerr_role_docker_memory:
# Type: string
maintainerr2_docker_memory:
maintainerr_role_docker_memory_reservationmaintainerr2_docker_memory_reservation
# Type: string
maintainerr_role_docker_memory_reservation:
# Type: string
maintainerr2_docker_memory_reservation:
maintainerr_role_docker_memory_swapmaintainerr2_docker_memory_swap
# Type: string
maintainerr_role_docker_memory_swap:
# Type: string
maintainerr2_docker_memory_swap:
maintainerr_role_docker_memory_swappinessmaintainerr2_docker_memory_swappiness
# Type: int
maintainerr_role_docker_memory_swappiness:
# Type: int
maintainerr2_docker_memory_swappiness:
maintainerr_role_docker_shm_sizemaintainerr2_docker_shm_size
# Type: string
maintainerr_role_docker_shm_size:
# Type: string
maintainerr2_docker_shm_size:
Security & Devices
maintainerr_role_docker_cap_dropmaintainerr2_docker_cap_drop
# Type: list
maintainerr_role_docker_cap_drop:
# Type: list
maintainerr2_docker_cap_drop:
maintainerr_role_docker_cgroupns_modemaintainerr2_docker_cgroupns_mode
# Type: string
maintainerr_role_docker_cgroupns_mode:
# Type: string
maintainerr2_docker_cgroupns_mode:
maintainerr_role_docker_device_cgroup_rulesmaintainerr2_docker_device_cgroup_rules
# Type: list
maintainerr_role_docker_device_cgroup_rules:
# Type: list
maintainerr2_docker_device_cgroup_rules:
maintainerr_role_docker_device_read_bpsmaintainerr2_docker_device_read_bps
# Type: list
maintainerr_role_docker_device_read_bps:
# Type: list
maintainerr2_docker_device_read_bps:
maintainerr_role_docker_device_read_iopsmaintainerr2_docker_device_read_iops
# Type: list
maintainerr_role_docker_device_read_iops:
# Type: list
maintainerr2_docker_device_read_iops:
maintainerr_role_docker_device_requestsmaintainerr2_docker_device_requests
# Type: list
maintainerr_role_docker_device_requests:
# Type: list
maintainerr2_docker_device_requests:
maintainerr_role_docker_device_write_bpsmaintainerr2_docker_device_write_bps
# Type: list
maintainerr_role_docker_device_write_bps:
# Type: list
maintainerr2_docker_device_write_bps:
maintainerr_role_docker_device_write_iopsmaintainerr2_docker_device_write_iops
# Type: list
maintainerr_role_docker_device_write_iops:
# Type: list
maintainerr2_docker_device_write_iops:
maintainerr_role_docker_devicesmaintainerr2_docker_devices
# Type: list
maintainerr_role_docker_devices:
# Type: list
maintainerr2_docker_devices:
maintainerr_role_docker_devices_defaultmaintainerr2_docker_devices_default
# Type: string
maintainerr_role_docker_devices_default:
# Type: string
maintainerr2_docker_devices_default:
maintainerr_role_docker_groupsmaintainerr2_docker_groups
# Type: list
maintainerr_role_docker_groups:
# Type: list
maintainerr2_docker_groups:
maintainerr_role_docker_privilegedmaintainerr2_docker_privileged
# Type: bool (true/false)
maintainerr_role_docker_privileged:
# Type: bool (true/false)
maintainerr2_docker_privileged:
maintainerr_role_docker_security_optsmaintainerr2_docker_security_opts
# Type: list
maintainerr_role_docker_security_opts:
# Type: list
maintainerr2_docker_security_opts:
maintainerr_role_docker_userns_modemaintainerr2_docker_userns_mode
# Type: string
maintainerr_role_docker_userns_mode:
# Type: string
maintainerr2_docker_userns_mode:
Networking
maintainerr_role_docker_dns_optsmaintainerr2_docker_dns_opts
# Type: list
maintainerr_role_docker_dns_opts:
# Type: list
maintainerr2_docker_dns_opts:
maintainerr_role_docker_dns_search_domainsmaintainerr2_docker_dns_search_domains
# Type: list
maintainerr_role_docker_dns_search_domains:
# Type: list
maintainerr2_docker_dns_search_domains:
maintainerr_role_docker_dns_serversmaintainerr2_docker_dns_servers
# Type: list
maintainerr_role_docker_dns_servers:
# Type: list
maintainerr2_docker_dns_servers:
maintainerr_role_docker_domainnamemaintainerr2_docker_domainname
# Type: string
maintainerr_role_docker_domainname:
# Type: string
maintainerr2_docker_domainname:
maintainerr_role_docker_exposed_portsmaintainerr2_docker_exposed_ports
# Type: list
maintainerr_role_docker_exposed_ports:
# Type: list
maintainerr2_docker_exposed_ports:
maintainerr_role_docker_hostsmaintainerr2_docker_hosts
# Type: dict
maintainerr_role_docker_hosts:
# Type: dict
maintainerr2_docker_hosts:
maintainerr_role_docker_hosts_use_commonmaintainerr2_docker_hosts_use_common
# Type: bool (true/false)
maintainerr_role_docker_hosts_use_common:
# Type: bool (true/false)
maintainerr2_docker_hosts_use_common:
maintainerr_role_docker_ipc_modemaintainerr2_docker_ipc_mode
# Type: string
maintainerr_role_docker_ipc_mode:
# Type: string
maintainerr2_docker_ipc_mode:
maintainerr_role_docker_linksmaintainerr2_docker_links
# Type: list
maintainerr_role_docker_links:
# Type: list
maintainerr2_docker_links:
maintainerr_role_docker_network_modemaintainerr2_docker_network_mode
# Type: string
maintainerr_role_docker_network_mode:
# Type: string
maintainerr2_docker_network_mode:
maintainerr_role_docker_pid_modemaintainerr2_docker_pid_mode
# Type: string
maintainerr_role_docker_pid_mode:
# Type: string
maintainerr2_docker_pid_mode:
maintainerr_role_docker_portsmaintainerr2_docker_ports
# Type: list
maintainerr_role_docker_ports:
# Type: list
maintainerr2_docker_ports:
maintainerr_role_docker_utsmaintainerr2_docker_uts
# Type: string
maintainerr_role_docker_uts:
# Type: string
maintainerr2_docker_uts:
Storage
maintainerr_role_docker_keep_volumesmaintainerr2_docker_keep_volumes
# Type: bool (true/false)
maintainerr_role_docker_keep_volumes:
# Type: bool (true/false)
maintainerr2_docker_keep_volumes:
maintainerr_role_docker_mountsmaintainerr2_docker_mounts
# Type: list
maintainerr_role_docker_mounts:
# Type: list
maintainerr2_docker_mounts:
maintainerr_role_docker_storage_optsmaintainerr2_docker_storage_opts
# Type: dict
maintainerr_role_docker_storage_opts:
# Type: dict
maintainerr2_docker_storage_opts:
maintainerr_role_docker_tmpfsmaintainerr2_docker_tmpfs
# Type: list
maintainerr_role_docker_tmpfs:
# Type: list
maintainerr2_docker_tmpfs:
maintainerr_role_docker_volume_drivermaintainerr2_docker_volume_driver
# Type: string
maintainerr_role_docker_volume_driver:
# Type: string
maintainerr2_docker_volume_driver:
maintainerr_role_docker_volumes_frommaintainerr2_docker_volumes_from
# Type: list
maintainerr_role_docker_volumes_from:
# Type: list
maintainerr2_docker_volumes_from:
maintainerr_role_docker_volumes_globalmaintainerr2_docker_volumes_global
# Type: bool (true/false)
maintainerr_role_docker_volumes_global:
# Type: bool (true/false)
maintainerr2_docker_volumes_global:
maintainerr_role_docker_working_dirmaintainerr2_docker_working_dir
# Type: string
maintainerr_role_docker_working_dir:
# Type: string
maintainerr2_docker_working_dir:
Monitoring & Lifecycle
maintainerr_role_docker_auto_removemaintainerr2_docker_auto_remove
# Type: bool (true/false)
maintainerr_role_docker_auto_remove:
# Type: bool (true/false)
maintainerr2_docker_auto_remove:
maintainerr_role_docker_cleanupmaintainerr2_docker_cleanup
# Type: bool (true/false)
maintainerr_role_docker_cleanup:
# Type: bool (true/false)
maintainerr2_docker_cleanup:
maintainerr_role_docker_force_killmaintainerr2_docker_force_kill
# Type: string
maintainerr_role_docker_force_kill:
# Type: string
maintainerr2_docker_force_kill:
maintainerr_role_docker_healthcheckmaintainerr2_docker_healthcheck
# Type: dict
maintainerr_role_docker_healthcheck:
# Type: dict
maintainerr2_docker_healthcheck:
maintainerr_role_docker_healthy_wait_timeoutmaintainerr2_docker_healthy_wait_timeout
# Type: int
maintainerr_role_docker_healthy_wait_timeout:
# Type: int
maintainerr2_docker_healthy_wait_timeout:
maintainerr_role_docker_initmaintainerr2_docker_init
# Type: bool (true/false)
maintainerr_role_docker_init:
# Type: bool (true/false)
maintainerr2_docker_init:
maintainerr_role_docker_kill_signalmaintainerr2_docker_kill_signal
# Type: string
maintainerr_role_docker_kill_signal:
# Type: string
maintainerr2_docker_kill_signal:
maintainerr_role_docker_log_drivermaintainerr2_docker_log_driver
# Type: string
maintainerr_role_docker_log_driver:
# Type: string
maintainerr2_docker_log_driver:
maintainerr_role_docker_log_optionsmaintainerr2_docker_log_options
# Type: dict
maintainerr_role_docker_log_options:
# Type: dict
maintainerr2_docker_log_options:
maintainerr_role_docker_oom_killermaintainerr2_docker_oom_killer
# Type: bool (true/false)
maintainerr_role_docker_oom_killer:
# Type: bool (true/false)
maintainerr2_docker_oom_killer:
maintainerr_role_docker_oom_score_adjmaintainerr2_docker_oom_score_adj
# Type: int
maintainerr_role_docker_oom_score_adj:
# Type: int
maintainerr2_docker_oom_score_adj:
maintainerr_role_docker_output_logsmaintainerr2_docker_output_logs
# Type: bool (true/false)
maintainerr_role_docker_output_logs:
# Type: bool (true/false)
maintainerr2_docker_output_logs:
maintainerr_role_docker_pausedmaintainerr2_docker_paused
# Type: bool (true/false)
maintainerr_role_docker_paused:
# Type: bool (true/false)
maintainerr2_docker_paused:
maintainerr_role_docker_recreatemaintainerr2_docker_recreate
# Type: bool (true/false)
maintainerr_role_docker_recreate:
# Type: bool (true/false)
maintainerr2_docker_recreate:
maintainerr_role_docker_restart_retriesmaintainerr2_docker_restart_retries
# Type: int
maintainerr_role_docker_restart_retries:
# Type: int
maintainerr2_docker_restart_retries:
maintainerr_role_docker_stop_timeoutmaintainerr2_docker_stop_timeout
# Type: int
maintainerr_role_docker_stop_timeout:
# Type: int
maintainerr2_docker_stop_timeout:
Other Options
maintainerr_role_docker_capabilitiesmaintainerr2_docker_capabilities
# Type: list
maintainerr_role_docker_capabilities:
# Type: list
maintainerr2_docker_capabilities:
maintainerr_role_docker_cgroup_parentmaintainerr2_docker_cgroup_parent
# Type: string
maintainerr_role_docker_cgroup_parent:
# Type: string
maintainerr2_docker_cgroup_parent:
maintainerr_role_docker_commandsmaintainerr2_docker_commands
# Type: list
maintainerr_role_docker_commands:
# Type: list
maintainerr2_docker_commands:
maintainerr_role_docker_create_timeoutmaintainerr2_docker_create_timeout
# Type: int
maintainerr_role_docker_create_timeout:
# Type: int
maintainerr2_docker_create_timeout:
maintainerr_role_docker_entrypointmaintainerr2_docker_entrypoint
# Type: string
maintainerr_role_docker_entrypoint:
# Type: string
maintainerr2_docker_entrypoint:
maintainerr_role_docker_env_filemaintainerr2_docker_env_file
# Type: string
maintainerr_role_docker_env_file:
# Type: string
maintainerr2_docker_env_file:
maintainerr_role_docker_labelsmaintainerr2_docker_labels
# Type: dict
maintainerr_role_docker_labels:
# Type: dict
maintainerr2_docker_labels:
maintainerr_role_docker_labels_use_commonmaintainerr2_docker_labels_use_common
# Type: bool (true/false)
maintainerr_role_docker_labels_use_common:
# Type: bool (true/false)
maintainerr2_docker_labels_use_common:
maintainerr_role_docker_read_onlymaintainerr2_docker_read_only
# Type: bool (true/false)
maintainerr_role_docker_read_only:
# Type: bool (true/false)
maintainerr2_docker_read_only:
maintainerr_role_docker_runtimemaintainerr2_docker_runtime
# Type: string
maintainerr_role_docker_runtime:
# Type: string
maintainerr2_docker_runtime:
maintainerr_role_docker_sysctlsmaintainerr2_docker_sysctls
# Type: list
maintainerr_role_docker_sysctls:
# Type: list
maintainerr2_docker_sysctls:
maintainerr_role_docker_ulimitsmaintainerr2_docker_ulimits
# Type: list
maintainerr_role_docker_ulimits:
# Type: list
maintainerr2_docker_ulimits:
maintainerr_role_autoheal_enabledmaintainerr2_autoheal_enabled
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
maintainerr_role_autoheal_enabled: true
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
maintainerr2_autoheal_enabled: true
maintainerr_role_depends_onmaintainerr2_depends_on
# List of container dependencies that must be running before containers start
# Type: string
maintainerr_role_depends_on: ""
# List of container dependencies that must be running before containers start
# Type: string
maintainerr2_depends_on: ""
maintainerr_role_depends_on_delaymaintainerr2_depends_on_delay
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
maintainerr_role_depends_on_delay: "0"
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
maintainerr2_depends_on_delay: "0"
maintainerr_role_depends_on_healthchecksmaintainerr2_depends_on_healthchecks
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
maintainerr_role_depends_on_healthchecks:
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
maintainerr2_depends_on_healthchecks:
maintainerr_role_diun_enabledmaintainerr2_diun_enabled
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
maintainerr_role_diun_enabled: true
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
maintainerr2_diun_enabled: true
maintainerr_role_dns_enabledmaintainerr2_dns_enabled
# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
maintainerr_role_dns_enabled: true
# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
maintainerr2_dns_enabled: true
maintainerr_role_docker_controllermaintainerr2_docker_controller
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
maintainerr_role_docker_controller: true
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
maintainerr2_docker_controller: true
maintainerr_role_docker_image_repomaintainerr2_docker_image_repo
# Type: string
maintainerr_role_docker_image_repo:
# Type: string
maintainerr2_docker_image_repo:
maintainerr_role_docker_image_tagmaintainerr2_docker_image_tag
# Type: string
maintainerr_role_docker_image_tag:
# Type: string
maintainerr2_docker_image_tag:
maintainerr_role_docker_volumes_downloadmaintainerr2_docker_volumes_download
# Type: bool (true/false)
maintainerr_role_docker_volumes_download:
# Type: bool (true/false)
maintainerr2_docker_volumes_download:
maintainerr_role_paths_locationmaintainerr2_paths_location
# Type: string
maintainerr_role_paths_location:
# Type: string
maintainerr2_paths_location:
maintainerr_role_themepark_addonsmaintainerr2_themepark_addons
# Type: string
maintainerr_role_themepark_addons:
# Type: string
maintainerr2_themepark_addons:
maintainerr_role_themepark_appmaintainerr2_themepark_app
# Type: string
maintainerr_role_themepark_app:
# Type: string
maintainerr2_themepark_app:
maintainerr_role_themepark_thememaintainerr2_themepark_theme
# Type: string
maintainerr_role_themepark_theme:
# Type: string
maintainerr2_themepark_theme:
maintainerr_role_traefik_api_endpointmaintainerr2_traefik_api_endpoint
# Type: dict/omit
maintainerr_role_traefik_api_endpoint:
# Type: dict/omit
maintainerr2_traefik_api_endpoint:
maintainerr_role_traefik_api_middlewaremaintainerr2_traefik_api_middleware
# Type: string
maintainerr_role_traefik_api_middleware:
# Type: string
maintainerr2_traefik_api_middleware:
maintainerr_role_traefik_api_middleware_httpmaintainerr2_traefik_api_middleware_http
# Type: string
maintainerr_role_traefik_api_middleware_http:
# Type: string
maintainerr2_traefik_api_middleware_http:
maintainerr_role_traefik_autodetect_enabledmaintainerr2_traefik_autodetect_enabled
# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
maintainerr_role_traefik_autodetect_enabled: false
# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
maintainerr2_traefik_autodetect_enabled: false
maintainerr_role_traefik_certresolvermaintainerr2_traefik_certresolver
# Type: string
maintainerr_role_traefik_certresolver:
# Type: string
maintainerr2_traefik_certresolver:
maintainerr_role_traefik_crowdsec_enabledmaintainerr2_traefik_crowdsec_enabled
# Enable CrowdSec middleware for containers
# Type: bool (true/false)
maintainerr_role_traefik_crowdsec_enabled: false
# Enable CrowdSec middleware for containers
# Type: bool (true/false)
maintainerr2_traefik_crowdsec_enabled: false
maintainerr_role_traefik_error_pages_enabledmaintainerr2_traefik_error_pages_enabled
# Enable custom error pages middleware for containers
# Type: bool (true/false)
maintainerr_role_traefik_error_pages_enabled: false
# Enable custom error pages middleware for containers
# Type: bool (true/false)
maintainerr2_traefik_error_pages_enabled: false
maintainerr_role_traefik_gzip_enabledmaintainerr2_traefik_gzip_enabled
# Enable gzip compression middleware for containers
# Type: bool (true/false)
maintainerr_role_traefik_gzip_enabled: false
# Enable gzip compression middleware for containers
# Type: bool (true/false)
maintainerr2_traefik_gzip_enabled: false
maintainerr_role_traefik_middleware_httpmaintainerr2_traefik_middleware_http
# Type: string
maintainerr_role_traefik_middleware_http:
# Type: string
maintainerr2_traefik_middleware_http:
maintainerr_role_traefik_middleware_http_api_insecuremaintainerr2_traefik_middleware_http_api_insecure
# Type: bool (true/false)
maintainerr_role_traefik_middleware_http_api_insecure:
# Type: bool (true/false)
maintainerr2_traefik_middleware_http_api_insecure:
maintainerr_role_traefik_middleware_http_insecuremaintainerr2_traefik_middleware_http_insecure
# Type: bool (true/false)
maintainerr_role_traefik_middleware_http_insecure:
# Type: bool (true/false)
maintainerr2_traefik_middleware_http_insecure:
maintainerr_role_traefik_prioritymaintainerr2_traefik_priority
# Type: string
maintainerr_role_traefik_priority:
# Type: string
maintainerr2_traefik_priority:
maintainerr_role_traefik_robot_enabledmaintainerr2_traefik_robot_enabled
# Enable robots.txt middleware for containers
# Type: bool (true/false)
maintainerr_role_traefik_robot_enabled: true
# Enable robots.txt middleware for containers
# Type: bool (true/false)
maintainerr2_traefik_robot_enabled: true
maintainerr_role_traefik_tailscale_enabledmaintainerr2_traefik_tailscale_enabled
# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
maintainerr_role_traefik_tailscale_enabled: false
# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
maintainerr2_traefik_tailscale_enabled: false
maintainerr_role_traefik_wildcard_enabledmaintainerr2_traefik_wildcard_enabled
# Enable wildcard certificate for containers
# Type: bool (true/false)
maintainerr_role_traefik_wildcard_enabled: true
# Enable wildcard certificate for containers
# Type: bool (true/false)
maintainerr2_traefik_wildcard_enabled: true
maintainerr_role_web_domainmaintainerr2_web_domain
# Type: string
maintainerr_role_web_domain:
# Type: string
maintainerr2_web_domain:
maintainerr_role_web_fqdn_overridemaintainerr2_web_fqdn_override
# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
maintainerr_role_web_fqdn_override:
# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
maintainerr2_web_fqdn_override:
Example Override
maintainerr_role_web_fqdn_override:
- "{{ traefik_host }}"
- "maintainerr2.{{ user.domain }}"
- "maintainerr.otherdomain.tld"
Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries
Example Override
maintainerr2_web_fqdn_override:
- "{{ traefik_host }}"
- "maintainerr2.{{ user.domain }}"
- "maintainerr.otherdomain.tld"
Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries
maintainerr_role_web_host_overridemaintainerr2_web_host_override
# Override the Traefik web host configuration for containers
# Type: string
maintainerr_role_web_host_override:
# Override the Traefik web host configuration for containers
# Type: string
maintainerr2_web_host_override:
Example Override
maintainerr_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'maintainerr2.' + user.domain }}`)"
Note: Use {{ traefik_host }} to include the default host configuration in your custom rule
Example Override
maintainerr2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'maintainerr2.' + user.domain }}`)"
Note: Use {{ traefik_host }} to include the default host configuration in your custom rule
maintainerr_role_web_http_portmaintainerr2_web_http_port
# Type: string (quoted number)
maintainerr_role_web_http_port:
# Type: string (quoted number)
maintainerr2_web_http_port:
maintainerr_role_web_http_schememaintainerr2_web_http_scheme
# Type: string ("http"/"https")
maintainerr_role_web_http_scheme:
# Type: string ("http"/"https")
maintainerr2_web_http_scheme:
maintainerr_role_web_http_serverstransportmaintainerr2_web_http_serverstransport
# Type: dict/omit
maintainerr_role_web_http_serverstransport:
# Type: dict/omit
maintainerr2_web_http_serverstransport:
maintainerr_role_web_schememaintainerr2_web_scheme
# URL scheme to use for web access to containers
# Type: string ("http"/"https")
maintainerr_role_web_scheme:
# URL scheme to use for web access to containers
# Type: string ("http"/"https")
maintainerr2_web_scheme:
maintainerr_role_web_serverstransportmaintainerr2_web_serverstransport
# Type: dict/omit
maintainerr_role_web_serverstransport:
# Type: dict/omit
maintainerr2_web_serverstransport:
maintainerr_role_web_subdomainmaintainerr2_web_subdomain
# Type: string
maintainerr_role_web_subdomain:
# Type: string
maintainerr2_web_subdomain: