Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
ops-library 2.4.0
ops-library 2.4.0

Contents

  • Architecture Overview
  • Testing
  • Testing Guide for ops-library
  • Testing ops-library
  • Role Catalog
    • Deployment Roles
      • FastDeploy Deploy Role
      • FastDeploy Self-Deployment Role
      • Nyxmon Deploy Role
      • logyard_deploy
      • logyard_vector_deploy
      • logyard_ingress_deploy
      • graphyard_ingress_deploy
      • graphyard_auth_bootstrap_deploy
      • Traefik Deploy Role
      • DNS Deploy Role
      • tailscale_deploy
      • Homelab Deploy Role
      • Home Assistant Deploy
      • OTBR Deploy
      • UniFi Deploy Role
      • Paperless Deploy Role
      • MinIO Deploy Role
      • Minecraft Java Deploy Role
      • Navidrome Deploy Role
      • Jellyfin Deploy Role
      • MeTube Deploy
      • Open WebUI Deploy Role
      • Open WebUI Venv Deploy Role
      • Ollama Proxy Deploy Role
      • OpenClaw Deploy
      • Mastodon Deploy Role
      • Mastodon Shared Role
      • SnappyMail Deploy Role
      • Takahe Deploy Role
      • Takahe Shared Role
      • Mail Backend Deploy
      • Mail Relay Deploy
      • Certbot DNS Deploy
      • voxhelm_deploy
      • voxhelm_ingress_deploy
      • zellij_ingress_deploy
    • Removal Roles
      • FastDeploy Remove Role
      • Nyxmon Remove Role
      • Traefik Remove Role
      • DNS Remove Role
      • Home Assistant Remove
      • Homelab Remove
      • UniFi Remove Role
      • Paperless Remove Role
      • MinIO Remove Role
      • tailscale_remove
      • Minecraft Java Remove Role
      • Navidrome Remove Role
      • Jellyfin Remove Role
      • MeTube Remove
      • Open WebUI Remove Role
      • Open WebUI Venv Remove Role
      • Mastodon Remove Role
      • Takahe Remove Role
      • ollama_remove
      • ollama_proxy_remove
    • Operations Roles
      • Home Assistant Backup
      • Home Assistant Restore
      • Paperless Backup Role
      • Paperless Restore Role
      • FastDeploy Backup Role
      • FastDeploy Restore Role
      • Nyxmon Backup Role
      • Nyxmon Restore Role
      • Homelab Backup
      • Homelab Restore
      • UniFi Backup Role
      • UniFi Restore Role
      • MinIO Backup Role
      • MinIO Restore Role
      • minio_offsite_replication
      • mail_offsite_replication
      • OS APT Maintenance Role
      • Navidrome Backup Role
      • Navidrome Restore Role
      • Takahe Backup Role
      • Takahe Restore Role
      • Jellyfin Backup Role
      • Jellyfin Restore Role
      • MeTube Backup
      • MeTube Restore
      • Mastodon Backup Role
      • Mastodon Restore Role
      • Mastodon Maintenance Role
      • tailscale_backup
      • tailscale_restore
      • Minecraft Java Backup Role
      • Minecraft Java Restore Role
      • ZFS Syncoid Replication
      • ZFS USB Replication
    • Registration Roles
      • APT Upgrade Register Role
      • FastDeploy Service Registration Role
    • Bootstrap Roles
      • Ansible Install Role
      • boot_visible_i915
      • Docker Install Role
      • Dpkg Architecture Remove Role
      • Headless Mode
      • ollama_install
      • UV Install Role
      • SOPS Dependencies Role
      • Postgres Install Role
      • Redis Install Role
    • Testing Roles
      • Test Dummy Role
  • Service Lifecycle Guide
  • Paperless Scanner Configuration Guide
  • Traefik Wildcard Certs (file-provider)
  • OTBR with Home Assistant Connect ZBT-2
  • Changelog
Back to top
View this page
Edit this page

Navidrome Backup Role¶

Creates on-host Navidrome backups (data, config, systemd unit, Traefik config, optional logs) with optional archive fetch to the controller.

Features¶

  • Stops Navidrome for a consistent copy, then rsyncs data/config/logs into a timestamped directory under {{ navidrome_backup_root }}.

  • Generates a manifest capturing version, paths, and archive name.

  • Produces a .tar.gz archive by default and fetches it to {{ navidrome_backup_local_dir }} when enabled.

Usage¶

- hosts: media
  become: true
  roles:
    - role: local.ops_library.navidrome_backup
      vars:
        navidrome_backup_prefix: "{{ backup_prefix | default('manual') }}"
        navidrome_backup_fetch_local: true

Key Variables¶

Variable

Default

Description

navidrome_backup_root

/opt/backups/navidrome

Remote backup root.

navidrome_backup_prefix

manual

Prefix for backup directory/archive names.

navidrome_backup_create_archive

true

Create compressed archive of the backup directory.

navidrome_backup_fetch_local

true

Fetch archive to the controller.

navidrome_backup_stop_service

true

Stop Navidrome during backup for SQLite safety.

navidrome_backup_include_logs

true

Include /var/log/navidrome.

navidrome_backup_retain

7

Keep this many most recent archives (older ones are pruned).

See defaults/main.yml and roles/navidrome_shared/defaults/main.yml for the full reference.

Next
Navidrome Restore Role
Previous
OS APT Maintenance Role
Copyright © 2025, Jochen Wersdörfer
Made with Sphinx and @pradyunsg's Furo
On this page
  • Navidrome Backup Role
    • Features
    • Usage
    • Key Variables