Add new parameter information

#19
pull/35/head
RandomNinjaAtk 2 years ago committed by GitHub
parent 209190576d
commit 09d90abe4e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -47,6 +47,8 @@ Container images are configured using parameters passed at runtime (such as thos
| `-e audioFormat=native` | native or alac or mp3 or aac or opus :: native is the native download client file type, selected by the matching audio bitrate | | `-e audioFormat=native` | native or alac or mp3 or aac or opus :: native is the native download client file type, selected by the matching audio bitrate |
| `-e audioBitrate=lossless` | lossless or high or low or ### :: lossless = flac files, high = 320K, low = 128k/96k, ### = the output bitrate of converted lossless files to selected audioFormat that is not native, example: 192... | | `-e audioBitrate=lossless` | lossless or high or low or ### :: lossless = flac files, high = 320K, low = 128k/96k, ### = the output bitrate of converted lossless files to selected audioFormat that is not native, example: 192... |
| `-e requireQuality=true` | true = enabled :: Downloads will be required to have the requested file format | | `-e requireQuality=true` | true = enabled :: Downloads will be required to have the requested file format |
| `-e enableBeetsTagging=true` | true = enabled :: Downloads will be processed and tagged by Beets |
| `-e enableReplaygainTags=true` | true = enabled :: Downloads will be tagged with Replaygain Metadata |
| `-e audioLyricType=both` | both or explicit or clean :: both, is explicit perferred matching, explicit is explicit releases only matching and clean is clean releases only matching | | `-e audioLyricType=both` | both or explicit or clean :: both, is explicit perferred matching, explicit is explicit releases only matching and clean is clean releases only matching |
| `-e dlClientSource=both` | deezer, tidal or both :: set to both, to use both clients, tidal requires extra steps, view logging output | | `-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 arlToken=` | User ARL token for deemix client |
@ -84,6 +86,8 @@ docker create \
-e audioFormat=native \ -e audioFormat=native \
-e audioBitrate=lossless \ -e audioBitrate=lossless \
-e requireQuality=true \ -e requireQuality=true \
-e enableBeetsTagging=true \
-e enableReplaygainTags=true \
-e audioLyricType=both \ -e audioLyricType=both \
-e dlClientSource=both \ -e dlClientSource=both \
-e arlToken=Token_Goes_Here \ -e arlToken=Token_Goes_Here \
@ -127,6 +131,8 @@ services:
- audioFormat=native - audioFormat=native
- audioBitrate=lossless - audioBitrate=lossless
- requireQuality=true - requireQuality=true
- enableBeetsTagging=true
- enableReplaygainTags=true
- audioLyricType=both - audioLyricType=both
- dlClientSource=both - dlClientSource=both
- arlToken=Token_Goes_Here - arlToken=Token_Goes_Here
@ -150,6 +156,7 @@ services:
- [Lidarr](https://lidarr.audio/) - [Lidarr](https://lidarr.audio/)
- [Musicbrainz](https://musicbrainz.org/) - [Musicbrainz](https://musicbrainz.org/)
- [Docker multi-arch example](https://github.com/ckulka/docker-multi-arch-example) - [Docker multi-arch example](https://github.com/ckulka/docker-multi-arch-example)
- [Beets](https://beets.io/)
- [Deemix download client](https://deemix.app/) - [Deemix download client](https://deemix.app/)
- [Tidal-Media-Downloader client](https://github.com/yaronzz/Tidal-Media-Downloader) - [Tidal-Media-Downloader client](https://github.com/yaronzz/Tidal-Media-Downloader)
- [r128gain](https://github.com/desbma/r128gain) - [r128gain](https://github.com/desbma/r128gain)

Loading…
Cancel
Save