This guide walks through getting a community plugin running in Lidarr, from switching to a build that supports plugins through updating or removing the plugin later. For the list of available plugins and their settings, see Lidarr Plugins.
Plugins add indexers, download clients, import lists, and other features that Lidarr doesn't ship with. Community developers write and support them. The Lidarr team doesn't review or endorse any plugin.
Plugin support is only in pre-release builds. It first shipped in 3.1.2.4938 on the develop branch, and it's also on nightly. No stable (master) release includes it yet.
Switching to a plugin-capable build updates your database. You can't go back to a stable release without restoring a backup made before the switch. If you try, Lidarr fails with errors such as
Error parsing column 10 (Protocol=TorrentDownloadProtocol - String), or you can't enable Usenet or Torrent in a Delay Profile.
Back up Lidarr from System > Backup before you continue.
develop or nightly.To install from scratch, follow the Installation guide and replace master with develop or nightly in the download URL.
Change the image in your Docker Compose file, then pull the image and recreate the container.
Hotio:
image: ghcr.io/hotio/lidarr:nightly
image: lscr.io/linuxserver/lidarr:nightly
Some plugin READMEs still mention the ghcr.io/hotio/lidarr:pr-plugins image. The nightly images now include plugin support, so you don't need pr-plugins.
https://github.com/allquiet-hub/Lidarr.Plugin.Slskd, then select Install.Lidarr downloads the newest GitHub release that matches your version of Lidarr. If a release lists a Minimum Lidarr Version that's newer than your build, Lidarr skips it and installs an older compatible release instead. If no release is compatible, the install fails. Update Lidarr and try again.
Lidarr stores installed plugins in the plugins folder inside your AppData directory, sorted by owner and plugin name.
To install a development or test build, add /tree/<branch> to the URL. For example:
https://github.com/TypNull/Tubifarry/tree/develop
Lidarr installs the newest release published from that branch.
Most plugins add an indexer, a download client, or both. Each plugin's section on Lidarr Plugins lists the settings it needs. After you add them, finish these steps.
Plugins that download music add their own download protocol. Lidarr only grabs releases from protocols turned on in the artist's Delay Profile, so you must do this step.
If you skip this step, Interactive Search shows the plugin's releases as rejected with a message like <Name>DownloadProtocol is not enabled for this artist.
Go to Settings > Profiles and edit the Quality Profile your artists use. Allow the formats the plugin returns, such as FLAC or AAC-256. Otherwise Lidarr rejects the releases for quality.
The TrevTV Deezer, Qobuz, and Tidal download clients can save .lrc lyrics files next to the audio. To import them:
lrc to the list of extensions, then select Save Changes.Lidarr checks each installed plugin for new releases, but it doesn't install them on its own.
Remove the plugin's indexers, download clients, and other settings from Lidarr before you uninstall it. Otherwise they stay in your settings and fail health checks.
develop or nightly as described above.Minimum Lidarr Version. Update Lidarr./config/plugins. Check the PUID and PGID values and the permissions on your config volume.For problems with a specific plugin, open an issue on that plugin's GitHub repository. The Lidarr team can't support third-party plugins.