Skip to content

Profilarr

Description / nameInput element
Your domain name

Overview

Profilarr is a configuration management and auto-import tool for Radarr/Sonarr custom formats and profiles.


Beta software / Modifies PVR configuration

Although core features are expected to work, this application is in early stages of development. It's recommended to back up your Radarr and Sonarr databases before running import or sync operations.

Deployment

sb install sandbox-profilarr

Usage

Visit https://profilarr.iYOUR_DOMAIN_NAMEi.

Role Defaults

Use the Inventory to customize variables. (1)

  1. Example override

    profilarr_name: "custom_value"
    

    Avoid overriding variables ending in _default

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

profilarr_name
# Type: string
profilarr_name: profilarr
profilarr_role_web_subdomain
# Type: string
profilarr_role_web_subdomain: "{{ profilarr_name }}"
profilarr_role_web_domain
# Type: string
profilarr_role_web_domain: "{{ user.domain }}"
profilarr_role_web_port
# Type: string
profilarr_role_web_port: "6868"
profilarr_role_web_url
# Type: string
profilarr_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='profilarr') + '.' + lookup('role_var', '_web_domain', role='profilarr')
                         if (lookup('role_var', '_web_subdomain', role='profilarr') | length > 0)
                         else lookup('role_var', '_web_domain', role='profilarr')) }}"
profilarr_role_dns_record
# Type: string
profilarr_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='profilarr') }}"
profilarr_role_dns_zone
# Type: string
profilarr_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='profilarr') }}"
profilarr_role_dns_proxy
# Type: bool (true/false)
profilarr_role_dns_proxy: "{{ dns_proxied }}"
profilarr_role_traefik_sso_middleware
# Type: string
profilarr_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"
profilarr_role_traefik_middleware_default
# Type: string
profilarr_role_traefik_middleware_default: "{{ traefik_default_middleware }}"
profilarr_role_traefik_middleware_custom
# Type: string
profilarr_role_traefik_middleware_custom: ""
profilarr_role_traefik_certresolver
# Type: string
profilarr_role_traefik_certresolver: "{{ traefik_default_certresolver }}"
profilarr_role_traefik_enabled
# Type: bool (true/false)
profilarr_role_traefik_enabled: true
profilarr_role_traefik_api_enabled
# Type: bool (true/false)
profilarr_role_traefik_api_enabled: true
profilarr_role_traefik_api_endpoint
# Type: string
profilarr_role_traefik_api_endpoint: "PathPrefix(`/api`)"

Container

profilarr_role_docker_container
# Type: string
profilarr_role_docker_container: "{{ profilarr_name }}"

Image

profilarr_role_docker_image_pull
# Type: bool (true/false)
profilarr_role_docker_image_pull: true
profilarr_role_docker_image_repo
# Type: string
profilarr_role_docker_image_repo: "santiagosayshey/profilarr"
profilarr_role_docker_image_tag
# Type: string
profilarr_role_docker_image_tag: "latest"
profilarr_role_docker_image
# Type: string
profilarr_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='profilarr') }}:{{ lookup('role_var', '_docker_image_tag', role='profilarr') }}"

Envs

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

Volumes

profilarr_role_docker_volumes_default
# Type: list
profilarr_role_docker_volumes_default:
  - "{{ profilarr_role_paths_location }}:/config"
profilarr_role_docker_volumes_custom
# Type: list
profilarr_role_docker_volumes_custom: []

Hostname

profilarr_role_docker_hostname
# Type: string
profilarr_role_docker_hostname: "{{ profilarr_name }}"

Networks

profilarr_role_docker_networks_alias
# Type: string
profilarr_role_docker_networks_alias: "{{ profilarr_name }}"
profilarr_role_docker_networks_default
# Type: list
profilarr_role_docker_networks_default: []
profilarr_role_docker_networks_custom
# Type: list
profilarr_role_docker_networks_custom: []

Restart Policy

profilarr_role_docker_restart_policy
# Type: string
profilarr_role_docker_restart_policy: unless-stopped

State

profilarr_role_docker_state
# Type: string
profilarr_role_docker_state: started

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

profilarr_role_docker_blkio_weight
# Type: int
profilarr_role_docker_blkio_weight:
profilarr_role_docker_cpu_period
# Type: int
profilarr_role_docker_cpu_period:
profilarr_role_docker_cpu_quota
# Type: int
profilarr_role_docker_cpu_quota:
profilarr_role_docker_cpu_shares
# Type: int
profilarr_role_docker_cpu_shares:
profilarr_role_docker_cpus
# Type: string
profilarr_role_docker_cpus:
profilarr_role_docker_cpuset_cpus
# Type: string
profilarr_role_docker_cpuset_cpus:
profilarr_role_docker_cpuset_mems
# Type: string
profilarr_role_docker_cpuset_mems:
profilarr_role_docker_kernel_memory
# Type: string
profilarr_role_docker_kernel_memory:
profilarr_role_docker_memory
# Type: string
profilarr_role_docker_memory:
profilarr_role_docker_memory_reservation
# Type: string
profilarr_role_docker_memory_reservation:
profilarr_role_docker_memory_swap
# Type: string
profilarr_role_docker_memory_swap:
profilarr_role_docker_memory_swappiness
# Type: int
profilarr_role_docker_memory_swappiness:
profilarr_role_docker_shm_size
# Type: string
profilarr_role_docker_shm_size:

Security & Devices

profilarr_role_docker_cap_drop
# Type: list
profilarr_role_docker_cap_drop:
profilarr_role_docker_cgroupns_mode
# Type: string
profilarr_role_docker_cgroupns_mode:
profilarr_role_docker_device_cgroup_rules
# Type: list
profilarr_role_docker_device_cgroup_rules:
profilarr_role_docker_device_read_bps
# Type: list
profilarr_role_docker_device_read_bps:
profilarr_role_docker_device_read_iops
# Type: list
profilarr_role_docker_device_read_iops:
profilarr_role_docker_device_requests
# Type: list
profilarr_role_docker_device_requests:
profilarr_role_docker_device_write_bps
# Type: list
profilarr_role_docker_device_write_bps:
profilarr_role_docker_device_write_iops
# Type: list
profilarr_role_docker_device_write_iops:
profilarr_role_docker_devices
# Type: list
profilarr_role_docker_devices:
profilarr_role_docker_devices_default
# Type: string
profilarr_role_docker_devices_default:
profilarr_role_docker_groups
# Type: list
profilarr_role_docker_groups:
profilarr_role_docker_privileged
# Type: bool (true/false)
profilarr_role_docker_privileged:
profilarr_role_docker_security_opts
# Type: list
profilarr_role_docker_security_opts:
profilarr_role_docker_user
# Type: string
profilarr_role_docker_user:
profilarr_role_docker_userns_mode
# Type: string
profilarr_role_docker_userns_mode:

Networking

profilarr_role_docker_dns_opts
# Type: list
profilarr_role_docker_dns_opts:
profilarr_role_docker_dns_search_domains
# Type: list
profilarr_role_docker_dns_search_domains:
profilarr_role_docker_dns_servers
# Type: list
profilarr_role_docker_dns_servers:
profilarr_role_docker_domainname
# Type: string
profilarr_role_docker_domainname:
profilarr_role_docker_exposed_ports
# Type: list
profilarr_role_docker_exposed_ports:
profilarr_role_docker_hosts
# Type: dict
profilarr_role_docker_hosts:
profilarr_role_docker_hosts_use_common
# Type: bool (true/false)
profilarr_role_docker_hosts_use_common:
profilarr_role_docker_ipc_mode
# Type: string
profilarr_role_docker_ipc_mode:
profilarr_role_docker_links
# Type: list
profilarr_role_docker_links:
profilarr_role_docker_network_mode
# Type: string
profilarr_role_docker_network_mode:
profilarr_role_docker_pid_mode
# Type: string
profilarr_role_docker_pid_mode:
profilarr_role_docker_ports
# Type: list
profilarr_role_docker_ports:
profilarr_role_docker_uts
# Type: string
profilarr_role_docker_uts:

Storage

profilarr_role_docker_keep_volumes
# Type: bool (true/false)
profilarr_role_docker_keep_volumes:
profilarr_role_docker_mounts
# Type: list
profilarr_role_docker_mounts:
profilarr_role_docker_storage_opts
# Type: dict
profilarr_role_docker_storage_opts:
profilarr_role_docker_tmpfs
# Type: list
profilarr_role_docker_tmpfs:
profilarr_role_docker_volume_driver
# Type: string
profilarr_role_docker_volume_driver:
profilarr_role_docker_volumes_from
# Type: list
profilarr_role_docker_volumes_from:
profilarr_role_docker_volumes_global
# Type: bool (true/false)
profilarr_role_docker_volumes_global:
profilarr_role_docker_working_dir
# Type: string
profilarr_role_docker_working_dir:

Monitoring & Lifecycle

profilarr_role_docker_auto_remove
# Type: bool (true/false)
profilarr_role_docker_auto_remove:
profilarr_role_docker_cleanup
# Type: bool (true/false)
profilarr_role_docker_cleanup:
profilarr_role_docker_force_kill
# Type: string
profilarr_role_docker_force_kill:
profilarr_role_docker_healthcheck
# Type: dict
profilarr_role_docker_healthcheck:
profilarr_role_docker_healthy_wait_timeout
# Type: int
profilarr_role_docker_healthy_wait_timeout:
profilarr_role_docker_init
# Type: bool (true/false)
profilarr_role_docker_init:
profilarr_role_docker_kill_signal
# Type: string
profilarr_role_docker_kill_signal:
profilarr_role_docker_log_driver
# Type: string
profilarr_role_docker_log_driver:
profilarr_role_docker_log_options
# Type: dict
profilarr_role_docker_log_options:
profilarr_role_docker_oom_killer
# Type: bool (true/false)
profilarr_role_docker_oom_killer:
profilarr_role_docker_oom_score_adj
# Type: int
profilarr_role_docker_oom_score_adj:
profilarr_role_docker_output_logs
# Type: bool (true/false)
profilarr_role_docker_output_logs:
profilarr_role_docker_paused
# Type: bool (true/false)
profilarr_role_docker_paused:
profilarr_role_docker_recreate
# Type: bool (true/false)
profilarr_role_docker_recreate:
profilarr_role_docker_restart_retries
# Type: int
profilarr_role_docker_restart_retries:
profilarr_role_docker_stop_timeout
# Type: int
profilarr_role_docker_stop_timeout:

Other Options

profilarr_role_docker_capabilities
# Type: list
profilarr_role_docker_capabilities:
profilarr_role_docker_cgroup_parent
# Type: string
profilarr_role_docker_cgroup_parent:
profilarr_role_docker_commands
# Type: list
profilarr_role_docker_commands:
profilarr_role_docker_create_timeout
# Type: int
profilarr_role_docker_create_timeout:
profilarr_role_docker_entrypoint
# Type: string
profilarr_role_docker_entrypoint:
profilarr_role_docker_env_file
# Type: string
profilarr_role_docker_env_file:
profilarr_role_docker_labels
# Type: dict
profilarr_role_docker_labels:
profilarr_role_docker_labels_use_common
# Type: bool (true/false)
profilarr_role_docker_labels_use_common:
profilarr_role_docker_read_only
# Type: bool (true/false)
profilarr_role_docker_read_only:
profilarr_role_docker_runtime
# Type: string
profilarr_role_docker_runtime:
profilarr_role_docker_sysctls
# Type: list
profilarr_role_docker_sysctls:
profilarr_role_docker_ulimits
# Type: list
profilarr_role_docker_ulimits:
profilarr_role_autoheal_enabled
# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
profilarr_role_autoheal_enabled: true
profilarr_role_depends_on
# List of container dependencies that must be running before the container start
# Type: string
profilarr_role_depends_on: ""
profilarr_role_depends_on_delay
# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
profilarr_role_depends_on_delay: "0"
profilarr_role_depends_on_healthchecks
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
profilarr_role_depends_on_healthchecks:
profilarr_role_diun_enabled
# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
profilarr_role_diun_enabled: true
profilarr_role_dns_enabled
# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
profilarr_role_dns_enabled: true
profilarr_role_docker_controller
# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
profilarr_role_docker_controller: true
profilarr_role_docker_image_repo
# Type: string
profilarr_role_docker_image_repo:
profilarr_role_docker_image_tag
# Type: string
profilarr_role_docker_image_tag:
profilarr_role_docker_volumes_download
# Type: bool (true/false)
profilarr_role_docker_volumes_download:
profilarr_role_themepark_addons
# Type: string
profilarr_role_themepark_addons:
profilarr_role_themepark_app
# Type: string
profilarr_role_themepark_app:
profilarr_role_themepark_theme
# Type: string
profilarr_role_themepark_theme:
profilarr_role_traefik_api_endpoint
# Type: dict/omit
profilarr_role_traefik_api_endpoint:
profilarr_role_traefik_api_middleware
# Type: string
profilarr_role_traefik_api_middleware:
profilarr_role_traefik_api_middleware_http
# Type: string
profilarr_role_traefik_api_middleware_http:
profilarr_role_traefik_autodetect_enabled
# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
profilarr_role_traefik_autodetect_enabled: false
profilarr_role_traefik_certresolver
# Type: string
profilarr_role_traefik_certresolver:
profilarr_role_traefik_crowdsec_enabled
# Enable CrowdSec middleware for the container
# Type: bool (true/false)
profilarr_role_traefik_crowdsec_enabled: false
profilarr_role_traefik_error_pages_enabled
# Enable custom error pages middleware for the container
# Type: bool (true/false)
profilarr_role_traefik_error_pages_enabled: false
profilarr_role_traefik_gzip_enabled
# Enable gzip compression middleware for the container
# Type: bool (true/false)
profilarr_role_traefik_gzip_enabled: false
profilarr_role_traefik_middleware_http
# Type: string
profilarr_role_traefik_middleware_http:
profilarr_role_traefik_middleware_http_api_insecure
# Type: bool (true/false)
profilarr_role_traefik_middleware_http_api_insecure:
profilarr_role_traefik_middleware_http_insecure
# Type: bool (true/false)
profilarr_role_traefik_middleware_http_insecure:
profilarr_role_traefik_priority
# Type: string
profilarr_role_traefik_priority:
profilarr_role_traefik_robot_enabled
# Enable robots.txt middleware for the container
# Type: bool (true/false)
profilarr_role_traefik_robot_enabled: true
profilarr_role_traefik_tailscale_enabled
# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
profilarr_role_traefik_tailscale_enabled: false
profilarr_role_traefik_wildcard_enabled
# Enable wildcard certificate for the container
# Type: bool (true/false)
profilarr_role_traefik_wildcard_enabled: true
profilarr_role_web_domain
# Type: string
profilarr_role_web_domain:
profilarr_role_web_fqdn_override
# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
profilarr_role_web_fqdn_override:

Example Override

profilarr_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "profilarr2.{{ user.domain }}"
  - "profilarr.otherdomain.tld"

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

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

Example Override

profilarr_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'profilarr2.' + user.domain }}`)"

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

profilarr_role_web_http_port
# Type: string (quoted number)
profilarr_role_web_http_port:
profilarr_role_web_http_scheme
# Type: string ("http"/"https")
profilarr_role_web_http_scheme:
profilarr_role_web_http_serverstransport
# Type: dict/omit
profilarr_role_web_http_serverstransport:
profilarr_role_web_scheme
# URL scheme to use for web access to the container
# Type: string ("http"/"https")
profilarr_role_web_scheme:
profilarr_role_web_serverstransport
# Type: dict/omit
profilarr_role_web_serverstransport:
profilarr_role_web_subdomain
# Type: string
profilarr_role_web_subdomain: