Skip to content

Navidrome - Plugins - Lyrics - Config - Providers List

Configuration options for navidrome plugins lyrics config providersList.

Available Options

This page documents 8 configuration options.

nixflix.navidrome.plugins.lyrics.config.providersList

Lyrics providers (use the "+" button to add more)

Typelist of (submodule)
Default 
[
  {
    provider = "lrclib";
  }
  {
    provider = "lyrics.ovh";
  }
]
Declared inmodules/navidrome/plugins/fromGenerated.nix

nixflix.navidrome.plugins.lyrics.config.providersList.*.baseUrl

Custom base URL

Optional. Leave empty to use the provider's default.

Typestring
Default 
""
Declared inmodules/navidrome/plugins/fromGenerated.nix

nixflix.navidrome.plugins.lyrics.config.providersList.*.mediaUserToken

Media user token

The media-user-token of an Apple Music subscriber, required to access lyrics.

Warning

Can be a plain string (visible in Nix store) or { _secret = /path/to/file; } for file-based secrets.

Plain-text secrets will be visible in the Nix store. Use { _secret = path; } for sensitive data.

Typenull or string or (submodule)
Default 
null
Example 
{ _secret = "/run/secrets/secret-file"; }
Declared inmodules/navidrome/plugins/fromGenerated.nix

nixflix.navidrome.plugins.lyrics.config.providersList.*.provider

Provider

One of: lrclib (LRCLIB), lyrics.ovh (lyrics.ovh), lrcmux (lrcmux), kugou (KuGou), netease (NetEase), qqmusic (QQ Music), applemusic (Apple Music), stixoi (stixoi.info), genie (Genie Music), binilyrics (BiniLyrics)

Typeone of "lrclib", "lyrics.ovh", "lrcmux", "kugou", "netease", "qqmusic", "applemusic", "stixoi", "genie", "binilyrics"
Default 
"lrclib"
Declared inmodules/navidrome/plugins/fromGenerated.nix

nixflix.navidrome.plugins.lyrics.config.providersList.*.romanizationScript

Include transliteration (availability varies by song)

One of: none (Off), und-Latn (Latin), und-Hang (Hangul), und-Kana (Katakana)

Typeone of "none", "und-Latn", "und-Hang", "und-Kana"
Default 
"none"
Declared inmodules/navidrome/plugins/fromGenerated.nix

nixflix.navidrome.plugins.lyrics.config.providersList.*.sources

Sources

Typelist of (one of "genius", "kugou", "lrclib", "musixmatch", "netease", "ytmusic")
Default 
[
  "genius"
  "kugou"
  "lrclib"
  "musixmatch"
  "netease"
  "ytmusic"
]
Declared inmodules/navidrome/plugins/fromGenerated.nix

nixflix.navidrome.plugins.lyrics.config.providersList.*.storefront

Storefront

Optional. Storefront code (e.g. us, gb, es). Auto-detected from the account when left empty. Only include it if the auto-detection is not working correctly.

Typestring
Default 
""
Declared inmodules/navidrome/plugins/fromGenerated.nix

nixflix.navidrome.plugins.lyrics.config.providersList.*.translationLanguage

Include translation (availability varies by song)

One of: none (Off), ca (Catalan), zh-Hans-CN (Chinese (Simplified)), en-US (English), fr-FR (French), de-DE (German), it (Italian), ja (Japanese), ko (Korean), pt-BR (Portuguese), es-MX (Spanish)

Typeone of "none", "ca", "zh-Hans-CN", "en-US", "fr-FR", "de-DE", "it", "ja", "ko", "pt-BR", "es-MX"
Default 
"none"
Declared inmodules/navidrome/plugins/fromGenerated.nix