From cee799b2f110672ae33802075827251a156b8ea7 Mon Sep 17 00:00:00 2001 From: RandomNinjaAtk Date: Wed, 15 Jun 2022 11:38:46 +0000 Subject: [PATCH] Update README.md --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fddfb44..f45b587 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,32 @@ The architectures supported by this image are: | :----: | --- | | latest | Lidarr nightly + Extended Scripts | - ## Application Setup Access the webui at `:8686`, for more information check out [Lidarr](https://lidarr.audio/). + +## Parameters + +Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. See the [wiki](https://github.com/RandomNinjaAtk/docker-amd/wiki) to understand how it works. + +| Parameter | Function | +| --- | --- | +| `-v /config` | Configuration files for Lidarr. | +| `-v /downloads` | Path to your download folder location. (required path)| +| `-v /music` | Path to your music folder location. (required path)| +| `-v /music-videos` | Path to your music-videos folder location.| +| `-e PUID=1000` | for UserID - see below for explanation | +| `-e PGID=1000` | for GroupID - see below for explanation | +| `-e autoStart=true` | true = enabled :: Runs script automatically on startup | +| `-e dlClientSource=both` | deezer, tidal or both :: set to both, to use both clients, tidal requires extra steps, view logging output | +| `-e arlToken=` | User ARL token for deemix client | +| `-e addRelatedArtists=false` | true = enabled :: Enabling this will enable the extended script to automatically add artists that are related to your existing Lidarr artists from Deezer | +| `-e plexUrl=http://x.x.x.x:32400` | ONLY used if PlexNotify.bash is used...| +| `-e plexToken=` | ONLY used if PlexNotify.bash is used... | + +# Credits +- [Deemix download client](https://deemix.app/) +- [Musicbrainz](https://musicbrainz.org/) +- [Lidarr](https://lidarr.audio/) +- [r128gain](https://github.com/desbma/r128gain) +- [Tidal-Media-Downloader client](https://github.com/yaronzz/Tidal-Media-Downloader)