cmcooper1980/amd repository overview

⁠AMD - Automated Music Downloader

cmcooper1980/amd is wholly based on RandomNinjaAtk/amd⁠ which is a Lidarr companion script to automatically download music for Lidarr. The difference in this fork is to include support not only for x86-64 but also added support for both ARM and ARM64 architectures.

⁠Features

• Downloading Music using online sources for use in popular applications (Plex/Kodi/Emby/Jellyfin):
  • Searches for downloads based on Lidarr's album wanted list
  • Downloads using a third party download client automatically
  • FLAC / MP3 (320/120) Download Quality
  • Notifies Lidarr to automatically import downloaded files
  • Music is properly tagged and includes coverart before Lidarr Receives them (Third Party Download Client handles it)

⁠Supported Architectures

The architectures supported by this image are:

⁠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. As this is based/forked from RandomNinjaAtk, see his wiki⁠ to understand how it works.

⁠Usage

Here are some example snippets to help you get started creating a container.

⁠docker

docker create \
  --name=amd \
  -v /path/to/config/files:/config \
  -v /path/to/downloads:/downloads-amd \
  -e PUID=1000 \
  -e PGID=1000 \
  -e AUTOSTART=true \
  -e SCRIPTINTERVAL=1h \
  -e DOWNLOADMODE=wanted \
  -e LIST=both \
  -e SearchType=both \
  -e Concurrency=1 \
  -e FORMAT=FLAC \
  -e BITRATE=320 \
  -e requirequality=false \
  -e MatchDistance=10 \
  -e replaygain=true \
  -e FolderPermissions=766 \
  -e FilePermissions=666 \
  -e MBRAINZMIRROR=https://musicbrainz.org \
  -e MBRATELIMIT=1 \
  -e LidarrUrl=http://x.x.x.x:8686 \
  -e LidarrAPIkey=LIDARRAPI \
  -e ARL_TOKEN=ARLTOKEN	\
  -e NOTIFYPLEX=false \
  -e PLEXLIBRARYNAME=Music \
  -e PLEXURL=http://x.x.x.x:8686 \
  -e PLEXTOKEN=plextoken \
  --restart unless-stopped \
  randomninjaatk/amd 

⁠docker-compose

Compatible with docker-compose v2 schemas.

version: "2.1"
services:
  amd:
    image: cmcooper1980/amd 
    container_name: amd
    volumes:
      - /path/to/config/files:/config
      - /path/to/downloads:/downloads-amd
    environment:
      - PUID=1000
      - PGID=1000
      - AUTOSTART=true
      - SCRIPTINTERVAL=1h
      - DOWNLOADMODE=wanted
      - LIST=both
      - SearchType=both
      - Concurrency=1
      - FORMAT=FLAC
      - BITRATE=320
      - requirequality=false
      - MatchDistance=10
      - replaygain=true
      - FolderPermissions=766
      - FilePermissions=666
      - MBRAINZMIRROR=https://musicbrainz.org
      - MBRATELIMIT=1
      - LidarrUrl=http://x.x.x.x:8686
      - LidarrAPIkey=LIDARRAPI
      - ARL_TOKEN=ARLTOKEN
      - NOTIFYPLEX=false
      - PLEXLIBRARYNAME=Music
      - PLEXURL=http://x.x.x.x:8686
      - PLEXTOKEN=plextoken
    restart: unless-stopped

⁠Script Information

• Script will automatically run when enabled, if disabled, you will need to manually execute with the following command:
  • From Host CLI: docker exec -it amd /bin/bash -c 'bash /config/scripts/download.bash'
  • From Docker CLI: bash /config/scripts/download.bash

⁠Directories:

• /config/scripts
  • Contains the scripts that are run
• /config/logs
  • Contains the log output from the script
• /config/cache
  • Contains the artist data cache to speed up processes
• /config/deemix
  • Contains deemix app data

⁠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
  

⁠Credits

• Forked from RandomNinjaAtk's repository⁠
• Original Idea based on lidarr-download-automation by Migz93⁠
• Deemix download client⁠
• Musicbrainz⁠
• Lidarr⁠
• r128gain⁠
• Algorithm Implementation/Strings/Levenshtein distance⁠