Jellyfin

Jellyfin is optional. Aurral publishes its playlists into an existing Jellyfin music library through the Jellyfin API. It does not create a Jellyfin library or start playback.

Setup

1. In Jellyfin, create an API key that can read the music library.
2. In Aurral, open Settings > Playback > Jellyfin.
3. Enter the Server URL and the API key.
4. Enter a User ID. Aurral uses this Jellyfin user for older playlists that have no Aurral owner.
5. If Aurral and Jellyfin see the files at different paths, add a mapping in Settings > Download clients > Remote path mappings, with Applies to set to Jellyfin.
6. Select Test connection.

Keep the same music library available to Aurral and Jellyfin, or add the path mapping.

How Aurral publishes playlists

Aurral creates or updates a Jellyfin playlist for each enabled flow and static playlist when you save the settings or when the playlist changes. When you delete a playlist or turn off a flow, Aurral deletes the Jellyfin playlist that it created.

Aurral looks for a Jellyfin user with the same username as the Aurral owner of the playlist. The match ignores case. Aurral creates the playlist as a private playlist of that Jellyfin user. If no Jellyfin user matches, Aurral does not publish the playlist.

Edit a playlist in Jellyfin

You can add songs to an Aurral playlist in Jellyfin or in a client such as Feishin. Aurral keeps your additions when it updates the playlist, but they do not appear in Aurral.

To remove a song that Aurral added, remove it in Aurral. If you remove it only in Jellyfin, Aurral can add it again at the next update.

When you delete a flow or static playlist in Aurral, or turn off a flow, Aurral deletes its Jellyfin playlist, including your additions.

Matching and scans

Aurral reads the audio library of the matched Jellyfin user. It finds each track by its exact path in Jellyfin first. If the path does not match, it uses the MusicBrainz recording ID, but only when exactly one track has that ID. It never guesses by title or artist. Aurral publishes only the tracks that it finds, so a missing track does not stop the rest of the playlist.

When you change the Jellyfin settings, Aurral updates the playlists and starts a library scan in the background. Other settings changes do not start this update. A normal library scan request also refreshes the Jellyfin library. If Jellyfin is still indexing files, Aurral retries the incomplete playlists over the next few minutes.