Jellyfin - Plugins¶

Configuration options for jellyfin plugins.

nixflix.jellyfin.plugins¶

Jellyfin plugins to manage declaratively.

Each key is the plugin name exactly as it appears in the Jellyfin repository manifest (e.g. "Anime", "Bookshelf", "Trakt"). Plugin names must be unique across all configured plugin repositories.

Plugins are installed from package. This can either be a normal Nix derivation, or a repository lookup created with nixflix.lib.jellyfinPlugins.fromRepo.

Plugin changes (installs, removals, version updates) cause Jellyfin to restart automatically. Plan plugin changes for maintenance windows to avoid interrupting active streams.

{ }

{
  "Bookshelf" = {
    package = nixflix.lib.jellyfinPlugins.fromRepo {
      version = "13.0.0.0";
      hash = "sha256-16jaQRh1rIFE27nSSEWNF7UjVsPJDaRf24Ews0BZGas=";
    };
    config = {
      # Plain string (visible in Nix store)
      ComicVineApiKey = "my-api-key";
      # Or as a secret (read from file at activation time)
      # ComicVineApiKey._secret = "/run/secrets/comic-vine-api-key";
    };
  };

  "Intro Skipper" = {
    package = myJellyfinPlugin;
  };
}

nixflix.jellyfin.plugins.<name>.apiName¶

The plugin's Name as reported by the Jellyfin /Plugins API. Defaults to the attribute name. Set this when the plugin's self-reported API name differs from its manifest name (e.g. the SSO-Auth plugin is listed in the manifest as "SSO Authentication" but reports itself via the API as "SSO-Auth").

Can be found when running the following while the plugin is installed:

curl -s -H "Authorization: MediaBrowser Token=$(sudo cat /run/jellyfin/auth-token)" \
                     http://127.0.0.1:8096/Plugins | jq '.[].Name'

"‹name›"

"SSO-Auth"

nixflix.jellyfin.plugins.<name>.config¶

Plugin configuration payload as seen in the Jellyfin UI/API. All attributes under this option are POSTed to /Plugins/<id>/Configuration.

{ }

{
  ComicVineApiKey._secret = "/run/secrets/comic-vine-api-key";
}

nixflix.jellyfin.plugins.<name>.enable¶

Whether this plugin should be installed. When false, the plugin is treated as absent: if it was previously installed by nixflix it will be uninstalled on the next nixos-rebuild. This is equivalent to removing the attribute entirely from nixflix.jellyfin.plugins.

true

nixflix.jellyfin.plugins.<name>.package¶

Nix package containing the unpacked Jellyfin plugin files to copy into Jellyfin's plugin directory.

For repository-managed plugins, use nixflix.lib.jellyfinPlugins.fromRepo { version = ...; hash = ...; } to resolve a deterministic package from the pinned plugin manifests.

null

nixflix.lib.jellyfinPlugins.fromRepo {
  version = "13.0.0.0";
  hash = "sha256-16jaQRh1rIFE27nSSEWNF7UjVsPJDaRf24Ews0BZGas=";
}