Skip to content

Jellyfin - Plugins - "Open Subtitles"

Configuration options for jellyfin plugins "Open Subtitles".

Available Options

This page documents 7 configuration options.

nixflix.jellyfin.plugins."Open Subtitles".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.

Typeboolean
Default
false
Declared inmodules/jellyfin/plugins/openSubtitles.nix

nixflix.jellyfin.plugins."Open Subtitles".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.

Typenull or package or (submodule)
Default
{
  hash = "sha256-b6sgmgBlvhUAhFuq0p/EjB3604NGBkpS4NP33n1hfKc=";
  repository = null;
  version = "24.0.0.0";
}
Example
nixflix.lib.jellyfinPlugins.fromRepo {
  version = "13.0.0.0";
  hash = "sha256-16jaQRh1rIFE27nSSEWNF7UjVsPJDaRf24Ews0BZGas=";
}
Declared inmodules/jellyfin/plugins/openSubtitles.nix

nixflix.jellyfin.plugins."Open Subtitles"

This option has no description.

Typesubmodule
Default
{ }
Declared inmodules/jellyfin/plugins/openSubtitles.nix

nixflix.jellyfin.plugins."Open Subtitles".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'

Typestring
Default
"‹name›"
Example
"SSO-Auth"
Declared inmodules/jellyfin/plugins/openSubtitles.nix

nixflix.jellyfin.plugins."Open Subtitles".config

Open Subtitles plugin configuration payload as posted to the Jellyfin API. You can utilize this plugin by editing a library and modifying the options for subtitle downloads.

Typesubmodule
Default
{ }
Declared inmodules/jellyfin/plugins/openSubtitles.nix

nixflix.jellyfin.plugins."Open Subtitles".config.Password

Password for OpenSubtitles.com

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.

Typestring or (submodule)
Default
null
Example
{ _secret = "/run/secrets/secret-file"; }
Declared inmodules/jellyfin/plugins/openSubtitles.nix

nixflix.jellyfin.plugins."Open Subtitles".config.Username

Username from OpenSubtitles.com

Typestring
Default
""
Declared inmodules/jellyfin/plugins/openSubtitles.nix