Navidrome - Plugins - Lyrics - Config¶

Configuration options for navidrome plugins lyrics config.

Additional Options¶

This page has the following additional configuration options:

• Providers List

nixflix.navidrome.plugins.lyrics.config¶

Fetch lyrics from multiple sources

{ }

nixflix.navidrome.plugins.lyrics.config.cacheTtlHours¶

Cache TTL (hours)

How long cached lyrics remain valid. Default is 7 days.

168

nixflix.navidrome.plugins.lyrics.config.durationToleranceSeconds¶

Duration tolerance (seconds)

Maximum allowed difference between the track's duration and a provider result's duration. Increasing this may return less accurate results.

3

nixflix.navidrome.plugins.lyrics.config.elrcCacheTtlHours¶

ELRC cache TTL (hours)

Default is 14 days.

336

nixflix.navidrome.plugins.lyrics.config.enableCache¶

Enable lyrics cache

true

nixflix.navidrome.plugins.lyrics.config.instrumentalCacheTtlHours¶

Instrumental cache TTL (hours)

Default is 14 days.

336

nixflix.navidrome.plugins.lyrics.config.instrumentalExtension¶

Instrumental lyrics extension

File extension for instrumental lyrics files.

"txt"

nixflix.navidrome.plugins.lyrics.config.instrumentalText¶

Instrumental lyrics text

The text to use for instrumental lyrics. Leave blank to not return instrumental lyrics to navidrome and skip writing them to files.

"Instrumental"

nixflix.navidrome.plugins.lyrics.config.lrcCacheTtlHours¶

LRC cache TTL (hours)

Default is 7 days.

168

nixflix.navidrome.plugins.lyrics.config.lyricsFormats¶

Lyrics formats

Comma-separated list of formats to fetch, ordered by priority. Remove a format to disable it (not recommended unless you have a specific use case). Valid values: lrc, elrc, ttml, srt, lyricsfile, plain.

"ttml,elrc,lyricsfile,lrc,srt,plain"

nixflix.navidrome.plugins.lyrics.config.lyricsfileCacheTtlHours¶

Lyricsfile cache TTL (hours)

Default is 7 days.

168

nixflix.navidrome.plugins.lyrics.config.negativeCache¶

Cache negative results (i.e. no lyrics found) (per-provider)

true

nixflix.navidrome.plugins.lyrics.config.negativeCacheTtlHours¶

Negative cache TTL (hours)

How long per-provider negative cache entries remain valid. Default is 24 hours.

24

nixflix.navidrome.plugins.lyrics.config.overwriteLyrics¶

Overwrite existing lyrics files

false

nixflix.navidrome.plugins.lyrics.config.perTypeCacheTtl¶

Use a separate cache TTL per lyrics type

false

nixflix.navidrome.plugins.lyrics.config.plainCacheTtlHours¶

Plain cache TTL (hours)

Default is 3 days.

72

nixflix.navidrome.plugins.lyrics.config.plainExtension¶

Plain lyrics extension

File extension for plain lyrics files. LRC, ELRC, TTML, SRT and YAML files always use their standard extension.

"txt"

nixflix.navidrome.plugins.lyrics.config.preferUncensored¶

Prefer uncensored lyrics

false

nixflix.navidrome.plugins.lyrics.config.providerMode¶

Provider mode

One of: priority (Priority), rotation (Rotation), type (Type priority), sync (Best sync level)

"priority"

nixflix.navidrome.plugins.lyrics.config.requireAlbumMatch¶

Require album match (the track and provider result must have matching albums. Improves accuracy but may reduce matches)

false

nixflix.navidrome.plugins.lyrics.config.srtCacheTtlHours¶

SRT cache TTL (hours)

Default is 7 days.

168

nixflix.navidrome.plugins.lyrics.config.stripSectionLabels¶

Strip section labels ([Verse], [Chorus], etc.)

false

nixflix.navidrome.plugins.lyrics.config.ttmlCacheTtlHours¶

TTML cache TTL (hours)

Default is 14 days.

336

nixflix.navidrome.plugins.lyrics.config.writeLyrics¶

Write lyrics to sidecar files

false

nixflix.navidrome.plugins.lyrics.config.writeToSpecificFolder¶

Write lyrics to a custom path instead of next to each song file.

false

nixflix.navidrome.plugins.lyrics.config.writeToSpecificFolderLibraryId¶

Library ID

The library whose root will be used as the base for the output path. Use the numeric ID as shown in Navidrome.

null

nixflix.navidrome.plugins.lyrics.config.writeToSpecificFolderTemplate¶

Output path template

Path relative to the selected library root. Supports template variables. See GitHub for the full list.

"_lyrics/{type}/{track:album_artist} - {track:album}/{track:disc_number:2} - {track:track_number:2} {track:title}"