This repository is now deprecated, will no longer be updated and is being archived. Please visit the new project/replacement:
RandomNinjaAtk/atd is a script to automatically archive music for use in other audio applications (plex/kodi/jellyfin/emby)
The architectures supported by this image are:
Architecture | Tag |
---|---|
x86-64 | latest |
Tag | Description |
---|---|
latest | Newest release code |
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 |
---|---|
-e PUID=1000 |
for UserID - see below for explanation |
-e PGID=1000 |
for GroupID - see below for explanation |
-v /config |
Configuration files for ATD |
-v /downloads-atd |
Downloaded library location |
-e AutoStart=true |
true = Enabled :: Runs script automatically on startup |
-e ScriptInterval=15m |
#s or #m or #h or #d :: s = seconds, m = minutes, h = hours, d = days :: Amount of time between each script run, when AUTOSTART is enabled |
-e LidarrUrl=http://x.x.x.x:8686 |
REQUIRED: Lidarr URL, Lidarr provides artist list for processing with ATD... |
-e LidarrApiKey=08d108d108d108d108d108d108d108d1 |
REQUIRED: Lidarr API Key, enables ATD to connect to Lidarr... |
-e MusicbrainzMirror=https://musicbrainz.org |
OPTIONAL :: Only change if using a different mirror |
-e MusicbrainzRateLimit=1 |
OPTIONAL: musicbrainz rate limit, musicbrainz allows only 1 connection per second, max setting is 10 :: Set to 101 to disable limit |
-e ScriptMode=both |
REQUIRED: set to: music or video or both :: both downloads music and videos, the others set the download to the desired media type |
-e EnableReplayGain=true |
true = enabled :: Scans and analyzes files to add replaygain tags to song metadata |
-e CountryCode=US |
Set to Tidal Region, same region as your account |
-e Compilations=false |
false = disabled; true = enabled :: Enabling this downloads compilations the Artist Appears On... |
-e WantedQuality=FLAC |
FLAC or 320 or 128 :: Maxium Quality :: FLAC (CD quality 16bit), 320 (320 kbps AAC), 128 (128 kbps AAC) |
-e RequireQuality=false |
false = disabled; true = enabled :: Enabling requires the downloads to match the expected file type (.flac or .m4a)... |
-e FolderPermissions=777 |
Folder Permissions (chmod) |
-e FilePermisssions=666 |
File Permissions (chmod) |
Only videos work at this time.
To execute script from CLI, do the following:
docker exec -it atd /bin/bash
bash /config/scripts/video.sh
Here are some example snippets to help you get started creating a container.
docker create \
--name=atd \
-v /path/to/config/files:/config \
-v /path/to/downloads:/downloads-atd \
-e PUID=1000 \
-e PGID=1000 \
-e AutoStart=true \
-e ScriptInterval=1h \
-e LidarrUrl=http://x.x.x.x:8686 \
-e LidarrApiKey=LIDARRAPI \
-e MusicbrainzMirror=https://musicbrainz.org \
-e MusicbrainzRateLimit=1 \
-e ScriptMode=both \
-e EnableReplayGain=true \
-e CountryCode=US \
-e Compilations=false \
-e WantedQuality=FLAC \
-e RequireQuality=false \
-e FolderPermissions=777 \
-e FilePermisssions=666 \
--restart unless-stopped \
randomninjaatk/atd
Compatible with docker-compose v2 schemas.
version: "2.1"
services:
amd:
image: randomninjaatk/atd
container_name: atd
volumes:
- /path/to/config/files:/config
- /path/to/downloads:/downloads-atd
environment:
- PUID=1000
- PGID=1000
- AutoStart=true
- ScriptInterval=1h
- LidarrUrl=http://x.x.x.x:8686
- LidarrApiKey=LIDARRAPI
- MusicbrainzMirror=https://musicbrainz.org
- MusicbrainzRateLimit=1
- ScriptMode=both
- EnableReplayGain=true
- CountryCode=US
- Compilations=false
- WantedQuality=FLAC
- RequireQuality=false
- FolderPermissions=777
- FilePermisssions=666
restart: unless-stopped