Document ArtistArtPriority (navidrome#119)

* Document ArtistArtPriority * fix typo
srp · Nov 17, 2023 · d8d09fb · d8d09fb
1 parent f5a660f
commit d8d09fb
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 10 deletions.
diff --git a/content/en/docs/Usage/artwork.md b/content/en/docs/Usage/artwork.md
@@ -26,16 +26,13 @@ setting `EnableMediaFileCoverArt=false`.
 
 ## Artists
 
-Image for artists are fetched following these rules:
-1. Try to read an `artist.*` image file from the artist folder (the parent folder of all albums of a given artist). Ex:
-  - `C:\Music\U2\Rattle And Run\CD1\01.mp3`
-  - `C:\Music\U2\Boy\01.mp3`
-
-    It will try to read the image from `C:\Music\U2\artist.*`
-2. If not found, try to read an `artist.*` image from any album for that artist. If more than one is found, the
-   selected one is unpredictable.
-3. If not found, it will try to get it from an external source. Currently, this can only be Spotify, if configured.
-4. If not found, use the artist image placeholder (grey star image).
+Fetching of images for artists is controlled by the `ArtistArtPriority` [config option](/docs/usage/configuration-options).
+This is a comma-separated list of places to look for artist images.
+The default is `artist.*, album/artist.*, external`, meaning:
+- First try to find an `artist.*` image in the artist folder(s)
+- If not found, try to find an `artist.*` image in one of the album folders for this artist
+- If not found, try to fetch it from an [external service](/docs/usage/external-integrations) (currently only Spotify)
+- If not found, use the artist image placeholder (grey star image)
 
 ## Playlists
 

diff --git a/content/en/docs/Usage/configuration-options.md b/content/en/docs/Usage/configuration-options.md
@@ -126,6 +126,7 @@ make it all uppercase. Ex: `ND_LOGLEVEL=debug`. See below for all available opti
 | AuthWindowLength[\*][limit-login-attempts]     | `ND_AUTHWINDOWLENGTH`             | Window Length for the authentication rate limit                                                                                                                                                                            | `"20s"`                                                    |
 | AutoImportPlaylists                            | `ND_AUTOIMPORTPLAYLISTS`          | Enable/disable `.m3u` playlist auto-import                                                                                                                                                                                 | `true`                                                     |
 | CoverArtPriority                               | `ND_COVERARTPRIORITY`             | Configure the order to look for cover art images. Use special `embedded` value to get embedded images from the audio files                                                                                                 | `cover.*, folder.*, front.*, embedded, external`           |
+| ArtistArtPriority                              | `ND_ARTISTARTPRIORITY`            | Configure the order to look for artist images.                                                                                                                                                                             | `artist.*, album/artist.*, external`                       |
 | CoverJpegQuality                               | `ND_COVERJPEGQUALITY`             | Set JPEG quality percentage for resized cover art images                                                                                                                                                                   | `75`                                                       |
 | DefaultDownsamplingFormat                      | `ND_DEFAULTDOWNSAMPLINGFORMAT`    | Format to transcode to when client requests downsampling (specify maxBitrate without a format)                                                                                                                             | `opus`                                                     |
 | DefaultLanguage                                | `ND_DEFAULTLANGUAGE`              | Sets the default language used by the UI when logging in from a new browser. This value must match one of the file names in the [resources/i18n][i18n]. Ex: for Chinese Simplified it has to be `zh-Hans` (case sensitive) | `"en"`                                                     |