NAVIDROME ยท SUBSONIC API ยท HOME ASSISTANT ADD-ON

Navidrome in Orange Glass.

Operations wiki for the Navidrome Home Assistant Add-on: installation, music folder setup, Subsonic client configuration, persistence and troubleshooting.

Add-on Slugnavidrome
Web UIhttp://homeassistant.local:4533
Subsonic API:4533
Upstream Imagedeluan/navidrome

โšก Minimum Run Path

Set your music folder, start the add-on, create an admin account, connect your Subsonic client.

ND_MUSICFOLDER: "/media/music"
Web UI: http://homeassistant.local:4533

๐Ÿงญ Supported Clients

Any Subsonic-compatible client works with Navidrome out of the box.

DSub ยท Symfonium ยท Ultrasonic ยท Feishin
foobar2000 ยท Strawberry ยท Clementine
๐Ÿ 

Home

Overview

#home

Navidrome is a self-hosted music server and streamer, compatible with the Subsonic/Airsonic API. This Home Assistant Add-on wraps the official deluan/navidrome Docker image and adds HA Supervisor integration.

Any Subsonic client works out of the box: DSub, Symfonium, Ultrasonic, Feishin and more.

#Wiki Pages

PagePurpose
InstallationAdd repository, install, configure and start.
ConfigurationAll ND_ environment variable options explained.
First StartCreate admin account, point to music folder.
PersistenceDatabase, cache and music paths.
TroubleshootingCommon symptoms and fixes.

#Minimum Operating Model

HA Add-on โ†’ Navidrome Web UI + Subsonic API :4533
Navidrome  โ†’ music folder (ND_MUSICFOLDER)
Data       โ†’ /data (database, cache)
๐Ÿš€

Installation

Install the Add-on

#installation

#Step 1 โ€” Add Repository

  1. Open Home Assistant.
  2. Go to Settings โ†’ Add-ons โ†’ Add-on Store.
  3. Open โ‹ฎ โ†’ Repositories.
  4. Add:
https://github.com/pol4rfuchs/ha-apps

#Step 2 โ€” Install

  1. Search for Navidrome in the Add-on Store.
  2. Click Install and wait for the image download.

#Step 3 โ€” Configure

Set at minimum ND_MUSICFOLDER in the Configuration tab before starting.

ND_MUSICFOLDER: "/media/music"

#Step 4 โ€” Start

  1. Enable Start on boot.
  2. Click Start.
  3. Open Web UI button (port 4533).
โš™๏ธ

Configuration

All Options

#configuration

All options map 1:1 to Navidrome environment variables.

#Required

OptionDefaultDescription
ND_MUSICFOLDER/media/musicRequired. Path to your music library.

#General

OptionDefaultDescription
ND_DATAFOLDER/dataDatabase and cache location.
ND_SCANSCHEDULE@every 24hAuto-scan schedule. 0 = disabled.
ND_LOGLEVELinfoerror / warn / info / debug / trace
ND_ENABLEDOWNLOADStrueAllow track downloads from the UI.
ND_JUKEBOX_ENABLEDfalsePlay audio on server hardware.

#External Integrations

OptionDefaultDescription
ND_LASTFM_ENABLEDfalseLast.fm scrobbling and metadata.
ND_LISTENBRAINZ_ENABLEDfalseListenBrainz scrobbling.
ND_SPOTIFY_IDโ€”Spotify Client ID for artist images.
ND_SPOTIFY_SECRETโ€”Spotify Client Secret.

#Reverse Proxy / SSO

OptionDescription
ND_REVERSEPROXYUSERHEADERSSO header for transparent login (e.g. Remote-User).
ND_REVERSEPROXYWHITELISTCIDRs allowed to send the proxy header.
โœ…

First Start

Initial Setup

#first-start

#1. Open the Web UI

http://homeassistant.local:4533

#2. Create Admin Account

On first open, Navidrome prompts you to create an admin account. Save these credentials securely.

#3. Trigger a Library Scan

  1. Log in with your admin account.
  2. Go to Settings โ†’ Personal or wait for the automatic scan.
  3. To trigger manually: Settings โ†’ Library โ†’ Scan.

#4. Connect a Subsonic Client

FieldValue
Server URLhttp://homeassistant.local:4533
UsernameYour Navidrome username
PasswordYour Navidrome password
API versionAuto-detected by most clients
๐Ÿ“‚

Music Paths

Folder Locations

#paths
SourceTypical pathNotes
USB / HDD via HA/media/musicHA mounts external drives here.
SMB (Samba add-on)/share/musicShared network drives.
NFS mount/share/nfsNetwork file system mounts.
Always use absolute paths. Relative paths inside the container will not resolve to your music.
๐Ÿ’พ

Persistence

Data & Backup

#persistence
/data/
โ”œโ”€โ”€ navidrome.db    # Library database (artists, albums, tracks, ratings)
โ””โ”€โ”€ cache/          # Transcoding cache and artwork cache

#Backup

Home Assistant backups include the add-on /data directory automatically. The music files themselves are not backed up โ€” they live outside /data in your media folder.

  1. Settings โ†’ System โ†’ Backups โ†’ Create Backup.
  2. For rollback, restore the Navidrome add-on data partition.
  3. After restore, restart the add-on and verify library access.
๐Ÿ› ๏ธ

Troubleshooting

Known Symptoms & Fixes

#troubleshooting
SymptomCauseFix
Web UI not openingPort not mapped.Check port 4533 in the Network tab.
No music showingWrong ND_MUSICFOLDER path.Verify path is accessible and trigger a scan.
Scan runs but finds nothingPermission issue on music folder.Check HA media mount and folder permissions.
Subsonic client cannot connectWrong server URL or credentials.Use http://HA-IP:4533.
Transcoding failsffmpeg not present.The official Navidrome image includes ffmpeg โ€” verify image is up to date.
Artwork not loadingCache issue or missing artwork.Clear browser cache; trigger a full rescan.