Navidrome

Navidrome is optional. Aurral connects to Navidrome through its API and writes playlist files to the Aurral download tree. Navidrome must also be able to read that tree on disk.

This is a filesystem connection as well as an API connection. A successful Test connection only proves that Aurral can reach the Navidrome API.

See Filesystem and mounts for the complete layout. The recommended Docker setup mounts the same host media root at /data in Aurral and Navidrome:

# Aurral
volumes:
  - /srv/media:/data
  - ./config:/config

# Navidrome
volumes:
  - /srv/media:/data:ro

Setup

1. Mount the same media root in Aurral and Navidrome at the same container path.
2. Set Aurral’s Settings > Download Clients > Downloads Folder > Path to a folder under that path, for example /data/downloads/aurral.
3. Make sure Navidrome can read both /data/music and /data/downloads/aurral if you want to play reused Lidarr tracks as well as new Aurral downloads.
4. Open Settings > Playback > Navidrome in Aurral.
5. Enter the Navidrome URL, username, and password. Select Test connection, then save.
6. Run a flow or update a playlist so Aurral can create or update the Aurral Playlists library and request a Navidrome scan.

Aurral creates the Aurral Playlists library at:

/data/downloads/aurral/aurral-weekly-flow

You do not normally need to create this library manually in Navidrome. The library can be empty until a track finishes downloading. Wait for the scan after the first completed track.

Navidrome must have permission to manage libraries through its API. If Aurral cannot create the library, use Settings > System > Storage Health for the exact path and error, then check the Navidrome account permissions and mount.

Existing Lidarr library

Aurral does not copy your Lidarr library into the Aurral playlist folder. If a playlist reuses tracks that already exist in Lidarr, Navidrome must also scan the Lidarr root folder, such as /data/music.

Add /data/music as a normal Navidrome music library if it is not already present. The automatically managed Aurral Playlists library is for Aurral’s generated download tree.

Different Navidrome paths

Use matching container paths when possible. A different path affects two things:

• the path Navidrome uses for its music library;
• the paths written into Aurral’s .m3u files.

The Use Navidrome paths in M3U files setting only changes the second item. It does not mount a folder and it does not make an incorrect Navidrome library path valid.

If Aurral uses /data/downloads/aurral and Navidrome uses /music/aurral for the same host folder:

1. Mount the same host folder in both containers.

2. Make sure the Aurral playlist library exists in Navidrome at the path Navidrome can read. If automatic library creation used the Aurral path, correct the library path in Navidrome.

3. In Aurral, open Settings > Playback > Navidrome.

4. Enable Use Navidrome paths in M3U files.

5. Add this mapping:

   	Value
   Aurral Path	/data/downloads/aurral
   Navidrome Path	/music/aurral

6. Save the settings and refresh the affected playlist. Run the flow again, or edit and save a shared playlist, to rewrite its .m3u file.

For a native Windows Navidrome installation, use the Windows path as Navidrome Path, for example N:/ServerFolders/Music/Aurral. Use a separate Remote Path Mapping if Aurral cannot read paths reported by Lidarr or a download client.

Generated playlists and scans

Aurral stores generated .m3u files under:

/data/downloads/aurral/aurral-weekly-flow/_playlists/

Navidrome scans the Aurral Playlists library, not only your main Lidarr library. If the library appears but has no tracks:

• confirm that a track exists under aurral-weekly-flow;
• confirm that the Navidrome library path points to that folder;
• run a Navidrome scan or save the Aurral Navidrome settings;
• wait for the scan to finish.

Remove missing tracks

For Weekly Flow, set this Navidrome environment variable:

ND_SCANNER_PURGEMISSING=always

This removes old flow entries after a flow changes.

Caution

ND_SCANNER_PURGEMISSING=always also removes other missing Navidrome files. It can remove their ratings, play counts, and playlist entries. Use it only when missing files will not return.

For Plex and Plexamp, see Plex.