docs.neptuneplayer.com
Warning: If this is a folder, all contents including subfolders and documents will be deleted.
Define path-based access rules for sections of your wiki, then assign users to groups in the Users tab. Rules are evaluated in order. First match wins.
Create and manage backups of your wiki data. Backups include all documents, images, and configuration files.
Neptune Indexers is the indexing extension for Jellyfin.
It is not required for Neptune to index your library.
Neptune clients build a local database of your library that powers instant search, technical filtering, and content categorization.
By default, each client builds this index independently on-device.
The Indexers plugin moves that responsibility from the client to the server.
The server indexes your entire library and pushes the results to every connected Neptune client, so no device has to build its own.
It also enriches music video libraries with credits, artist info, and artwork.
| Without Indexers | With Indexers |
|---|---|
| Each client indexes independently | Server indexes once, clients pull the result |
| New devices run a full sync on first launch | New devices import the index in seconds |
| Index speed limited by client hardware | Thousands of items indexed per second on server |
| New media indexed on next client launch | New media indexed automatically on the server |
| Search covers backend metadata only | Search index includes full cast and crew credits |
Library Index.
Powers the Library tab's technical filters (resolution, codec, container, HDR format, subtitle language) and browse views.
The server pre-computes filter facets so clients can render the filter sidebar without scanning their local database.
Search Index.
Pre-builds the search database that Local Index Search queries against.
Music Index.
Enriches music video libraries and their artists.
Indexes rebuild automatically when your library changes.
If nothing changed, the rebuild is skipped so clients never re-download identical data.
If your server has music video libraries, the plugin fills in the metadata that Jellyfin normally leaves blank.
Everything is written to the server's own database, so the results show up in every client, not just Neptune.
| Feature | What you get |
|---|---|
| Credits | Full crew, cast, and featured artists for each music video, in credit order |
| Artist info | Biographies, genres, and artist photos |
| Backdrops | HD artist backgrounds applied to artists and their music videos |
| Albums | Empty album tags filled in automatically (existing tags are never overwritten) |
| Album art | Cover images for albums |
Remote images fetched by the plugin are labeled with their source in Jellyfin's image picker, so you can tell where each option came from.
After installing: run Build Music Index once (Dashboard > Scheduled Tasks > Neptune) to backfill your existing items.
New items are enriched automatically as they're added.
Re-runs are fast because results are cached.
Find the plugin at Dashboard > Plugins > Neptune Indexers.
The page shows status cards for each index (last built, item count, size, build time) and offers:
| Setting | Description |
|---|---|
| Rebuild Library Index / Rebuild Search Index | Force a rebuild on demand |
| Auto-rebuild indexes when the library changes | On by default |
| Debounce window | How long to wait after library changes before rebuilding |
| Excluded libraries | Leave specific libraries out of the indexes |
| Music metadata toggles | Turn individual enrichment features (credits, artist info, albums, album art) on or off |
| Wipe Indexer Data | Clear all built indexes |
Open Dashboard > Plugins > Neptune Indexers, enter the keys you want to use under Optional API keys, and select Save.
The fields are intentionally blank when you return to the page; the status below each field tells you whether a key is already saved.
Leaving a blank field alone keeps its saved value.
To delete a key, select its Remove saved key button and then select Save.
You can undo a pending removal before saving.
| Provider | How to obtain a key | What it enables |
|---|---|---|
| TMDB | Create or sign in to a TMDB account and open API settings. Request an API key, then copy the API Key from the API settings page. Use the v3 API Key, not the API Read Access Token. | Full movie and series cast and crew in the Search Index |
| fanart.tv | Create or sign in to fanart.tv and request an API key. Generate a Personal API Key and copy it into the plugin page. | HD artist and music-video backgrounds |
| IMVDb | Sign in to IMVDb and register a new application. Copy the application's App Key into the plugin page. | IMVDb music-video metadata, credits, and images |
The keys are stored in Neptune Indexers' configuration on your Jellyfin server.
They are not embedded in the plugin source code or binaries and are not sent to Neptune clients.
A Jellyfin administrator or someone with access to the server's plugin configuration files may still be able to retrieve them.
Each key is optional.
Without a key, only that provider's enrichment is skipped: normal Library and Search Index builds and the other music metadata providers continue to work.
After adding a TMDB key, rebuild the Search Index.
After adding fanart.tv or IMVDb keys, run Build Music Index or refresh the affected music-video metadata.