Lidarr

Aurral runs the Library by itself, and Lidarr is optional. You can use the two together in two ways:

• Aurral plays the music in Lidarr’s folders and never changes it.
• The Lidarr plugin adds Lidarr as a download source, so Lidarr grabs the albums you request in Aurral.

Aurral has no Lidarr settings of its own. It never moves, renames, tags, upgrades, or deletes a file in a Lidarr folder.

Play Lidarr’s music

Add each Lidarr root folder as a read-only folder in Settings > Library. See Add music Aurral only reads.

Aurral must see the folder on its own disk. In Docker, mount the Lidarr media root in the Aurral container. See Filesystem and mounts.

Aurral scans the folder and picks up what Lidarr adds later. The artists and albums start Not monitored. When you monitor one of them, Aurral downloads what is missing into the Library folder.

Tag Lidarr’s files

By default, Lidarr does not write tags to its files. Without MusicBrainz tags, Aurral matches an artist by name. When MusicBrainz has several artists with that name, such as ABBA or 38 Special, the artist stays unmatched: it has no picture or Open in Discover, and its albums have no artwork unless the files contain it.

To fix this, open Lidarr > Settings > Metadata and set Tag Audio Files with Metadata to the All files option. To tag the files Lidarr already has, select the artists in Lidarr’s artist list and choose Retag. Aurral reads the new tags when Lidarr writes them. To fix one artist instead, select Match artist in its menu in Library.

Download through Lidarr

The Lidarr plugin asks Lidarr for an album when Aurral wants it. Lidarr grabs the album with its own indexers and download clients and files it in its own folder. Aurral then plays it from the read-only folder.

1. Add Lidarr’s root folders as read-only folders, as above.
2. In Settings > Plugins, paste https://github.com/lklynet/aurral-plugins under Install from a link, select Check, and choose Lidarr.
3. Open Lidarr and enter Lidarr’s URL and API key. The key is in Lidarr under Settings > General.
4. If Lidarr and Aurral see the music at different paths, as they often do in Docker, fill in Music path in Lidarr and Same folder in Aurral. With Lidarr’s root folder at /music and the same folder mounted in Aurral at /mnt/media/music, enter those two.
5. Select Test, then turn the plugin on.

New artists go to Lidarr’s first root folder. To use another one, fill in Root folder for new artists.

Lidarr joins your other download sources, and its priority decides when Aurral tries it. Quality profiles, metadata profiles, and upgrades stay in Lidarr. The plugin’s page covers its other settings. See Plugins.

Upgrade from Aurral 2

In Aurral 2, a connected Lidarr managed the artists and albums you added. Aurral 3 manages all of them. The first time Aurral 3 starts on an install that used Lidarr, it converts the Library:

• Lidarr’s root folders become read-only folders, so their music stays in the Library with its favorites, play counts, and playlists.
• The artists and albums that Lidarr managed become Aurral’s, Not monitored.
• Album requests that were waiting on Lidarr show as requested. Lidarr keeps working on them, and Aurral plays what arrives in its folders.
• Aurral’s Lidarr settings, and remote path mappings that applied to Lidarr, are removed. The read-only folders keep the mapped paths.

Aurral changes nothing in Lidarr. Before it converts, it saves a copy of its database as aurral.pre-lidarr-conversion.db in the data folder. If the conversion fails, Aurral stops before it changes anything and says why in the log.

The first admin to open Aurral sees what changed. It offers to monitor the artists you monitored through Aurral 2, using the default rules in Settings > Monitoring. Aurral then downloads what those rules ask for and the Library does not have. Leave them unmonitored if Lidarr should keep doing that.

Artists that were already in Lidarr, and artists you added for a single album, start Not monitored. Monitor them from their artist page.

After the upgrade:

• To keep getting albums through Lidarr, install the plugin. See Download through Lidarr.
• If you added an Aurral webhook in Lidarr > Settings > Connect, remove it. Aurral no longer has that address.
• If Aurral cannot read a Lidarr folder, the report and Settings > Library say so, and its tracks do not play. Mount the folder at that path, see Mount a read-only folder, or remove it from the read-only folders.
• A root folder that was inside the Library folder is listed as read-only too. When Lidarr no longer uses it, remove it from the read-only folders in Settings > Library, and Aurral manages those files like the rest of the Library folder.

Import list feeds

Each flow can publish a URL that Lidarr reads as a Custom List.

1. On Flows, open the flow, then open the flow menu.
2. Select Copy Lidarr import URL.
3. In Lidarr, open Settings > Import Lists and add a Custom List.
4. Paste the URL.

The copied URL uses the Aurral address in your browser, for example https://aurral.example.com/api/feeds/.... Lidarr must be able to reach that address.

Caution

The URL contains a token for that flow. Treat it as a secret. Anyone with the URL can read the artist list of the flow.

The feed always matches the flow’s current tracklist. It leaves out tracks without a MusicBrainz artist ID. It includes album IDs when they are known. Lidarr versions that support album-level custom lists use these IDs for Specific Album monitoring.