All versions since 0.19.1
0.19.1
Changelog
⛰️ Features
- (musicbrainz) Disallow audiobook and music videos with config options #734
🐛 Bug Fixes
- (transform) Add missing musicbrainz default transform #737
0.19.2
Changelog
🐛 Bug Fixes
- (transform) Don’t try to initialize transformers that are already initializing, reduces noisy logging on startup
- (transform) Fix async transform initialization race condition and type/name key case sensitivity #739
v0.20.0
What’s New?
Play Editing and Search
Plays can now (finally) be edited! If your scrobbles fail you can now edit the data to correct it manually before resending it.
A plain text mode is initially used where you can edit everything related to fields and metadata ids
Additionally a search mode is available to search all of the metadata providers you have setup. Musicbrainz, Spotify, and Rocksky can all be searched concurrently. Selecting a result fills in that field, any associated fields (track can set artists + album), and meta ids.
Musicbrainz and Rocksky providers are automatically setup. All providers automatically inherit from your existing transformers. You can also set up preferred providers to only use some of them, or use with alternative configuration.
See the docs for more information.
Tuneshine Client
Tuneshine, a wifi-connected hardware device with an aesthetic, low-count LED display for showcasing the album art of the music you are currently listening to, is now integrated as a Scrobble Client.
Like Discord, it can be used to display Now Playing activity from any of your Sources.
Mixcloud Source
Mixcloud is now integrated as a Scrobble Source thanks to @anandghegde
This source records the mixes you listen to as scrobbles. It supports both free and Pro Mixcloud accounts.
Metadata Overhaul
Previously, metadata like track identifiers from Spotify/Musicbrainz/etc… and album art, were stored alongside a Play but they were not strongly associated with specific parts of the Play. This lead to situations where some functionality would require assertions like “Artist 1 has metadata artist ID 1” but it was not possible to guarantee this.
Now, Play data has been restructured to tightly associate all of this metadata to the field it belongs to. This change does not affect any end-user functionality but it dramatically simplifies developer experience. The Play Editing functionality above would have been much more difficult without this change, for example.
Changelog Highlights
⛰️ Features
- (endpointlz) Allow disabling artist extraction from ingress payload #750 #751
- (deezer) Add ISRC and optional title variant to parsed data #752 #754
- (koito) Add includePlayPosition to koito scrobbler implementation #741 #742
- (spotify) Periodically backfill songs from spotify history api for missed live playback state #735 thanks to @sudbrack
- (No Category) Consolidate SSE for logs into events to reduce connection pool usage for HTTP/1.1
- (No Category) Consolidate global SSE connections with coordinator
🐛 Bug Fixes
- (docs) Resource static asset link broken by trailingSlash #573
- (listenbrainz) Only use original artist_name in naive play if no artists credits were extracted #750
- (stats) Persist lifetime discovered/scrobbled counts across restarts #745 @dylangovender
- (No Category) Improve detection of repeat plays when listen range is close to end of a position player
📚 Documentation
- (discord) Update kasmweb/discord service example
- (metadata) Add editing and metadata search
- (No Category) Add reverse proxy recommendation and tips
🚜 Refactor
- (No Category) Decouple transform manager init
- (No Category) Circular dependency elimination
⚙️ Miscellaneous Tasks
- (No Category) Add docs and devcontainer modifications to ease discord IPC development with kasmcord
v0.20.1
This release bumps the Nodejs version used in the docker image to 24.22.1 in order to include the october security release fixes in the distributed docker image.
You should upgrade as soon as possible in any case, but users who run MS in a way that exposes it to the public internet (API or UI accessible from a non-authenticated URL) are particularly vulnerable as this fixes an exploit for remote code execution. Do not delay upgrading if you are in this scenario.
v0.20.2
This is another security fix that removes compromised eMudhra certificates from the base docker image. #759
v0.20.3
What’s New?
Docs Moved to Starlight
Documentation has been migrated from Docusaurus to Astro ✨Starlight✨
Docusaurus has been great but Starlight, and Astro being a general static site build system, is more flexible and lighter. Along with the already-strong community plugin support it has enabled more functionality for the MS docs that was not possible with Docusaurus.
The docs now have a fresh look with clearer/more readable styling. Particularly awesome new features:
- Code blocks get walkthroughs, footnotes, inline linking, stylized focus, dynamic placeholders, and much more thanks to starlight-codeblocks
- Changelogs are now built into the public site
Additionally, the developer experience for docs is greatly simplified. Same build commands but many things, like og image generation and open api doc generation, are all built-in now.
Improved Shutdown Behavior
MS now handles all exit signals (SIGNIT and SIGTERM) instead of just SIGINT. On exit signal it now tries to gracefully stop all Source/Clients by letting all currently processing Plays/scrobbles finish before closing the database and shutting down.
v0.21.0
What’s New?
This is a huge release that hardens Multi-Scrobbler deployments so that you can use it in a public environment.
Included in this release:
- A new, hardened Docker Image
- Single-User Authentication
- Public Dashboard :eyes:
- Improved Service ID UI
Hardened Docker Image
Alongside the Authentication introduced below, MS now uses a rebuilt-from-scratch, hardened, distroless docker image.
This image entirely removes root and shell functionality, includes only necessary dependencies to run MS (basically no OS), and defaults to running the container as a non-privileged user. These changes make it much harder for a malicious actor to compromise the container, use any kind of exploits, and gain a privileged foothold in your host system.
- The drawback of this change is that there are breaking changes for your compose stack related to container and file/folder ownership.
- The good news is that these changes are relatively straightforward and for the majority of users should be only a few changed lines in their compose file.
Single-User Authentication
I have planned features that will allow more modification of MS and downstream scrobble data. However MS (until now) still did not have any kind of authentication which puts users in a hard position of exposing their instance to malicious actors or potentially losing connectivity to some Sources. This would have been made worse by the planned features. So the time has come…
Multi-Scrobbler now supports single-user authentication using Better-Auth :tada:
Upgrading and Initial Setup
I have gone to great lengths to make sure upgrading is painless.
When you upgrade, before even setting up auth, your MS instance will continue to work exactly as it does today for backend, Sources, Clients, polling, etc…the only thing that changes is how the web dashboard is initially accessed.
Additionally, nothing changes for your Ingress Sources, like Listenbrainz Endpoint, even after setting up auth. Any external clients that use these Sources will continue to work as-is.
Use the 0.21.0 Upgrade Guide in the docs for upgrading/setting up Auth.
Api Keys
Since your instance’s API will now be authenticated, you can now use API Keys found in Settings -> Account to generate keys for use with external services (Prometheus, other apps that want to consume MS apis).
Users with Existing Auth Solutions
If you have already secured MS with your own auth like a reverse proxy + authelia/authentik/keycloak etc.. and are happy with that there is an escape hatch for you:
To disable all auth and have MS behave (almost) exactly as it does pre 0.21.0, use Bring Your Own Auth (BYOA) mode by setting the ENV AUTH_MODE=disabled. This is also covered in the upgrade guide.
Data Directory Usage
Standardized application directories for storing config, data, and log files separately were introduced in 0.15.0. However, many of the cache/auth flow files used by MS are still stored in the config directory.
In 0.21.0, MS now looks for these files in the data directory.
Public Dashboard
As a carrot :carrot: to entice you to (please!) upgrade, this release also include a Public Dashboard that unauthenticated users can view when visiting your secured instance.
This is a strictly opt-in feature and you control what (privacy-restricted) data is shown and how often it is shown. Find this feature’s setting in the logged-in dashboard in the menu Settings -> Publish Dashboard.
Some highlights:
- Animated stats for total number of Plays, Scrobbles, and minutes listened
- Animated stats/icons for number of Sources/Clients and what types you are running
- A configurable Recent Scrobbles lists, optionally with a Now Playing card
- An embeddable/iframe page so you can show off your activity and stats on your blog!
Service ID Indicator Improvements
Service ID/Icons got a glowup with a new, animated stacking style, merged icons when multiple of the same id exist (like Musicbrainz release and release-group), and a popup to make ids/links acessible to screen readers, keyboards, and mobile touch navigation.
Other Changelog Highlights
🐛 Bug Fixes
- (spotify) fixed regression that dropped
localeparam in search requests #768 thanks @DigitalStarSys - (listenbrainz) fixed incorrectly parsing forward slashes in artist names #760
📚 Documentation
- Added new Security section for authentication guidance
- Reworked usage of Base URL everywhere so it uses placeholders
⚙️ CI/CD
- Rewrote Github Actions to remove reliance on
pull_request_target- Publishing PRs from external contributors now requires an explicit comment with commit SHA each time it should be built
- Moved testing workflow into a docker image build step to improve security and leverage already built layers
v0.21.1 Latest
What’s New?
Blackbox Client
A new Client, Blackbox, is available that can be used as a glorified “webhook” for scrobble/now playing activity from MS.
This client can be configured to POST a json payload (scrobble and/or now playing) to any URL you give it. It can optionally be configured with headers for authentication.
The payload can be either a Full MS Play object which contains a ton of information, or a normal Listenbrainz submit-listens payload.
This client is generally useful to feed your own app, script, or home automation with listening activity from any of your Sources.
Date Time Formatting on Dashboard
MS now defaults to using the date/time format associated with your browser’s locale instead of hardcoding it.
Additionally, you can now also explicitly set preferences for these in the MS dashboard under Setting -> Appearance
More Security Hardening and Dependency Updates
Select dependencies have been updated to fix long-standing vulnerabilities due to these dependencies/packages being mostly unmaintained (but still used by MS like for chromecast).
Additionally, dependencies made it into the 0.21.0 production image that were not used. These are now manually removed when building the image.
The result is a ~25MB drop in image size and 90% reduction in vulnerabilities reported by dockerhub image scanning.
Changelog Highlights
🐛 Bug Fixes
- (lastfm) Parse artists with an mbid present as one artist (don’t parse by delimiter)
- (listenbrainz) Prevent
duration_played: 0#781 - (tests) Prevent test artists generator from duplicating artists
- (tests) Fix client config tests accidentally clearing non-test related ENVs during the run
- (No Category) fix LOGS_DIR being ignored
⛰️ Features
- (ui) Date and time formatting preferences
- (No Category) Implement blackbox scrobble client
⚙️ Miscellaneous Tasks
- (deps) Upgrade drizzle-orm and drizzle-kit to 1.0.0-rc.5, remove unnecessary drizzle-kit prod dependency
- (No Category) Update dockerfile base image pinned versions
- (No Category) Regenerate lockfile with newer npm to get correct libc deps
- (No Category) Force bump protobufjs to fix vulnerabilities with castv2
- (No Category) Migrate eslint to oxlint
📚 Documentation
- (No Category) Spruce up source/client list on landing page
- (No Category) Blackbox docs
🧑🍳 Continuous Integration
- (No Category) Update tests to run in parallel
🧪 Testing
- (No Category) Ensure a client with upstreamRefresh disabled still detects dupes from in-house plays
- (No Category) Allow longer timeout for drizzle tests on less powerful machines
- (No Category) Setup chai-as-promised globally
- (No Category) More robust tmp dir usage for tests