Navidrome

Description / name	Input element
Your domain name

Overview

Navidrome is an open source music server and streamer that allows users to listen to their personal music collection from any browser or mobile device, functioning similarly to commercial services like Spotify or Apple Music.

Manual

Releases

Community

---

Deployment

sb install sandbox-navidrome

Usage

Visit https://navidrome.iYOUR_DOMAIN_NAMEi.

Basics

• After installing Navidrome in your platform, you need to create your first user. This will be your admin user, a super user that can manage all aspects of Navidrome, including the ability to manage other users. Just browse to Navidrome’s homepage at https://navidrome.iYOUR_DOMAIN_NAMEi and you will be greeted with a screen like this:
  

  

  Just fill out the username and password you want to use, confirm the password and click on the “Create Admin” button.

  That’s it! You should now be able to browse and listen to all your music.

  Note

   It usually take a couple of minutes for your music to start appearing in Navidrome’s UI. <br />
   You can check the logs to see what is the scan progress. If you have a large library this may take some time.
  

Role Defaults

Use the Inventory to customize variables. (1)

1. Example override

   navidrome_name: "custom_value"
   

   Avoid overriding variables ending in _default

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

BasicsWebDNSTraefikDockerDocker+Global Override Options

navidrome_name

# Type: string
navidrome_name: navidrome

navidrome_role_web_subdomain

# Type: string
navidrome_role_web_subdomain: "{{ navidrome_name }}"

navidrome_role_web_domain

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

navidrome_role_web_port

# Type: string
navidrome_role_web_port: "4533"

navidrome_role_web_url

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

navidrome_role_dns_record

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

navidrome_role_dns_zone

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

navidrome_role_dns_proxy

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

navidrome_role_traefik_sso_middleware

# Type: string
navidrome_role_traefik_sso_middleware: ""

navidrome_role_traefik_middleware_default

# Type: string
navidrome_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

navidrome_role_traefik_middleware_custom

# Type: string
navidrome_role_traefik_middleware_custom: ""

navidrome_role_traefik_certresolver

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

navidrome_role_traefik_enabled

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

navidrome_role_traefik_api_enabled

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

navidrome_role_traefik_api_endpoint

# Type: string
navidrome_role_traefik_api_endpoint: ""

Container

navidrome_role_docker_container

# Type: string
navidrome_role_docker_container: "{{ navidrome_name }}"

Image

navidrome_role_docker_image_pull

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

navidrome_role_docker_image_tag

# Type: string
navidrome_role_docker_image_tag: "latest"

navidrome_role_docker_image_repo

# Type: string
navidrome_role_docker_image_repo: "deluan/navidrome"

navidrome_role_docker_image

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

Volumes

navidrome_role_docker_volumes_default

# Type: list
navidrome_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='navidrome') }}:/data"
  - "/mnt/unionfs/Media/Music:/music"

navidrome_role_docker_volumes_custom

# Type: list
navidrome_role_docker_volumes_custom: []

Hostname

navidrome_role_docker_hostname

# Type: string
navidrome_role_docker_hostname: "{{ navidrome_name }}"

Networks

navidrome_role_docker_networks_alias

# Type: string
navidrome_role_docker_networks_alias: "{{ navidrome_name }}"

navidrome_role_docker_networks_default

# Type: list
navidrome_role_docker_networks_default: []

navidrome_role_docker_networks_custom

# Type: list
navidrome_role_docker_networks_custom: []

Restart Policy

navidrome_role_docker_restart_policy

# Type: string
navidrome_role_docker_restart_policy: unless-stopped

State

navidrome_role_docker_state

# Type: string
navidrome_role_docker_state: started

User

navidrome_role_docker_user

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

navidrome_role_docker_blkio_weight

# Type: int
navidrome_role_docker_blkio_weight:

navidrome_role_docker_cpu_period

# Type: int
navidrome_role_docker_cpu_period:

navidrome_role_docker_cpu_quota

# Type: int
navidrome_role_docker_cpu_quota:

navidrome_role_docker_cpu_shares

# Type: int
navidrome_role_docker_cpu_shares:

navidrome_role_docker_cpus

# Type: string
navidrome_role_docker_cpus:

navidrome_role_docker_cpuset_cpus

# Type: string
navidrome_role_docker_cpuset_cpus:

navidrome_role_docker_cpuset_mems

# Type: string
navidrome_role_docker_cpuset_mems:

navidrome_role_docker_kernel_memory

# Type: string
navidrome_role_docker_kernel_memory:

navidrome_role_docker_memory

# Type: string
navidrome_role_docker_memory:

navidrome_role_docker_memory_reservation

# Type: string
navidrome_role_docker_memory_reservation:

navidrome_role_docker_memory_swap

# Type: string
navidrome_role_docker_memory_swap:

navidrome_role_docker_memory_swappiness

# Type: int
navidrome_role_docker_memory_swappiness:

navidrome_role_docker_shm_size

# Type: string
navidrome_role_docker_shm_size:

Security & Devices

navidrome_role_docker_cap_drop

# Type: list
navidrome_role_docker_cap_drop:

navidrome_role_docker_cgroupns_mode

# Type: string
navidrome_role_docker_cgroupns_mode:

navidrome_role_docker_device_cgroup_rules

# Type: list
navidrome_role_docker_device_cgroup_rules:

navidrome_role_docker_device_read_bps

# Type: list
navidrome_role_docker_device_read_bps:

navidrome_role_docker_device_read_iops

# Type: list
navidrome_role_docker_device_read_iops:

navidrome_role_docker_device_requests

# Type: list
navidrome_role_docker_device_requests:

navidrome_role_docker_device_write_bps

# Type: list
navidrome_role_docker_device_write_bps:

navidrome_role_docker_device_write_iops

# Type: list
navidrome_role_docker_device_write_iops:

navidrome_role_docker_devices

# Type: list
navidrome_role_docker_devices:

navidrome_role_docker_devices_default

# Type: string
navidrome_role_docker_devices_default:

navidrome_role_docker_groups

# Type: list
navidrome_role_docker_groups:

navidrome_role_docker_privileged

# Type: bool (true/false)
navidrome_role_docker_privileged:

navidrome_role_docker_security_opts

# Type: list
navidrome_role_docker_security_opts:

navidrome_role_docker_userns_mode

# Type: string
navidrome_role_docker_userns_mode:

Networking

navidrome_role_docker_dns_opts

# Type: list
navidrome_role_docker_dns_opts:

navidrome_role_docker_dns_search_domains

# Type: list
navidrome_role_docker_dns_search_domains:

navidrome_role_docker_dns_servers

# Type: list
navidrome_role_docker_dns_servers:

navidrome_role_docker_domainname

# Type: string
navidrome_role_docker_domainname:

navidrome_role_docker_exposed_ports

# Type: list
navidrome_role_docker_exposed_ports:

navidrome_role_docker_hosts

# Type: dict
navidrome_role_docker_hosts:

navidrome_role_docker_hosts_use_common

# Type: bool (true/false)
navidrome_role_docker_hosts_use_common:

navidrome_role_docker_ipc_mode

# Type: string
navidrome_role_docker_ipc_mode:

navidrome_role_docker_links

# Type: list
navidrome_role_docker_links:

navidrome_role_docker_network_mode

# Type: string
navidrome_role_docker_network_mode:

navidrome_role_docker_pid_mode

# Type: string
navidrome_role_docker_pid_mode:

navidrome_role_docker_ports

# Type: list
navidrome_role_docker_ports:

navidrome_role_docker_uts

# Type: string
navidrome_role_docker_uts:

Storage

navidrome_role_docker_keep_volumes

# Type: bool (true/false)
navidrome_role_docker_keep_volumes:

navidrome_role_docker_mounts

# Type: list
navidrome_role_docker_mounts:

navidrome_role_docker_storage_opts

# Type: dict
navidrome_role_docker_storage_opts:

navidrome_role_docker_tmpfs

# Type: list
navidrome_role_docker_tmpfs:

navidrome_role_docker_volume_driver

# Type: string
navidrome_role_docker_volume_driver:

navidrome_role_docker_volumes_from

# Type: list
navidrome_role_docker_volumes_from:

navidrome_role_docker_volumes_global

# Type: bool (true/false)
navidrome_role_docker_volumes_global:

navidrome_role_docker_working_dir

# Type: string
navidrome_role_docker_working_dir:

Monitoring & Lifecycle

navidrome_role_docker_auto_remove

# Type: bool (true/false)
navidrome_role_docker_auto_remove:

navidrome_role_docker_cleanup

# Type: bool (true/false)
navidrome_role_docker_cleanup:

navidrome_role_docker_force_kill

# Type: string
navidrome_role_docker_force_kill:

navidrome_role_docker_healthcheck

# Type: dict
navidrome_role_docker_healthcheck:

navidrome_role_docker_healthy_wait_timeout

# Type: int
navidrome_role_docker_healthy_wait_timeout:

navidrome_role_docker_init

# Type: bool (true/false)
navidrome_role_docker_init:

navidrome_role_docker_kill_signal

# Type: string
navidrome_role_docker_kill_signal:

navidrome_role_docker_log_driver

# Type: string
navidrome_role_docker_log_driver:

navidrome_role_docker_log_options

# Type: dict
navidrome_role_docker_log_options:

navidrome_role_docker_oom_killer

# Type: bool (true/false)
navidrome_role_docker_oom_killer:

navidrome_role_docker_oom_score_adj

# Type: int
navidrome_role_docker_oom_score_adj:

navidrome_role_docker_output_logs

# Type: bool (true/false)
navidrome_role_docker_output_logs:

navidrome_role_docker_paused

# Type: bool (true/false)
navidrome_role_docker_paused:

navidrome_role_docker_recreate

# Type: bool (true/false)
navidrome_role_docker_recreate:

navidrome_role_docker_restart_retries

# Type: int
navidrome_role_docker_restart_retries:

navidrome_role_docker_stop_timeout

# Type: int
navidrome_role_docker_stop_timeout:

Other Options

navidrome_role_docker_capabilities

# Type: list
navidrome_role_docker_capabilities:

navidrome_role_docker_cgroup_parent

# Type: string
navidrome_role_docker_cgroup_parent:

navidrome_role_docker_commands

# Type: list
navidrome_role_docker_commands:

navidrome_role_docker_create_timeout

# Type: int
navidrome_role_docker_create_timeout:

navidrome_role_docker_entrypoint

# Type: string
navidrome_role_docker_entrypoint:

navidrome_role_docker_env_file

# Type: string
navidrome_role_docker_env_file:

navidrome_role_docker_envs

# Type: dict
navidrome_role_docker_envs:

navidrome_role_docker_labels

# Type: dict
navidrome_role_docker_labels:

navidrome_role_docker_labels_use_common

# Type: bool (true/false)
navidrome_role_docker_labels_use_common:

navidrome_role_docker_read_only

# Type: bool (true/false)
navidrome_role_docker_read_only:

navidrome_role_docker_runtime

# Type: string
navidrome_role_docker_runtime:

navidrome_role_docker_sysctls

# Type: list
navidrome_role_docker_sysctls:

navidrome_role_docker_ulimits

# Type: list
navidrome_role_docker_ulimits:

navidrome_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
navidrome_role_autoheal_enabled: true

navidrome_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
navidrome_role_depends_on: ""

navidrome_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
navidrome_role_depends_on_delay: "0"

navidrome_role_depends_on_healthchecks

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

navidrome_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
navidrome_role_diun_enabled: true

navidrome_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
navidrome_role_dns_enabled: true

navidrome_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
navidrome_role_docker_controller: true

navidrome_role_docker_image_repo

# Type: string
navidrome_role_docker_image_repo:

navidrome_role_docker_image_tag

# Type: string
navidrome_role_docker_image_tag:

navidrome_role_docker_volumes_download

# Type: bool (true/false)
navidrome_role_docker_volumes_download:

navidrome_role_paths_location

# Type: string
navidrome_role_paths_location:

navidrome_role_themepark_addons

# Type: string
navidrome_role_themepark_addons:

navidrome_role_themepark_app

# Type: string
navidrome_role_themepark_app:

navidrome_role_themepark_theme

# Type: string
navidrome_role_themepark_theme:

navidrome_role_traefik_api_endpoint

# Type: dict/omit
navidrome_role_traefik_api_endpoint:

navidrome_role_traefik_api_middleware

# Type: string
navidrome_role_traefik_api_middleware:

navidrome_role_traefik_api_middleware_http

# Type: string
navidrome_role_traefik_api_middleware_http:

navidrome_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
navidrome_role_traefik_autodetect_enabled: false

navidrome_role_traefik_certresolver

# Type: string
navidrome_role_traefik_certresolver:

navidrome_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
navidrome_role_traefik_crowdsec_enabled: false

navidrome_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
navidrome_role_traefik_error_pages_enabled: false

navidrome_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
navidrome_role_traefik_gzip_enabled: false

navidrome_role_traefik_middleware_http

# Type: string
navidrome_role_traefik_middleware_http:

navidrome_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
navidrome_role_traefik_middleware_http_api_insecure:

navidrome_role_traefik_middleware_http_insecure

# Type: bool (true/false)
navidrome_role_traefik_middleware_http_insecure:

navidrome_role_traefik_priority

# Type: string
navidrome_role_traefik_priority:

navidrome_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
navidrome_role_traefik_robot_enabled: true

navidrome_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
navidrome_role_traefik_tailscale_enabled: false

navidrome_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
navidrome_role_traefik_wildcard_enabled: true

navidrome_role_web_domain

# Type: string
navidrome_role_web_domain:

navidrome_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
navidrome_role_web_fqdn_override:

Example Override

navidrome_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "navidrome2.{{ user.domain }}"
  - "navidrome.otherdomain.tld"

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

navidrome_role_web_host_override

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

Example Override

navidrome_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'navidrome2.' + user.domain }}`)"

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

navidrome_role_web_http_port

# Type: string (quoted number)
navidrome_role_web_http_port:

navidrome_role_web_http_scheme

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

navidrome_role_web_http_serverstransport

# Type: dict/omit
navidrome_role_web_http_serverstransport:

navidrome_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
navidrome_role_web_scheme:

navidrome_role_web_serverstransport

# Type: dict/omit
navidrome_role_web_serverstransport:

navidrome_role_web_subdomain

# Type: string
navidrome_role_web_subdomain: