github Chevron7Locked/kima-hub v1.13.0
Kima v1.13.0

2 hours ago

Important

Upgrading to 1.13

  • Your play history is rewritten and checked once on first start. This adds a short wait on a very large history (hundreds of thousands of plays).
  • Covers get a one-time pass after start. Kima versions every stored cover so a changed picture is fetched fresh, and moves album covers from the top of the covers folder into an albums folder inside it. Pictures already shown keep working while it runs.
  • Run a library scan after upgrading so Subsonic apps see each song's real bitrate. A song already in your library shows its genres in vote order the next time its genres are written; until then they show in name order.
  • /api/metrics is admin-only. A metrics scraper needs an admin's app key; a member's key is now refused.
  • Subsonic apps can no longer manage accounts (see Removed).
  • Two-factor recovery codes are now 16 characters. Older 8-character codes keep working until you make new ones.

Added

  • Two-factor recovery from settings. You can turn two-factor sign-in off with a recovery code if you have lost your authenticator, and make a new set of recovery codes without turning it off; the old codes stop working.
  • An admin can turn off two-factor sign-in for someone locked out, from the users list. That person is signed out on every device.
  • The what's new window asks you to star Kima on GitHub, with a link in its header that stays in view whichever page of it you open. The window is wide again for every release.

Changed

  • The image's PostgreSQL is fixed at 16.16. It used to take whatever 16.x was current when the image was built, so two builds of one release could carry different versions. Every build now carries 16.16, a minor update on the same data, with nothing to do on upgrade.
  • Your listening history survives when a song leaves the library. When the same recording is on another album in your library, for example a deluxe edition, its plays, your like and its spots in your playlists move to that copy. When no copy is left, its plays stay in your stats under the song's name, and return to the song if it comes back.
  • On a phone, the what's new window opens on the release's summary, above its list, instead of on the list alone.
  • Saving settings reloads only what changed. Changing one setting no longer drops the Soulseek connection or reloads Lidarr, Audiobookshelf and fanart; each reloads only when its own settings change, and turning Audiobookshelf on or off takes effect at once.
  • Saving Lidarr settings sets up its webhook only when something changed. The webhook is set up again only when Lidarr's on-switch, address or key changed; a broken link is still repaired at the next health check. Soulseek now also reconnects when it is switched on or off.
  • Playlists mark songs that can't play. A playlist keeps listing a song whose file went missing or unreadable, or that now sits only in Discover, marked "unavailable"; play, shuffle and add to queue skip it, and the play buttons hide when nothing in the playlist can play. Adding such a song to a playlist is refused.
  • A playlist can list a song more than once. Importing a playlist or M3U file, or building one in a Subsonic app, keeps both copies of a song the source lists twice, each where the source has it, and removing a song on the playlist page takes out only that row. Playing one of the copies marks only that row as playing, and the next song follows on from it. Adding a song that is already there asks "add again" or "skip"; adding several when some are already there offers "add all" or "add new ones".
  • Imported songs that turn up later go into their place. A song from an import that was still waiting goes into its place in the playlist when it turns up, instead of at the end. A refresh finds waiting songs the way a library scan does (a title with a version suffix, a song on a compilation), fills each one even when the same song is already in the playlist, and never brings back a waiting song you removed. One playlist that fails during a library scan no longer stops the others being filled, and changing a playlist's songs from a Subsonic app keeps the waiting songs in their places.
  • The stats page counts only your library. Plays of Discover songs are left out of every number on the stats page, and the play sources chart shows library and Subsonic apps only. A Discover album you liked moves to your library, so its plays, earlier ones included, count from then on. The "discover, kept" segment and the keep-rate line are gone.
  • Recently listened counts real listens. The row counts a song you listened to, not every repeat or skip, and fills up whenever you have listened to enough different artists. Most played songs with the same count list the one played most recently first.
  • Popular songs match across apps. Subsonic top songs and the artist page's popular songs now come in the same order, and Subsonic ranks them by your own plays instead of everyone's. A slow or unreachable ListenBrainz, Deezer or MusicBrainz no longer slows the artist page: it answers from your library and your plays instead.
  • Song status shows pending at once. Retrying failed songs, restarting enrichment or rebuilding vectors now shows each song as pending straight away, and a song whose file went missing shows one error: "file missing from the library; a scan that finds it again re-opens this record".
  • Subsonic stars songs only. Starring an album or artist from a Subsonic app now answers an error saying it isn't supported, instead of a star Kima never kept; a star or unstar with no id answers a missing-parameter error. Starring many songs at once is faster.
  • A Subsonic share holds one item. A Subsonic app that asks to share several items at once is now told a share holds one item, instead of Kima quietly sharing only the first.
  • Two-factor codes are easier to type and harder to guess. New recovery codes are 16 characters long, codes can be pasted with spaces or dashes in any case, and an authenticator code is accepted for one 30-second step either side, down from two. Setup keeps its secret on the server, so turning it on always uses the secret your authenticator scanned; setup expires after 10 minutes. Turning two-factor on or off and making new recovery codes are written to the server log with the account.
  • Passwords over 72 characters are refused. Before, everything past the 72nd character was silently ignored. Usernames are trimmed of surrounding spaces when an account is created and when signing in, a blank username is refused, and admins creating an account get the same username length rule as onboarding.

Removed

  • Subsonic apps no longer manage accounts. Changing a password or creating, editing or deleting users from a Subsonic app now answers "not supported"; manage accounts in the web app. Looking up users still works.

Fixed

Library and listening history

  • A song replaced by another copy keeps its history. Its plays, your like, its spots in your playlists and saved queue, and its share links move to the best copy in your library: one that plays first, then lossless, then higher bitrate. A damaged copy still gets them, and the playlist shows it as unavailable until the file is fixed. A song ripped again with different track or disc numbers is matched by its recording.
  • Deleting music cleans up after it. Deleting a song, album, artist or playlist removes its share links. An album left with no songs is removed, artist counts update at once, and Discover's records for those songs go too. Kima removes the library entries first and the files after, so a failed delete no longer leaves entries without their files.
  • A library scan can no longer lose a song it is adding. A song filed into an album at the moment that album was being removed as empty used to be deleted with it.
  • The nightly data check no longer stops when a placeholder artist holds an album the real artist already has. The two copies are merged, keeping their plays, likes and spots in playlists, and Discover's record of that artist's albums is kept, so they aren't suggested or downloaded again.
  • A library scan no longer waits on, or upsets, the check for plays that never really started. A song replaced while that check runs is removed on the next scan instead, and a play reported for a song a scan is removing is refused cleanly instead of being recorded and then lost.
  • A library scan that finds files gone or back, or an enrichment restart, no longer fails when enrichment is busy; it tries once more.
  • Artist counts stay current. Library scans recount only the artists whose songs were added, changed, lost or brought back, and an artist whose songs change during a recount is counted again right after. An admin's recount asked while one runs is queued and runs once more, its progress reaches 100% even when some artists fail (the log says how many, and logs progress every 500 artists), and it says which pass it is on.
  • Recently added keeps its order after a rescan. Recently added, and the newest-albums list in Subsonic apps, order by when an album first arrived, so a rescan no longer moves an album back to the top. An album re-filed under another artist or merged with its twin keeps the time it first arrived.
  • Albums and artists with nothing to play leave the library lists. An album whose every song is missing or could not be read, and an artist with no album that plays, no longer show in the album and artist lists, search, recently added, a genre's artists, an artist's albums or among similar artists in your library, on the web and in Subsonic apps. Album and song counts count only songs that play. They come back when a file does.
  • Similar artists show as in your library as soon as they are, not up to a day later.
  • A library scan finishes even when recovering old plays fails. It still removes songs that are gone and refreshes what apps see, and moving an artist's album credit, or an album's MusicBrainz id, while another change touches it no longer fails.
  • Apps and search refresh straight away after a scan or clean-up removes empty albums or artists.
  • Search results update as soon as songs go missing or a liked Discover album joins the library, instead of up to five minutes later.
  • A played song that has left the library no longer shows under a Discover-only artist of the same name.
  • Links no longer break when an id contains /, ? or #, anywhere in the web app.

Playback and the saved queue

  • Seeking in a song a player has cached checks the file is the same one first. If it changed, the whole song is sent instead of a piece of the new file, and a player that asks with a weak entity tag gets "not modified" when nothing changed. A browser that asks whether a song changed since it last fetched it now gets "not modified" instead of the whole file again.
  • A live playback report with a blank or malformed position or length is refused instead of being saved as a wrong place.
  • A saved queue shows the right song and place. Reopening the web player, the iOS app or a Subsonic app names the queue's current song and its place, even when entries were dropped, replaced or can't play, and the place never points past the end. A save that names a song the queue lacks is ignored, and a place that is negative or not a whole number is refused. A queue holding the same song twice keeps its position only on the right copy and is no longer saved one song short when a song is removed at the same moment. A player that saves only the song it is on lands on that song's place.
  • Songs that can't play stay in the saved queue, hidden. A song whose file is missing or unreadable is kept and comes back when the file is fixed. When it is the current song, the song shown in its place starts from the beginning and your place in the hidden song is kept. Discover songs, and songs a library scan has removed or is removing, are never kept; when the current song is removed the queue moves on to the next one. A song or episode Kima no longer has is cleared from the saved queue, and the queue shows each song's current title and details.
  • Saving a queue behaves the same from every app.
    • Starting a new queue or moving to another song from the web or the iOS app resets a Subsonic app's resume point to the start of the song; saving the queue you are already on keeps it.
    • A Subsonic save with no current song, an empty one, or songs but no index starts from the first song; one that names a current song but sends no songs clears the queue.
    • A Subsonic app that saves a current song or place that does not exist, or one that is not a whole number, gets an error instead of a wrong save. A very large position no longer fails.
    • The admin's queue length limit applies to Subsonic and web saves alike, as it stands when the save lands.
    • Saving your place in a book or podcast episode no longer wipes your music queue, and a save with a malformed song, audiobook or episode id is refused.
    • A queue saved from the web shows Kima as the app that saved it, and clearing playback waits its turn behind a save in progress.
  • Playback follows you between devices without overwriting newer state. A device that finds a saved item gone plays on with what it has instead of stopping, and a tab you come back to checks your other devices at once and sends any change it had not saved. An older or late save never replaces a newer change, a failed save is sent again with a pause between tries, and a change made as you close or hide the tab is still saved. Following no longer depends on this device's clock, a queue changed on another device follows while the same song plays, and a removed audiobook or episode is no longer asked for again and again. The player no longer saves the same playback twice when the server is slow to answer.
  • Play and pause buttons act on what is playing. The play icon on a song row turns to pause while that song plays, pressing it pauses, and play resumes from the same point instead of starting the list again; a double click never pauses. The big play button on an album, artist, mix, playlist or Discover page resumes music started from that page, also after a reload, on another device and with songs added by add to queue or play next. A song of that album started from elsewhere leaves the button saying play, and two artists with the same name no longer both show as playing.
  • The queue plays what it shows. Removing, moving or replacing the next song in a song's last 30 seconds plays the song the queue shows next, and a one-song repeat plays without a gap. Clicking a song in the queue panel jumps to it without rebuilding the queue or changing the shuffle order, starting a list at a place it does not have plays it from the top, and the buttons on a song row act on the list as it is now.
  • The web player skips songs whose file can't be read. It answers "not available" instead of stalling, and such songs are no longer prepared ahead of play. Discover songs still play. A saved playback quality Kima doesn't know plays the original.
  • An empty audio file answers "not found" even when the player already holds a cached copy.

Playlists and imports

  • Creating a playlist makes one playlist even if you retry after the first answer was lost, from the sidebar, the playlists page or the add dialog. A retry with a different name or visibility makes that playlist.
  • The add-to-playlist dialog says what went wrong. It says when your playlists couldn't be loaded and lets you try again, and stays open with, for example, "1 song couldn't be added". If a new playlist was made but adding to it failed, trying again adds to that playlist. It opens with an empty name, can't be closed while songs are being added, and Enter no longer makes a nameless playlist, two on a double press, or submits a name still being typed with an input method. An add that gets no answer ends after 30 seconds. After reopening, an earlier add no longer blocks the new one, and the playlist page refreshes once after adding songs.
  • Playlists show only what they need to. A playlist's songs no longer carry their file paths or analysis details, and other people's public playlists no longer carry the owner id or mix and Spotify links.
  • Saving a mix as a playlist no longer makes an empty one when its songs have gone from the library. A mix card counts only the songs that still play, and offers no save when none are left.
  • Imports pick only songs that play. Importing from a link or an M3U file, and the weekly Discover playlist, no longer pick a song whose file is missing or unreadable, and an import no longer adds a Discover song to a playlist.
  • Import counts stay right. An import builds its playlist once, even when a scan and a progress check finish together, and a cancelled import makes no playlist. A song you dismiss from the waiting list comes off the total, stays out of the playlist and is not added back by a scan. Songs found later raise the matched count, a late failure no longer resets the counts, and an open import page updates as songs are found or dismissed. An import whose download ran out of sources finishes at once instead of waiting out its 10-minute timeout.
  • An import that timed out or was cleaned up as stale shows as failed on its open import page instead of spinning, sends an "import failed" notification and stops its downloads, in Kima and in Lidarr. One that had already finished keeps its result.
  • Cancelling an import, or an import failing, stops its downloads in Lidarr too and takes them off its queue, unless another download of yours still needs the same album (even one Lidarr hasn't picked up yet). One Lidarr error no longer leaves the rest running, and a stopped import starts no new downloads from searches already under way.
  • Cancelling an import at the moment it finishes no longer throws away the finished import, and an import you stop, or one that fails, starts no more downloads, even while a search for it is already under way.
  • A cancelled import no longer lingers in your imports list when its cleanup stopped part-way; Kima finishes the cleanup within about 10 minutes.
  • An import that can't be set up fails straight away with the reason on the import page, instead of waiting on a job that never starts.
  • An import whose library scan never finishes fails 30 minutes after the scan first began, however often the scan is asked for again, instead of waiting on indefinitely.
  • Playlist import finds the right songs. All of an artist's songs are looked at, not only the first 50, and a song or artist you renamed is found by the name you gave it. A line no longer imports a longer title that only contains its words ("Love" no longer brings in "Love Me Do") or a longer-named artist's song, while a featured artist or a remaster note still matches. Edition notes like "- Remastered 2011" are cut from titles when matching, but a title such as "- Live and Let Die" or "Song - Stereotype" is kept whole. Credits joined with "&", "/" or brackets match by their names.
  • M3U files are read the way music players read them. Encoded, file:// and relative paths, backslashes, differences in capital letters, and files saved by a Mac or in an older encoding all find the song, and a song at the top of your music folder is found by its file name. A line that matches only by file name must agree on both artist and title when it gives both, a path that fits more than one song equally well is skipped (the song whose folders agree most wins, as in Navidrome), and a file that matches nothing makes no empty playlist. Long files import faster, and the upload form says in plain words when a file is too large, isn't a playlist, isn't text, has too many songs, or sends its name twice.
  • A song removed while it is being added to a playlist is reported as not added, instead of an error.
  • A cancelled playlist import stays cancelled when its downloads finish later, and songs an import matched by title or ISRC no longer show as both found and still waiting.
  • Retrying a waiting playlist song says why it failed: Soulseek has no files for it, or Soulseek is not answering. Retry all says which songs Soulseek had no files for, or that Soulseek is not answering.
  • A playlist import that hits an error after it was cancelled, finished or already reported failed keeps that state and sends no second notice, and an import finished elsewhere no longer starts a library scan. An import whose library scan could not be queued goes back to waiting and tries again.

Subsonic apps

  • getAlbumList2 answers correctly however an app capitalises it. So do search3, getSimilarSongs2, getIndexes, getStarred2 and getArtistInfo2, and a call ending in .VIEW in capitals is answered instead of called not implemented.
  • Subsonic apps can no longer reach a song that does not play. Streaming, downloading, looking up, bookmarking or adding to a playlist a Discover suggestion, a missing song or one that could not be read answers "not found"; starring or rating one is skipped; lyrics, bookmarks and the now-playing list leave them out; and a scrobble of one is not counted. A song that can't be read answers a clean error, and an empty file answers "not found".
  • Subsonic playlists and the saved queue show only songs that play. Such songs are left out of a playlist's songs, count and length, and out of the queue an app resumes, which then resumes at the next song. They stay in the playlist and come back when their file does, and an app saving the playlist keeps them.
  • Genres follow your library. A song shows its own genre tags, most-voted first, falling back to its album's genres; filtering songs by genre and the genre list's song counts use those tags. Albums show the album's own genres, falling back to the artist's, and album lists by genre are unchanged. Genre filters match exactly ("rock" no longer lists "punk rock"; Kima radio and stations keep their broader match), the OpenSubsonic genre list holds every genre shown, genre counts match the songs you can play, and songs in playlists and shares show their genre.
  • Years, genres and pictures you set reach Subsonic apps. An album shows your year edit first, then the original release year, in album lists, year filters, random songs and sorting. Year and genre edits or resets, and those filled in by identification or enrichment, show once the edit or enrichment finishes, and an artist's genre edit or reset is picked up. An artist picture you set shows in artist lists, the artist page, search, artist info and cover art, and an emptied picture of your own falls back to the found one. Setting, clearing or resetting a picture or cover, or Kima finding a new one, makes apps fetch their lists again, and an image address is sent only when it is a real web address, podcasts included.
  • Subsonic apps see changes when they happen. Apps pick up changes made just before a restart, deletions, albums moved between Discover and your library, and an artist re-run that removes shown genres; scans that only touch Discover no longer make them refresh. On a server not set to UTC the library change time is no longer hours off. Playlists carry when they were made and last changed, and adding, removing or replacing songs moves the change time.
  • Search follows the names you see. Searching on the web and in Subsonic apps finds songs, albums and artists by the title or name you gave them as well as the one in the file, and accented letters find the right songs. Results list albums and artists in the order of the names shown, album results carry their added date, song count and length, search3 artists carry their edited name and album count, and older clients using search2 or search get answers as the Subsonic spec describes. Paging no longer repeats rows, and genre and starred lists keep a stable order when items tie.
  • Lyrics, imports and artist lists use the names you see. Lyrics and playlist imports find songs by the title you gave them and come from the matching song that has lyrics, accented titles match, artist album counts agree across every artist list and count only albums with a song that plays, artists with none are left out, and artist indexes file accented names under their letter.
  • Subsonic apps see each song's real bitrate, and lossless files (ALAC, WAV, AIFF, WavPack, Monkey's Audio and others) no longer show 192 or 256 kbps. Choosing the best copy of a song, and deciding whether to stream the original or transcode, use it too.
  • Subsonic requests behave as apps expect. A parameter repeated that the protocol sends once (a second id on getSong, getAlbum, getLyrics and the rest) answers for the first value. Apps see when an album was added. A playlist update with an empty name no longer blanks the name, and a garbled or repeated song position no longer removes the wrong song. A scrobble dated in the future, or with a time that can't be read, counts as played now, and several scrobbles sent at once are each counted.
  • Subsonic shares keep their expiry and say what they hold. A share made with an expiry now lapses when it should, and one too large to be a date is refused. The app is told when the share was made, when it expires, how often it was opened and which songs it holds. A link you already had keeps its expiry.
  • Older Subsonic apps see albums as folders in the original album list, as the protocol has it, and the saved play queue shows an album title you edited.

Sharing

  • Share links offer only songs that play. A share can't be made for a Discover suggestion, a song whose file is missing or unreadable, or an album with none of its songs playing. A share to such a song answers as deleted, and an album or playlist share lists and plays only the songs that play.
  • A share link shows only its own covers. Any valid share link could fetch any cover stored in Kima; now it serves only the covers of what it shares. A shared playlist with many songs opens without its covers counting against the limit for opening shared links.
  • A share's visit count counts each time the share is opened. Subsonic apps show it as the share's visit count; playing or seeking a shared song doesn't change it.
  • A shared link that won't open says why. Not found, expired and too many tries each get their own message, leaving a shared page stops its music, and a song that stops playing says the real reason. Shared audio is not kept by the browser, and a file that fails partway ends the stream instead of leaving the listener hanging.
  • A shared link shows its cover when pasted into a chat app, and chat apps see whether it is a song, album or playlist.

Discover

  • Discover counts only albums in your library as already owned. An album that is itself in Discover no longer stops Discover suggesting it, a liked suggestion plays from your library copy, and deleting, pruning or clearing an album updates the check at once.
  • Discover tells apart artists who share a name. Recommendations, songs, downloads and tiers of a different artist with the same name no longer show on your Discover cards or hide a suggestion as owned. Cleanup, like and unlike, holding albums for a running batch and checking the library before deleting files match the artist and album by MusicBrainz id, and by name only when an id is missing. In Lidarr, keeping an album takes Discover's tag off only the artist that owns it, liking finds the right artist even without a stored Lidarr id and keeps the album even if Lidarr can't be reached, and a same-name artist no longer stops Discover clearing one it added. A namesake no longer marks a suggestion as turned up, blocks a library album being identified by sound, or hides an orphaned Discover album from the daily report.
  • Discover's current list finds songs spelt differently. A suggestion's song is found when its artist or title differs only in accents, case or apostrophes, or when the MusicBrainz artist is the same under another name. Liking, unliking, a scan or an artist id correction shows up in Discover's picks at once.
  • Discover's week shows only songs that play. A song whose file is missing or unreadable no longer shows; the album's next playable song stands in, and two suggestions with the same album title no longer hide each other's song.
  • Clearing Discover deletes its albums again. When Lidarr saved a Discover download without MusicBrainz tags, or under a name with accents or marks the files' names lacked, the clear only stopped monitoring it, so it stayed in Discover and on disk. Kima now recognises Discover's albums by the Lidarr record it made. An earlier clear could take Discover's tag off those artists in Lidarr; Kima puts it back on any artist whose albums with files are all Discover's and that no listener has made theirs or is downloading from. An album the clear keeps says why.
  • A long Discover clear no longer reports a failure it didn't have. The page waits for the clear to finish instead of giving up after 30 seconds. "failed to clear playlist" now shows only when the clear itself failed, with the reason. When the connection drops or a proxy stops waiting first, the tray says there was no answer yet and to refresh to see what the clear did.
  • Clearing Discover no longer waits for Lidarr to remove Discover's artists. Kima removes them one at a time after the clear answers. With many artists this used to take minutes, so the page could show a failure for a clear that worked. If Lidarr refuses an artist or cannot be reached, admins get one tray row naming each artist and Lidarr's reason, and the next clear tries again.
  • A Discover week whose downloads have all finished no longer waits up to two hours to move on. If Kima's check after the last download failed once, the week sat at "downloading" until it timed out; the regular check now picks it up within minutes. A stuck playlist import is checked the same way, never alongside a check already running.
  • An album a clear could not delete stays on the Discover page. It used to vanish once a new week began, while it was still in Discover and on disk. It now shows with the week's suggestions until a clear removes it, or moves it to your library if you liked it. When Discover suggests it again it shows once, and liking or unliking it covers every week it was suggested in.
  • Discover's Lidarr artist clean-ups report a Lidarr they cannot read. The admin "clean up Lidarr" request and the artist clean-up at the end of each Discover week took a Lidarr that did not answer for one with no Discover artists, so nothing was removed and nothing said why. Both now put the reason in every admin's notification tray, and a dry run answers with the error instead of an empty list. A real clean-up now starts in the background and answers at once instead of timing out on a large Lidarr; what it removed or could not remove shows in the tray.
  • Clearing Discover deletes the albums it fetched instead of keeping them. An album Discover fetched is deleted even when Lidarr's artist has lost Discover's tag or Lidarr cannot read the tag, since deleting one album never removes its artist. When Lidarr leaves out an album's file count, Kima asks Lidarr for the album's files instead of keeping the artist. When Lidarr no longer has an album and Kima never scanned it, the clear forgets it instead of reporting it every week; if Lidarr has added the album again under a new id, the clear deletes that one. Discover also forgets its downloads of an artist it removes from Lidarr. Files Lidarr no longer tracks stay on disk and appear in your library at the next scan.
  • A Discover clear that was cut off finishes at the next clear. An album a clear had started on when Kima stopped is deleted the next time Discover is cleared, instead of staying in Lidarr with nothing to clear it.
  • One Discover clear at a time. A second clear while yours is running is refused with "a clear of your discover is already running", the weekly refresh waits for a running clear instead of failing, and unliking an album while a clear runs asks you to try again once it is done. A clear that fails says whether Kima could not reach Redis or hit a server error.
  • A clear says why it kept an album. An album Soulseek fetched that Kima has not scanned yet is kept until the next scan, and the next clear deletes it. You're told when an album's download record has no artist name, so Kima can't rule out that it is a listener's own copy and leaves it in Lidarr. A clear also deletes the song records of every week an album was suggested in.
  • Discover shows an album you liked as liked when an earlier week's suggestion of it is liked and a later week suggested it again.
  • An unavailable album no longer stays listed after an earlier week's suggestion brought it in. Retrying unavailable albums skips it too.
  • Discover settings keep a slider change made just before you leave. Going back to activity or to another page within half a second of moving a slider saves it, and moving a second slider straight after the first keeps both changes.
  • A Discover week whose downloads found no songs ends cleanly. The page stops waiting on it, and Discover's unused artists are still removed from Lidarr.
  • An artist removed from Lidarr stays removed. When Discover's clean-up, or deleting an artist in Kima, removed an artist while Lidarr was still refreshing it, Lidarr added the artist back and Kima reported it removed anyway. Kima now waits for Lidarr's refresh of that artist to finish before deleting it, and counts the artist removed only once Lidarr no longer has it. If Lidarr is still refreshing it after two minutes, the artist is left in place and the reason is reported; the next clean-up tries again. Deleting an artist in Kima while Lidarr can't be reached now says Lidarr wasn't reached, instead of saying the artist wasn't in Lidarr.
  • Discover starts from the artists you play most, and no longer suggests an album you kept when its record is gone but a past suggestion still names it.
  • Discover Weekly says generation is temporarily unavailable when it cannot start, whether Redis is unreachable or its lock was lost, instead of wrongly saying it is already in progress. The weekly job is still queued while Redis is down, library enrichment pauses until Redis is back, a week whose playlist failed can be made again without ending up with none, and a retry that hits an error while starting is marked failed so you can retry it.

Downloads and Soulseek

  • A Soulseek download no longer fails when the peer's connection splits the start of the transfer, and an empty file finishes instead of hanging. Large files no longer fill memory when the disk is slower than the peer, and a peer that sends extra bytes or cuts a transfer short no longer crashes or stalls the download. A transfer that fails because the peer's connection reset says so and puts that peer on cooldown, and a peer that offers a file again after a failed start is accepted instead of ignored. A peer refusing a download the moment it starts no longer crashes the server. A download counts as done only once the whole file is on disk, and a local disk problem no longer puts the peer on cooldown.
  • A Soulseek download that fails or is interrupted leaves no partial file and never removes a good copy already there. A full or read-only disk stops an album download at once instead of trying peer after peer, and two songs on one album with the same title both download, the second saved as "(2)".
  • Downloads end the same way wherever they're stopped. A manual Soulseek download puts a "download complete" or "download failed" row in the notification tray. Cancelling a Discover batch stops its downloads already running, cancelling a Discover download no longer marks its album unavailable or counts toward "all downloads failed", and a batch of only cancelled downloads ends as cancelled. A stale download, or clearing and deleting downloads, lets a waiting batch finish, and an empty failure reason still fails the job.
  • Retrying a download is safe. A failed download stays in the list until its replacement exists, and a replacement that cannot start shows as failed. Retrying twice, or retrying one already downloading, makes one copy, a retry keeps its attempt count and its place in a Discover batch, and a retried Spotify download looks for its files before it is marked done. Retrying a song from activity or a playlist says why it couldn't start (Soulseek unavailable, or no file found). Asking for the same download twice while the first is being set up returns that download.
  • A release radar download that can't start shows as failed and tells you, and one that already finished is no longer marked failed afterwards.
  • Clearing downloads leaves running ones alone. A running download can't be dismissed and "clear all" removes only finished and failed ones. A Lidarr outage no longer stops you clearing downloads, retrying an album whose download you dismissed works, clearing or retrying one already gone says so, and a status a download can't have answers an error.
  • Downloads Lidarr is working on are tracked properly. A Discover download is matched as soon as Lidarr grabs and imports it. A download Lidarr parks tells you once, and Discover and playlist-import downloads post no "waiting in Lidarr" notice. A download held while Lidarr is down resumes once when it comes back, removing an album stops its waiting downloads too, and an album already downloading for someone else no longer stops your own Discover week fetching it.
  • Soulseek reconnects cleanly. Searches and downloads made while it reconnects say "soulseek is reconnecting, try again in Ns" at once, a dropped connection closing late no longer cuts off the new one, a connection that fails says why, and while Redis is down the connection fails at once with the reason instead of after 30 seconds.
  • Clearing downloads while Discover or an import is still checking them no longer makes the check miss them or finish early.
  • Downloads left from older versions with the old "exhausted" status show as failed in download history.
  • Two Lidarr releases failing at the same moment can no longer both use a download's last retry.

Sign-in and accounts

  • A two-factor or recovery code works once. A code that has signed you in, turned two-factor off or made new recovery codes is refused if sent again, and after signing in with a code, turning two-factor off waits for the next one. Two sign-ins sending the same recovery code at once can't both get in, while two different recovery codes used at once both work. A code is used up only if the change it allows goes through, and a change that cannot finish because the account or server is busy says to try again.
  • Two-factor holds together. Turning it on while it is on is refused, turning it off resets it fully, and an account whose two-factor secret the server can no longer read is refused at sign-in with a clear message, keeping the secret until the encryption key is restored. Before, an account with two-factor on but no stored secret signed in without a code. Sign-in recognises two-factor prompts and wrong codes from a code the server sends, not from its wording, and a code sent as anything but text is refused.
  • Wrong-password limits count per account. Wrong guesses at one account no longer lock another whose name differs only by spaces, a right password followed by a refused two-factor step does not count as a wrong guess, and a right password gives back only its own try.
  • A newly created account stays signed in. Creating an account hands the app the same long-lived sign-in that logging in does, so the web and the iOS app renew the session on their own.
  • A server restart no longer signs you out of the web app. A busy or restarting server leaves your session alone, and signing in as someone else no longer leaves the earlier account's session behind.
  • Account sign-up and admin password reset answer plainly. A closed sign-up creates nothing, a sign-up that races another for the same name or for the first account gets a plain answer, and two password changes at the same moment can't both succeed. An ADMIN_RESET_PASSWORD shorter than 6 characters logs an error and leaves the admin password as it was.
  • The last admin account can't be deleted, even when two admins delete each other at the same moment, and deleting an account that is already gone answers not found.
  • Linking a device answers plainly. A wrong, used or expired code always gets "invalid or expired code", making a new code tells an app still waiting on the old one at once that it is gone, and two codes made at the same moment no longer cause a server error.
  • Changing a password in settings and creating a user apply the 72-character limit with the same message as sign-up. The create-user form and change password show what is wrong with a new password under the field as you type.

Stats, mixes and radio

  • Every count of your plays counts listens. Repeats and skips of a song fold into one listen everywhere a count is shown or used: the stats page, mixes, the artist page and Subsonic lists, so some numbers may shift slightly. Plays kept from a song that left the library count toward a song with the same recording, or the same title, artist and album, when one is in your library. What you listen to shapes Discover, recommendations and the similar-artists mix even when a song's file has since gone missing, and plays kept from a song that left count toward the artist of the same name there. A kept play finds its song despite differences in letter case, accents or punctuation (Chinese, Japanese and full-width marks included), or under a title you edited, ahead of a better copy with the old title; a compilation's kept plays go only to a Various Artists album, and two artists whose names are in another script no longer share plays.
  • The stats page opens fast with a long history. With 100,000 plays it opens in about a second instead of ten, very large histories no longer fail to load, and the hour and region details open faster.
  • The check for plays that never really started leaves out Discover plays. It no longer lists, merges, removes or ignores plays of Discover songs, though a Discover song started right after a library song still shows that the library song was skipped. Long histories are read in pages, and merging or removing waits for plays being recorded.
  • The stats page and the web library count only songs that play. The shelf, never played, decade, top and key lists, the library sound your listening signature is compared with, the song list, shuffle, an artist's albums and popular songs, and recommended artists leave out Discover suggestions and missing or unreadable songs. The analysis progress bar still counts every library song.
  • Mood mixes remember what they served, per mood. Saving a mix for one mood no longer makes another forget, two requests at the same moment never give the same songs, and a saved mix drops songs no longer in the library (a replaced file's copy takes their place). Moods and stations no longer move a borderline song in or out from one run to the next, and clearing the mix caches no longer starts two checks of what you already know at once.
  • Genre and decade stations count only songs that play. A genre or decade shows in the radio row only when enough of its songs play, and the familiar songs your mixes lean towards and the minor-key mix leave out songs that can't play. Random mixes and stations stay fast as the library grows.
  • Songs that could not be read stay out of the vibe map and text search, the public vibe site and the sound of an artist used for similar artists. The progress counts for the map and moods count only songs that play.
  • A song path needs two songs that play. A start or end song that is missing, unreadable or in Discover is refused as not found.
  • Recommended artists fill the list. Artists you already own no longer leave it short, the closest matches across all your top artists come first, and an artist you play most is never recommended back to you. For-you recommendations take a limit between 1 and 50 (10 by default).
  • Vibe lookups refuse songs that don't play. Mood and similar-song lookups answer not found for a Discover, missing or unreadable song and bad request for a malformed id, a song path with a length that is not a number is refused, and the public vibe site shows covers only for songs that play.
  • Genre search and genre stations go by a song's own genres first. A song tagged with genres is found by its own tags, and one without is found by its album's. A genre still finds the genres that contain it, so hip hop also finds alternative hip hop.
  • Artist radio for an artist with nothing that plays still starts, with songs by similar artists.

Covers

  • A changed cover shows up without clearing the cache. The web app and Subsonic apps get the new one; a cover cached by an earlier version can take until that copy expires. Covers load from the cache again, an audiobook's cover is downloaded again only when it changes, Subsonic apps get covers at the size they ask for and outside covers from a short memory, and a cover file that has gone missing answers not-found.
  • Covers are saved whole, in one format. Downloaded pictures, audiobook covers and cover art read from music files are saved whole or not at all as JPEG, a file that is not a picture is no longer kept, pictures over 20 MB are refused, and half-written files left by a crash are cleaned up. Covers and artist pictures saved by older versions in other formats are converted once, in the background. A picture is turned the right way up and transparent areas become white instead of black. A cover that failed to download is remembered instead of fetched again each time, and leftover smaller copies of removed covers are cleaned up.
  • A cover you set is never overwritten by a background job. Finding album covers, the image backfill and cover repair leave alone a picture you set while they ran, and the image backfill no longer replaces a picture set while it was downloading or leaves half-written files.
  • Covers sent as image/jpg, image/pjpeg or image/x-png are accepted as JPEG or PNG.
  • Cover downloads are safer. A downloaded cover is kept only when it is a plain image type, an Audiobookshelf cover that stalls gives up after ten seconds, cover repair skips an oversized stored file and finds an artist picture whose address already has a version, and removing a book Audiobookshelf no longer lists removes its cached cover.

Enrichment

  • Stopping enrichment holds. Stopping it while a run is in progress keeps it stopped until you start it again, and analyzer reports that name no job are ignored rather than settling songs they weren't about. A fault while pausing, resuming or stopping is reported as a server error, not a bad request.
  • Enrichment keeps going when a similarity step fails. The failure is logged and the run goes on, sound analysis is no longer offered while sound vectors are off, and stopping the server waits up to 30 seconds for the run in progress, with a log naming the step still running.
  • Song analysis status shows as soon as it starts. An analysis or sound-vector job shows as processing the moment it is handed out, a fast report is no longer overwritten by a late status write, and re-deciding everything puts the sound-vector status back to pending.
  • Re-running enrichment no longer overwrites a year or genres you set while it ran.
  • Enrichment failures are counted right. Two failures at once no longer miscount, the 24-hour alert waits for the song to be set aside, the failures list refuses a type that does not exist, and podcast failures show.
  • Pressing run enrichment while it is stopped finishes every step.
  • Retry failed gives every failed song a fresh set of tries.

Settings, server and podcasts

  • A settings change is seen at once by everything that reads settings right after it is saved. Saving no longer waits for Soulseek to reconnect, two saves at the same moment no longer undo each other, and every save while Audiobookshelf is off clears its stored listening progress, telling you in the notification tray if that fails.
  • Setup's Soulseek step switches Soulseek on and off.
  • An admin notice about an unreadable credential arrives exactly once. A notice that failed to send is tried again, a field's notices arrive in order so an old one can't outlive the one that clears it, two Kima processes send one notice, not two, and opening the settings page no longer waits for notices.
  • A repeated notification shows once, with the latest event. A repeat is recognised by its details, however they were stored, and its details and link come from the newest event.
  • Badly formed requests get a plain "invalid request". The reason goes to the server log instead of the reply. This covers an album year outside 1000–9999, a track number outside 1–9999, values with trailing text or fractions, a blank stats hour, an empty podcast genre or chart category, a device name that is not text, the web song list given one album twice, and malformed sign-in and two-factor requests. A device's name is trimmed and cut to 100 characters however it is linked.
  • The metadata editor saves only what you changed. Editing a title no longer locks in the album's cover, genres and year, saving with nothing changed just closes it, and clearing a title, name, picture or bio removes your edit. A picture or cover address must be a full http or https address. Changing an album's or artist's MusicBrainz id is saved together with the rest of the edit or not at all, the album editor shows the id, and a saved edit no longer shows an error when a follow-up library update fails.
  • Song search on the web keeps one set of results. A genre filter fills each page from that genre's songs, and a page past the last match stays empty.
  • Request limits count fairly. Audiobook listening and album cover searches no longer count against the per-address limit, addresses that only look like the cover routes are counted like any other, a refused stream still counts, a client stuck in a loop can no longer hammer the metrics page, and a full-length audio segment fits the large upload limit.
  • Shutdown is orderly. If a step of stopping the server fails, the rest still run and it exits with an error, and nothing new starts once it is stopping. Image backfills, artist recounts, album re-filing and audiobook syncs finish their current step first; a re-file cut short tells you to run it again, and starting one while it runs joins it. Long background tasks stop instead of carrying on twice when Redis restarts. Creating a share or deleting an account during another change answers "try again".
  • Audiobook syncs and image backfills are safer. A sync that could read only part of Audiobookshelf, or where any book failed, no longer removes books it missed, and one unreadable library no longer stops the others. An image backfill is not started twice, shows one count for the whole run, and logs a stopped run as stopped.
  • A podcast episode whose audio address changes is downloaded again instead of playing the old cached copy, also when the change arrives while the episode is downloading, and a download that fails to save leaves no stray audio file.
  • A podcast episode plays and keeps its place only under its own show, and a podcast whose refresh couldn't be queued is tried on the next cycle instead of an hour later.
  • New all-in-one installs store text as UTF-8, so names in any script sort and match correctly. Existing installs keep their database as it is.
  • LOG_LEVEL works in any case. DEBUG, debug and Debug mean the same level, and a value Kima doesn't know logs at the default level with a warning, instead of silencing every log line.
  • The split image no longer logs a Redis error at every start.
  • The playlists page, the podcast episodes header and the button labels on episode and album song lists are lowercase like the rest of the app.
  • A podcast refresh that finishes while the queue fails keeps its time, and a podcast category id that is not a whole number is refused.
  • Podcast episodes you already have pick up the show's later edits to title, notes, audio link, length, size and date on refresh, and keep your progress. A field the feed leaves out keeps its stored value, a downloaded episode keeps its measured length, and an episode listed twice in a feed counts once. A refresh that fails partway reads the whole feed again next time, so new episodes are no longer missed, and an episode with an unreadable date no longer stops the refresh.

Quick start

docker run -d \
  --name kima \
  -p 3030:3030 \
  -v /path/to/your/music:/music \
  -v kima_data:/data \
  chevron7locked/kima:v1.13.0

Then open http://localhost:3030 and create your account. See the README for full documentation.

Full Changelog: v1.12.4...v1.13.0

Don't miss a new kima-hub release

NewReleases is sending notifications on new releases.