Please note if you are using DSM7.2 or higher you should use the Container Manager version of this guide from the menu.
This guide has reached the end of its updates as most people are now on the latest DSM update - This guide is correct as of 08/12/2023 however no further updates will be added.
Update | Date |
---|---|
Removed docker compose section as rarely used | 18/07/2023 |
What is Lidarr?
Lidarr is used to search, download and organise your Music in conjunction with your preferred Usenet or Torrent downloaders and indexers.
Let’s Begin
In this guide I will take you through the steps to get Lidarr up and running in Docker.
In order for you to successfully use this guide please complete the three preceding guides
- Step 0.5 : Docker, Memory Recommendations and Limitations
- Step 1: Directory Setup Guide
- Step 2: Setting up a restricted Docker user
- Step 3: Setting up a Docker Bridge Network
Downloading the Lidarr Image
Open up Docker within DSM and navigate to the ‘Registry’ tab, then search for ‘Lidarr’.
In the list of available containers select the one made by Linuxserver as shown below, right click on it and select ‘Download’ or click the button at the top of the window.
When the dialogue pops up asking you to choose a version, make sure you choose ‘Latest’ from the list.
You can check the status of the download over on the ‘Image’ tab, it will take a few minutes depending on the speed of your internet connection.
Setting up the container
In Docker click on the ‘Image’ tab, in the list of your containers select the ‘Linuxserver Lidarr’ image and click on ‘Launch’
You will be greeted with the Network screen, we will be using the ‘synobridge’ network we created earlier select it from the list and click Next.
General Settings
Next you will be greeted with the General Settings screen, this is where you can start specifying some of your preferences.
You can change the name of the container to anything you like, and you may want to enable Auto Restart as this will ensure Lidarr starts automatically if you reboot your NAS.
You will also notice a Configure capabilities button — don’t change anything in here!
Environment (PGID, PUID and Timezone)
Next we are going to set up a couple of environment variables that docker will use to allow the container access to our files and folders and also to tell it where we live in the world.
Click the Add button, and fill in the following details as per the table/screenshot, you will need to do one at a time.
Variable | Value |
---|---|
PUID | The UID you obtained in the user setup guide |
PGID | The GID you obtained in the user setup guide |
TZ | Your timezone wikipedia.org/wiki/List_of_tz_database_time_zones |
Links / Execution Command
You do not need to set up anything on these tabs.
Press ‘Save’ to go back to the initial setup screen, then press ‘Next’
Port Settings
We won’t be changing any of the ports the container uses. You can repeat the ones shown on the right side of the settings page ‘Container Port’ onto the left side ‘Local Port’ once you have done this press ‘Next’.
Volume Settings
We will now be specifying the directories where Lidarr will store its configuration files and where to find our media and downloads.
Click on ‘Add Folder’ select the ‘docker’ folder and create a new sub-folder called ‘lidarr’ select this folder and click ‘select’
Repeat this process to add the /data folder.
You will now add the below settings into the ‘Mount path’ section
File/Folder | Mount path |
---|---|
docker/lidarr | /config |
data | /data |
Click Next to move to the final screen.
Summary
You have now completed the setup of the container.
You will be shown an overall summary of the settings we have specified, this is a good time to double-check everything is correct. Finally, click on Done and the container should start to boot
You should now be able to access Lidarr via the IP of your NAS followed by the port 8686
e.g. 192.168.0.40:8686
Key Settings and FAQ
Now you have set up Lidarr there are some key settings you will need to set as these often catch new users out. I will add more as they come up.
Media Management / Root Folders (Settings>Media Management)
Lidarr refers to the place(s) you keep your music as Root Folders. These are where Lidarr will ultimately move your music files once they finish downloading.
App | Root Folder |
---|---|
Lidarr | /data/media/music |
Download Clients (Settings > Download Clients>Remote Path Mappings)
While most of the settings on this page are self-explanatory something that has caught people out if the Remote Path Mappings setting. If you are hosting all your services on the same NAS do not add any settings here.
I can’t get Lidarr to Connect to my Download Client!
When setting up your preferred download client or Prowlarr etc. Usually you will use the IP of your NAS, however if for whatever reason this is not working you can use http://172.20.0.1 which is the IP of the ‘synobridge’ gateway.
Historic Updates | Date |
---|---|
New guide released | 19/09/2021 |
Added Docker-Compose and updated wording | 15/12/2021 |
Updated screenshots and steps for DSM7.1 | 03/06/2022 |
Added new port settings and Docker Bridge Network | 24/07/2022 |
Compose version number removed and small wording amendments | 08/04/2023 |
Looking for some help, join our Discord community
If you are struggling with any steps in the guides or looking to branch out into other containers join our Discord community!
Buy me a beverage!
If you have found my site useful please consider pinging me a tip as it helps cover the cost of running things or just lets me stay hydrated. Plus 10% goes to the devs of the apps I do guides for every year.
how would i direct different artists into seperate genre folders. for example
i have snoop and ice cube. /data/media/music is the root. but i want a hip hop folder
/music/hiphop/ice cube
/music/hiphop/snoop dogg
then when i get a country artist…
/music/country/morgan wallen
make sense…i cant get it working.
You will need independent root folders one for each genre
So remove the /data/media/music and add two root folders for your example of /data/media/music/hiphop and another for country
Then when adding the artist to lidarr you assign it to the appropriate root folder.
Thanks for the guide – really helpful. Everything works great on Sonarr, but on Radarr and Lidarr, I’m getting the following error “you are using docker; download client NZBGet places downloads in /volume1/data/media/movies but this directory does not appear to exist inside the container.” Think is this directory exists. Any thoughts?
Double check you don’t also have the package center version of NZBget still installed as /volume1 cannot exist inside the container. I suspect you are accessing the UI of the packages.
I checked and I don’t have NZBget installed outside of docker. Any other ideas?
In that case check in the NZBget settings, did you type in /volume1/data/usenet in the ‘Main Directory’ section make sure it’s only /data/usenet
Thank you as always.
So, a couple of comments for maybe a future article.
When I create a docker container, I like to use the as part of the docker name, the version of the application/docker image.
In the case of lidarr – lidarr-0.8.1.2135
I would store under the lidarr folder in configs, I would create a specific version of the config, ready for 0.8.1.2135.
I wouldn’t grab the latest image, I would grab the version that corresponded to latest. That way in my image folder I would have “Version-0.8.1.2135”
So, when I come to upgrade, I take a copy of the config, Version-0.8.1. 2135, and drop that into a folder called “Version.0.9.1.0001”. This give the user a backup container with a fully working version of lidarr, which they can go back to, if the newer version blows up.
Also, when it comes to delete older images and containers, they are all identifiable by the fact they all share the same version number, from config->image>container.
I tend to export the container information to the JSON file, modify that, and then import that to create the new container. Remembering to switch off the auto start on the previous version of the container.
Thanks Neil, I try and keep the guides at a super easy to work with level, so aimed at newer users. This adds a layer of complexity but makes sense why you would do its this way.