From 7c46dcd1cbca0cf509c610a0ebcace0a9144d401 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Tue, 13 Jul 2021 19:15:03 +0000 Subject: [PATCH] Bot Updating Documentation --- images/docker-lidarr.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/images/docker-lidarr.md b/images/docker-lidarr.md index a3d75ebecb..2cb6558a67 100644 --- a/images/docker-lidarr.md +++ b/images/docker-lidarr.md @@ -49,6 +49,14 @@ Special Note: Following our current folder structure will result in an inability Another item to keep in mind, is that within lidarr itself, you should then map your download client folder to your lidarr folder: Settings -> Download Client -> advanced -> remote path mappings. I input the host of my download client (matches the download client defined) remote path is /downloads/Music (relative to the internal container path) and local path is /media/downloads/completed/Music, assuming you have folders to seperate your downloaded data types. +### Media folders + +We have set `/music` and `/downloads` as ***optional paths***, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content. + +Use the optional paths if you dont understand, or dont want hardlinks/atomic moves. + +The folks over at servarr.com wrote a good [write-up](https://wiki.servarr.com/docker-guide#consistent-and-well-planned-paths) on how to get started with this. + ## Usage To help you get started creating a container from this image you can either use docker-compose or the docker cli. @@ -68,8 +76,8 @@ services: - TZ=Europe/London volumes: - /path/to/appdata/config:/config - - /path/to/music:/music - - /path/to/downloads:/downloads + - /path/to/music:/music #optional + - /path/to/downloads:/downloads #optional ports: - 8686:8686 restart: unless-stopped @@ -85,8 +93,8 @@ docker run -d \ -e TZ=Europe/London \ -p 8686:8686 \ -v /path/to/appdata/config:/config \ - -v /path/to/music:/music \ - -v /path/to/downloads:/downloads \ + -v /path/to/music:/music `#optional` \ + -v /path/to/downloads:/downloads `#optional` \ --restart unless-stopped \ ghcr.io/linuxserver/lidarr ``` @@ -166,6 +174,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to ## Versions +* **11.07.21:** - Make the paths clearer to the user. * **18.04.21:** - Switch `latest` tag to net core. * **25.01.21:** - Publish `develop` tag. * **20.01.21:** - Deprecate `UMASK_SET` in favor of UMASK in baseimage, see above for more information.