Deprecated
This repository is now deprecated, will no longer be updated and is being set to archived. The script used for this container has been split into multiple scripts going forward to simplify maintenance.
- For Lidarr: https://github.com/linuxserver/docker-lidarr (Preview Tag, same version of Lidarr used fo this container...)
- For Audio: https://github.com/RandomNinjaAtk/docker-amd
- For Videos: https://github.com/RandomNinjaAtk/docker-amvd
Migration info:
https://github.com/RandomNinjaAtk/docker-lidarr-lad/wiki/Migration
RandomNinjaAtk/lidarr-lad
Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
Lidarr-Automated-Downloader (LAD) is a open-source script that is integrated into this container
This containers base image is provided by: linuxserver/lidarr:preview
Supported Architectures
The architectures supported by this image are:
| Architecture | Tag |
|---|---|
| x86-64 | amd64-latest |
Version Tags
| Tag | Description |
|---|---|
| latest | Lidarr Nightly releases |
Parameters
Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
| Parameter | Function |
|---|---|
-p 8686 |
Application WebUI |
-e PUID=1000 |
for UserID - see below for explanation |
-e PGID=1000 |
for GroupID - see below for explanation |
-e TZ=Europe/London |
Specify a timezone to use EG Europe/London. |
-e UMASK_SET=022 |
control permissions of files and directories created by Lidarr. |
-v /config |
Configuration files for Lidarr. |
-v /storage |
Path to your download and music folder. (DO NOT DELETE, this is a required path) |
-e VIDEOPATH="/path/to/vides" |
Location of music videos |
-e LidarrUrl="http://127.0.0.1:8686" |
OPTIONAL :: Only needed if utilizing "URL Base" option |
-e MBRAINZMIRROR="https://musicbrainz.org" |
OPTIONAL :: Only change if using a different mirror |
-e DLMODE="Audio" |
Both or Audio or Video :: "Both" downloads audio and videos; "Audio" downlods only audio files; "Video" only downloads video files |
-e AMODE="wanted" |
wanted or archive :: wanted mode processes Lidarr Wanted/Cutoff Album lists (TrackUpgrade must be enabled for Cutoff) :: archive mode downloads all albums for an aritst, no lidarr matching is used for importing, keeps everything... WARNING: When using archive mode, do not rename album folders or you will continuely re-download available albums... |
-e IMODE="match" |
match or forced or manual :: "match" uses lidarr's matching engine to import; "forced" moves the download into the Lidarr artist directory; "manual" downloads are left in the temp import directory for you to manual import |
-e TRACKUPGRADE=false |
true = Enabled :: Upgrades existing tracks to requested format. wanted mode is controlled by cutoff album list and archive mode is detected automatically. Recommend disabling for archive mode, unless your changing your format. |
-e ENABLE_LAD=TRUE |
TRUE = Enabled :: Runs LAD script automatically every 15 minutes via cronjob |
-e ARL_TOKEN="" |
User token for dl client, for instructions to obtain token: https://notabug.org/RemixDevs/DeezloaderRemix/wiki/Login+via+userToken#how-do-i-get-my-usertoken |
-e CONCURRENCY=4 |
Number of concurrent tracks to download via the client. Increasing can speed things up but is more resource intensive, lower is safer... |
-e VerifyTrackCount=true |
true = enabled :: This will verify album track count vs dl track count, if tracks are found missing, it will skip import... |
-e amount=1000000000 |
Maximum: 1000000000 :: Number of missing/cutoff albums to look for... |
-e quality=MP3 |
SET TO: FLAC or MP3 or OPUS or AAC or ALAC |
-e ConversionBitrate=320 |
FLAC -> OPUS/AAC will be converted using this bitrate |
-e ReplaygainTagging=false |
TRUE = ENABLED :: adds replaygain tags for compatible players (FLAC ONLY) |
-e FolderPermissions=777 |
Based on chmod linux permissions |
-e FilePermissions=666 |
Based on chmod linux permissions |
-e DownLoadArtistArtwork=true |
true = enabled :: Uses Lidarr Artist artwork first with a fallback using LAD as the source |
-e TagWithBeets=true |
true = enabled :: enable beet tagging to improve matching accuracy |
-e RequireQuality=false |
true = enabled :: skips importing files that do not match quality settings |
-e CountryCode=us |
Set the country code for preferred video matching, uses Musicbrainz Country Codes, lowercase only. |
-e RequireVideoMatch=true |
true = enabled :: Only keep videos that could be matched to a Musicbrainz music track. |
-e videoformat="--format bestvideo[vcodec*=avc1]+bestaudio[ext=m4a]" |
For guidence, please see youtube-dl documentation |
-e subtitlelanguage="en" |
Desired Language Code :: For guidence, please see youtube-dl documentation. |
videoformat
LAD Information
- Script is scheduled to run every 15 minutes via a cron job
Directories:
- /storage/downloads/lidarr/dlclient
- DL client temporary DL directory
- /storage/downloads/lidarr/lidarr-import
- lidarr directory used for automated imports
- /config/scripts
- /config/scripts/cache
- Contains all cached album-lists to speed up results
Files:
- lidarr-automated-downloader.bash
- LAD script, this file is updated on every image update
- cron-job.log
- Log of last attempt to execute
- script-run.log
- Current log of script run, can be seen in normal docker log
- notfound.log
- Log file containing list of albums that could not be found using normal or fuzzy matching, automatically cleared every Saturday via cron
- musicbrainzerror.log
- Log file containing list of artists without links, open log for more details
- imvdberror.log
- Log file containing list of artists without links to IMVDb, open log for more details
- download.log
- Log file containing list of albums that were downloaded, automatically cleared every Saturday via cron
- beets-config.yaml
- Beet config file for matching
- beets-library.blb
- Beet library file, do not touch
- artwork.bash
- Custom embedded ablum artwork extraction script to be added to Lidarr as a custom script, see Lidarr Recommendations below
Lidarr Configuration Recommendations
Media Management Settings:
- Disable Track Naming
- Disabling track renaming enables synced lyrics that are imported as extras to be utilized by media players that support using them
Track Naming:
- Artist Folder:
{Artist Name}{ (Artist Disambiguation)} - Album Folder:
{Artist Name}{ - ALBUM TYPE}{ - Release Year} - {Album Title}{ ( Album Disambiguation)}
Importing:
- Enable Import Extra Files
lrc,jpg,png
File Management
- Change File Date: Album Release Date
Permissions
- Enable Set Permissions
Connect Settings
Add Custom Script
- Settings -> Connect -> + Add -> custom Script
| Parameter | Value |
|---|---|
| Name | Album Artwork Extractor |
| On Grab | No |
| On Release Import | Yes |
| On Upgrade | Yes |
| On Download Failure | No |
| On Import Failure | No |
| On Rename | Yes |
| On Track Retag | Yes |
| On Health Issue | No |
| Tags | leave blank |
| Path | /config/scripts/artwork.bash |
This script will extract the embedded file artwork and store it in the local ablum folder