Lidarr Setup Guide - ajgillis04/GillisDockerDepot GitHub Wiki

Lidarr Setup Guide

Introduction

Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks and will automatically grab, sort, and rename them.

Recommended Pre-Setup

Before setting up Lidarr, consider deploying the following containers first to simplify integration and avoid jumping between configuration steps:

These services work closely with Lidarr, and having them set up beforehand streamlines the process.

💡 Highly Recommended: Use a VPN
When downloading torrents, your IP address is exposed to the public, making you vulnerable to tracking, data collection, and potential legal issues. Using a VPN ensures your internet traffic is encrypted and anonymized, protecting your identity and preventing unwanted scrutiny. Setting up Transmission-OpenVPN provides an extra layer of security, keeping your torrenting activities private and secure.

Prerequisites

  • Docker installed
  • Lidarr container running in your Docker stack

Reset Permissions Reminder

When rebuilding your NAS, ensure permissions for media directories are reset to match the account specified in your PUID and PGID environment variables. This ensures proper access for all services.

Use the following commands (replace /path/to/your/media with your media directory path):

sudo chown -R <PUID>:<PGID> /path/to/your/Music
sudo chmod -R 775 /path/to/your/Music

Configuration Steps

Step 1: Accessing the Lidarr UI

  1. Open your browser and navigate to http://<your-ip-address>:8686.
  2. Upon first logon you will be asked to setup Authentication

**⚠️ Hint: You can disable Authentication, I would only recommend if you are using some other authentication method. edit config.xml and replace <AuthenticationMethod>Basic</AuthenticationMethod> with <AuthenticationMethod>External</AuthenticationMethod>

  • Set Authentication Method Basic
  • Username <Choose a username>
  • Password <Choose a password>
  • Save

Lidarr Auth Setup

Step 2: Custom Formats

  1. Navigate to the Custom Formats tab.
  2. Click the +
  3. Here are the custom formats I add. Choose Import and paste the code sections below. One for each new format

Lidarr Custom Format

{
  "name": "CD",
  "includeCustomFormatWhenRenaming": false,
  "specifications": [
    {
      "name": "CD",
      "implementation": "ReleaseTitleSpecification",
      "negate": false,
      "required": false,
      "fields": {
        "value": "\\bCD\\b"
      }
    }
  ]
}
{
  "name": "FLAC",
  "includeCustomFormatWhenRenaming": false,
  "specifications": [
    {
      "name": "FLAC",
      "implementation": "ReleaseTitleSpecification",
      "negate": false,
      "required": false,
      "fields": {
        "value": "\\bFLAC\\b"
      }
    }
  ]
}
{
  "name": "FLAC 24-bit",
  "includeCustomFormatWhenRenaming": false,
  "specifications": [
    {
      "name": "FLAC 24-bit",
      "implementation": "ReleaseTitleSpecification",
      "negate": false,
      "required": false,
      "fields": {
        "value": "\\bFLAC\\b.*?\\b24-bit\\b|\\bFLAC\\b.*?\\b24Bit-\\d+kHz\\b|\\bFLAC\\b.*?\\bHi-Res\\b|\\bTR24\\b|\\bOF\\b"
      }
    }
  ]
}
{
  "name": "Lossless",
  "includeCustomFormatWhenRenaming": false,
  "specifications": [
    {
      "name": "Flac",
      "implementation": "ReleaseTitleSpecification",
      "negate": false,
      "required": false,
      "fields": {
        "value": "\\blossless\\b"
      }
    }
  ]
}
{
  "name": "MP3-320",
  "includeCustomFormatWhenRenaming": false,
  "specifications": [
    {
      "name": "MP3-320",
      "implementation": "ReleaseTitleSpecification",
      "negate": false,
      "required": false,
      "fields": {
        "value": "\\bMP3-320\\b|\\b320kbps\\b|\\b320_kbps\\b|\\b320 kbps\\b|\\b320 KBPS\\b|\\bmp3 320kbps\\b|\\bCDQ\\b|\\bQuality\\b"
      }
    }
  ]
}
{
  "name": "Preferred Groups",
  "includeCustomFormatWhenRenaming": false,
  "specifications": [
    {
      "name": "DeVOiD",
      "implementation": "ReleaseGroupSpecification",
      "negate": false,
      "required": false,
      "fields": {
        "value": "\\bDeVOiD\\b"
      }
    },
    {
      "name": "PERFECT",
      "implementation": "ReleaseGroupSpecification",
      "negate": false,
      "required": false,
      "fields": {
        "value": "\\bPERFECT\\b"
      }
    },
    {
      "name": "ENRiCH",
      "implementation": "ReleaseGroupSpecification",
      "negate": false,
      "required": false,
      "fields": {
        "value": "\\bENRiCH\\b"
      }
    }
  ]
}
{
  "name": "Vinyl",
  "includeCustomFormatWhenRenaming": false,
  "specifications": [
    {
      "name": "Vinyl",
      "implementation": "ReleaseTitleSpecification",
      "negate": false,
      "required": false,
      "fields": {
        "value": "\\bVinyl\\b"
      }
    }
  ]
}
{
  "name": "WEB",
  "includeCustomFormatWhenRenaming": false,
  "specifications": [
    {
      "name": "WEB",
      "implementation": "ReleaseTitleSpecification",
      "negate": false,
      "required": false,
      "fields": {
        "value": "\\bWEB\\b"
      }
    }
  ]
}

Step 3: Profiles

**⚠️ Hint: I am currently using Tdarr to convert everything to MP3. I found the file sizes to large when listening in plex Make sure in Plexamp, Settings, Playback, Quality, Cellular is set to 2Mbps. The combination of FLAC and Maximum can chew through data quick.

  1. Navigate to the Profiles tab.
  2. Select the + icon under Quality Profiles
  3. Add Quality Profile Name: HQ Upgrade Allowed: Enabled Qualities: MP3-320 FLAC 24bit FLAC Upgrades Allowed: Enabled Minimum Custom Format Score: 1 CD: 10 FLAC: 10 Lossless: 10 MP3-320: 1 Preferred Groups: 1 Web: 1 FLAC 24-bit: -5 Finding FLAC 24-bit too large Vinyl: -5
  4. Save

Lidarr Profiles Lidarr Profiles

Step 4: Media Management

  1. Go to Media Management and select Add Root Folder button
  2. Enable Rename Tracks, and change the Standard Track Format, and Multi Disc Track Format {Album Title} ({Release Year})/{Artist Name} - {Album Title} ({Release Year}) - {track:00} - {Track Title} {Album Title} ({Release Year})/{Medium Format} {medium:00}/{Artist Name} - {Album Title} ({Release Year}) - {track:00} - {Track Title}
  3. Choose the +
  4. Setting the following Name: Path: Monitor: Existing Albums (Personally i only want to Lidarr to Monitor what I have not everything the artist has produced) Monitor New Albums: No New Albums (Do not download anything new by the artist) Quality Profile: HQ
  5. Save
  6. Disable Use Hardlinks instead of Copy
  7. Save Changes

Lidarr Root Folder Lidarr Root Folder1 Lidarr Root Folder2

Step 4: Adding Indexers (This should populated from Prowlarr)

  1. Go to the Indexers tab.
  2. Navigate to the Indexers section.
  3. Click Add Indexer and select your preferred indexers.
  4. Enter the necessary API keys or login credentials for each indexer.
  5. Click Save.

Pre-Populated Example:
Lidarr Indexer

Sabnzbd:
Lidarr Indexer1

Step 5: Configuring Download Clients

  1. Navigate to the Settings tab.
  2. Go to the Download Clients section.
  3. Click + and select your preferred download client (e.g., SABnzbd, Transmission).
  4. Enter the necessary connection details (hostname, port, API key).
  5. Click Save.

Lidarr DownloadClients

Lidarr DownloadClients1

Lidarr DownloadClients2

Step 6: Import Lists (Optional, but you can auto import your Spotify lists for download)

  1. Navigate to the Import Lists tab.
  2. Select the +
  3. Give the Import a Name
  4. Setup import settings, and Added Artists settings however you like
  5. Select the Authenticate with Spotify button and enter your Spotify credentials. Lidar will show your playlists
  6. Select which playlist you wish to import
  7. Test, Save 8 Lidarr will add the artists and albums from the songs in your playlists.

Lidarr Import Lists

Step 7: Connect

  1. Navigate to the Connect tab.
  2. Select +
  3. Select Plex Media Server
  4. Enter the Host
  5. Select Authenticate with Plex.tv
  6. Test, and Save

Lidarr Connect

Step 8: Metadata

  1. Navigate to the Connect tab.
  2. Set the following Tag Audio Files with Metadata: All Files; initial import only Enable Kodi

Lidarr Metadat

Step 9: Adding Artists

  1. Navigate to the Library tab.
  2. Click Add New.
  3. Search for and select the artists you want Lidarr to monitor.
  4. Configure the monitoring options (e.g., album releases, track releases).
  5. Click Save.

Notes

  • Ensure all paths and environment variables are updated in the .env file.
  • Regularly backup your config directory to save your settings.

Troubleshooting

  • Common Issues: List common issues and solutions.
  • Logs: Check Lidarr logs for error messages.
  • Support: Link to the Lidarr community and support resources.
⚠️ **GitHub.com Fallback** ⚠️