Navidrome

The user commands create, edit, list, and delete Navidrome users.

The service commands install Navidrome as a service in your OS service manager, then start, stop, and check it.

The search command maintains the full-text search index.

The scan command scans your music library for new, changed, and removed files.

The pls commands list playlists, export them to M3U files, and import M3U files as playlists.

The plugin commands list, check, configure, enable, and disable plugins.

The missing commands list files marked as missing, and remap a missing file onto an existing one.

The inspect command prints the tags of one or more music files, the way Navidrome reads them.

The doctor command checks the database for problems.

The backup commands make a copy of the Navidrome database, delete old copies, and restore a copy.

The artwork commands tell you why a cover is wrong or an artist image is missing, without opening the database.

Navidrome includes a built-in CLI for administration tasks, maintenance, and troubleshooting.

Navidrome supports a plugin system that allows you to extend its functionality with community-developed extensions.

What is externalized authentication Externalized authentication allows you to use an external system to handle authentication for Navidrome.

Overview Navidrome supports multiple music libraries since v0.58.0, allowing you to organize your music into separate collections with user-specific access controls.

Overview Navidrome allows the usage of a .ndignore file to exclude content from being added to Navidrome’s library.

Navidrome version 0.54.x introduces a backup feature that allows the music server’s data to get periodically exported.

Overview Navidrome includes an anonymous usage statistics feature designed to help improve the project for all users.

MSI Install Download and install the latest Navidrome MSI for the correct version of Windows (most likely AMD64).

Currently, Navidrome supports monitoring and alerting using Prometheus/OpenMetrics standard.

For Beginners Externalized authentication is a relatively advanced topic.

Introduction Navidrome’s Jukebox feature is a built-in functionality that allows users to play music directly to the server’s audio hardware.

Navidrome allows some customization using environment variables, loading from a configuration file or using command line arguments.

Container images are available for the linux/amd64, linux/arm/v7 and linux/arm64 platforms.

NOTE: These instructions were created for the Ubuntu distribution, and even though they contain specific Ubuntu/Debian instructions (ex: apt) the concepts are generic enough and can be applied on most Linux distributions, even on those not based on Debian…

Docker images are available for the linux/amd64, linux/arm/v6, linux/arm/v7 and linux/arm64 platforms.

Artists Fetching images for artists is controlled by the ArtistArtPriority config option.

Navidrome can be ran by simply double-clicking the binary that has been downloaded from the release page or by running it in the command line.

Navidrome uses external services (through agents) to enrich your music library with artist biographies, images, album covers, similar artists, and more.

The following steps have been tested on FreeBSD 12 and 13.

Navidrome has a “Sharing” feature which allows users to generate a shareable link for a track, album, artist, or playlist.

Overview When using Navidrome, you may encounter missing tracks or albums in your library.

Permissions You should NOT run Navidrome as root.

Persistent IDs in Navidrome Persistent IDs (PIDs) are configurable identifiers introduced to provide stable references for Tracks and Albums in Navidrome, significantly improving how media is managed and identified.

Overview As all tags imported are stored and indexed in the database, to improve performance and reduce storage requirements, Navidrome only imports a predefined set of tags.

Why Proper Tagging is Important Navidrome organizes your music library entirely based on the metadata tags in your audio files.

Smart Playlists in Navidrome offer a dynamic way to organize and enjoy your music collection.

DISCLAIMER: These packages are not maintained by the Navidrome project, any issues should be reported to their authors.

The following providers offer managed hosting for Navidrome.

Currently these instructions only work for Unix-based systems (Linux, macOS, BSD, …).