Navidrome - Plugins - Lyrics¶

Configuration options for navidrome plugins lyrics.

Additional Options¶

This page has the following additional configuration options:

• Config

nixflix.navidrome.plugins.lyrics.enable¶

Whether to install this plugin's package into services.navidrome.plugins and configure+enable it via the Navidrome API.

false

nixflix.navidrome.plugins.lyrics.package¶

Package producing this plugin's .ndp bundle.

For a plugin not packaged in nixpkgs (i.e. not available under pkgs.pkgsCross.wasi32.navidromePlugins), wrap its .ndp release asset in a minimal derivation. passthru.isNavidromePlugin = true is required, as services.navidrome.plugins only accepts packages carrying that flag. Navidrome installs the plugin under this derivation's pname (or bundleName), so apiId must match that same name.

<derivation lyrics-plugin-static-wasm32-unknown-wasip1-8.1.0>

pkgs.stdenvNoCC.mkDerivation {
  pname = "discord-rpc-nd";
  version = "1.2.0";
  src = pkgs.fetchurl {
    url = "https://github.com/<owner>/<repo>/releases/download/v1.2.0/discord-rpc-nd.ndp";
    hash = "sha256-<ndp-hash>";
  };
  dontUnpack = true;
  installPhase = ''
    mkdir -p $out/share
    cp $src $out/share/discord-rpc-nd.ndp
  '';
  passthru.isNavidromePlugin = true;
}

nixflix.navidrome.plugins.lyrics.allLibraries¶

PUT as allLibraries.

false

nixflix.navidrome.plugins.lyrics.allowWriteAccess¶

PUT as allowWriteAccess.

false

nixflix.navidrome.plugins.lyrics.apiId¶

The plugin's /api/plugin/<id> id. This must equal the basename (without .ndp) of the file actually installed to services.navidrome.finalPackage's plugin folder, i.e. package's pname (or bundleName) — not necessarily this attribute's name. It defaults to the attribute name only as a convenience, for packages where the two happen to line up; set it explicitly whenever they don't (see the discord-rich-presence/lyrics first-class plugins for existing examples of this).

"nd-lyrics"

nixflix.navidrome.plugins.lyrics.libraries¶

PUT as libraries (JSON-encoded) when allLibraries = false.

[ ]