Compare commits

...
344 Commits
Author SHA1 Message Date
FoxxMD 22cf95e58c feat(listenbrainz): Use upstream for backlogged 2026-03-25 01:37:54 +00:00
FoxxMD 358355c612 refactor: Move stagger config responsibility to transformer 2026-03-25 00:41:10 +00:00
FoxxMD c5f9600047 docs: Add duplicate scrobble detection explanation 2026-03-24 23:54:55 +00:00
FoxxMD 0dfa4c7aad fix(test): Fix expected plays for YTM interim plays 2026-03-24 20:23:47 +00:00
FoxxMD 68e473ec02 fix: Add stagger options as injected dependency to make tests faster 2026-03-24 20:21:14 +00:00
FoxxMD a8d20734aa fix: Fix wrong operation for maxRandomStagger 2026-03-24 20:20:37 +00:00
FoxxMD ebdb76cf6c fix: Fix type-erased meta property for json plays 2026-03-24 20:19:27 +00:00
FoxxMD e62e1ac2dd feat: Add seenAt to source/client play meta 2026-03-24 19:38:05 +00:00
FoxxMD e68b46f647 feat(ui): Implement play activity sortby seen/played 2026-03-24 19:15:54 +00:00
FoxxMD 7605cd3f1d virtualization is messy and plain accordian works better 2026-03-24 18:56:07 +00:00
FoxxMD 2735c283ce virtualized activity log 2026-03-24 17:47:51 +00:00
FoxxMD 0daaec81ca feat(ui): Add more info to play data 2026-03-24 01:22:39 +00:00
FoxxMD 2085df4406 feat(ui): Dynamic expand/collapse all 2026-03-24 00:16:57 +00:00
FoxxMD 9b8664d3a3 feat(ui): Condense timeline items into title using collapsible 2026-03-24 00:02:42 +00:00
FoxxMD e027a33e8d feat(ui): Play Data rows for better use of wide viewports 2026-03-23 18:56:50 +00:00
FoxxMD f04a19d34d feat(ui): Add flow and step state to timeline 2026-03-23 18:32:28 +00:00
FoxxMD 4b27671a91 feat: Add step and flow result to lifecycle 2026-03-23 18:32:12 +00:00
FoxxMD 5f4943e025 fix(ui): Fix keys 2026-03-20 20:47:38 +00:00
FoxxMD 66cdb94d57 feat(ui): Add lifecycle step story and fix diff rendering 2026-03-20 20:39:35 +00:00
FoxxMD 5ebb0e6a9c refactor: Separating functions so they are usuable by frontend storybook 2026-03-20 19:33:09 +00:00
FoxxMD dfb7f43c00 feat: Implement play with lifecycle fixture 2026-03-20 18:24:04 +00:00
FoxxMD ed85d35117 feat: Implement random object generator 2026-03-20 16:31:19 +00:00
FoxxMD 7d69e77ac6 Implement proper play conversion for frontend/backend testing
Convert to json-equivalent object, and back, without needing json stringify/parse
2026-03-20 15:22:53 +00:00
FoxxMD 03973d215b refactor: Fix JsonPlayObject to properly type dates 2026-03-20 14:00:17 +00:00
FoxxMD 3d5c2c7450 fix: Remove schema-plugin types hint from docusaurus config 2026-03-20 13:31:51 +00:00
FoxxMD d6264dd994 chore: ignore storybook folders for docker image 2026-03-20 13:31:33 +00:00
FoxxMD 4c18123207 refactor: Move some utils into core folder 2026-03-20 13:29:23 +00:00
FoxxMD 71e7f41ea5 more ui improvements 2026-03-20 01:02:25 +00:00
FoxxMD 60cf5d1019 feat(ui): Hide text-heavy elements for small mobile 2026-03-19 21:11:11 +00:00
FoxxMD 3977057dfa more tweaks 2026-03-19 20:36:48 +00:00
FoxxMD 943bdc3e88 feat(ui): Improve play data 2026-03-19 20:23:15 +00:00
FoxxMD 44710048f4 feat(ui): Integrate timeline into activity detail 2026-03-19 19:48:22 +00:00
FoxxMD 9f9f5655b1 feat(ui): Implement scrobble action 2026-03-19 18:38:39 +00:00
FoxxMD e621811364 feat(ui): Implement duplicate match check 2026-03-19 18:10:26 +00:00
FoxxMD 685bc846e8 feat(ui): Implement transform steps 2026-03-19 17:36:02 +00:00
FoxxMD 3a9d58fae9 feat(ui): Implement error stack and more things 2026-03-19 02:07:09 +00:00
FoxxMD 33639c6e4c more improvements 2026-03-18 20:59:53 +00:00
FoxxMD 7c235e3179 feat(ui): Add PlayInfo to list 2026-03-18 20:29:39 +00:00
FoxxMD 559d749207 feat(ui): More activity log improvements 2026-03-18 20:12:01 +00:00
FoxxMD 53feae0f8c more imrovements 2026-03-18 19:04:51 +00:00
FoxxMD 0941ccc0ac improved list layout 2026-03-18 18:33:16 +00:00
FoxxMD 82ecd96ba4 Containerized playinfo 2026-03-18 18:19:38 +00:00
FoxxMD e118dc5db1 Better args default for stories 2026-03-18 18:19:27 +00:00
FoxxMD 1a23491ac2 feat(ui): Set max height for code block with scrolling 2026-03-18 17:56:38 +00:00
FoxxMD d916f167a5 feat(ui): Implement code block toggle for play info 2026-03-18 17:35:43 +00:00
FoxxMD 0102249549 feat(ui): Implement PlayInfo component 2026-03-18 16:44:17 +00:00
FoxxMD 2ca96dab42 Init storybook with chakra-ui 2026-03-18 10:25:20 -04:00
FoxxMD 345e60b7a3 chore(release): Bump version for release 2026-03-16 13:33:06 +00:00
Matt Foxx b9fb6c9d35 Merge pull request #487 from FoxxMD/jsonView
feat(docs): Implement rich config exploration and interaction
2026-03-13 15:00:29 -04:00
FoxxMD 5d0ccd8867 docs: re-nable AIO config display as read-only on mobile 2026-03-13 14:52:29 -04:00
FoxxMD b36f484f3b chore: Add netlify-specific build command 2026-03-13 14:52:29 -04:00
FoxxMD d2f7f986c7 Add gitkeep for schema folder 2026-03-13 14:52:29 -04:00
FoxxMD 9137d03b9f use genericonfiguration component for remaining client/sources 2026-03-13 14:52:29 -04:00
FoxxMD f6c0d13a8b feat(docs): Implement config example/structure guidance 2026-03-13 14:52:17 -04:00
FoxxMD c472b4e33a refactor: reorganized and consolidate source/client types 2026-03-13 14:52:17 -04:00
FoxxMD f6c3fc6b50 refactor(docs): replace docusaurus json-schema-plugin
* Use cf-json-schema-viz for schema viewer
* Use modern-react-json-editor for editing
2026-03-13 14:50:39 -04:00
FoxxMD 8ba146495e feat(jellyin): Add external URL guidance
#486
2026-03-12 14:00:59 +00:00
Matt Foxx 68c46fefb2 Merge pull request #471 from FoxxMD/componentPagination
feat: Implement pagination fetching for component listen data
2026-03-12 08:46:36 -04:00
Matt Foxx eddda41559 Merge pull request #473 from owendaprile/push-ovmumqzwvmqx
fix(plex): Also read MBIDs from `guid` field
2026-03-11 14:08:36 -04:00
FoxxMD 5945fdc2ef docs(spotify): Add premium account guidance
#485
2026-03-11 17:59:27 +00:00
FoxxMD d110dcbdcf fix(sources): Add a confidence signal to plays generated from authoratiative sources to avoid fuzzy matching repeats
https://github.com/FoxxMD/multi-scrobbler/issues/430#issuecomment-4035670777
2026-03-11 13:54:24 +00:00
Owen D'Aprile ebc0aa8a4e fix(plex): Also read MBIDs from guid field
Some items on Plex store the MBID in the `guid` field in the `Metadata`
response, not in the `Guid` field. This change checks the `guid` field
as a fallback if the `Guid` field is not set.
2026-03-10 20:24:25 -04:00
FoxxMD d4113b464a feat(scrobbler): Improved dupe detection
* Check queue before adding so that previously cached or re-discovered plays from a source are not added multiple times to the queue (should only be unique plays)
* Add timestamp heuristic to dupe matching -- if score is *close* to matching and timestamp is *exact* then nudge it into a match
2026-03-10 20:37:14 +00:00
FoxxMD 753dfe1fb3 feat: Implement better request retry logic
* Use p-retry to standard retry behavior
* Simplify/remove other own-rolled retry logic
* Fix superagent request instantiation
  * Requests are mutable, cannot be retried once executed. Need to make a new request for each retry
2026-03-10 19:47:42 +00:00
FoxxMD 013cccaac5 add more logging for discord now playing update logic 2026-03-10 16:43:49 +00:00
FoxxMD 504f8ffbeb refactor(source): Reduce logging noise for activity checks
Move most activity checks to TRACE log level to reduce noise at DEBUG level
2026-03-10 16:06:55 +00:00
FoxxMD 81d1eb2553 feat(ui): Default logs to trace 2026-03-10 15:33:54 +00:00
FoxxMD c9327b0e92 fix(lastfm): Default to not including now playing in history response
Scrobbler getScrobblesForTimeRange function isn't aware of the context and we only want now playing for the Source impl anyway.

Fixes not scrobbling play because it is also now playing which mathced existing scrobble logic.

https://github.com/FoxxMD/multi-scrobbler/issues/430#issuecomment-4031615361
2026-03-10 15:00:13 +00:00
FoxxMD 36aa236d82 use TRACE for cache file loading chunk logging 2026-03-09 19:44:58 +00:00
FoxxMD 3c37aa4449 fix(lastfm): Fix not returning nowPlaying scrobble 2026-03-09 18:39:33 +00:00
FoxxMD f1bf3cbe64 fix(nowPlaying): Scrobbler should report now playing if player state is known nowPlayingMode source
#477#issuecomment-4022857648
2026-03-09 18:39:11 +00:00
FoxxMD 17a9356040 fix: Handle historical scrobble fetch failure
* Don't cache error
* Handle error with logging and put scrobble into dead queue (or increment retries on dead)
2026-03-09 16:47:11 +00:00
FoxxMD 97c799bf2c refactor: Re-implement retry logic for LZ with fixed request init 2026-03-09 16:46:10 +00:00
FoxxMD 99c02daec7 fix(koito): Assign cursor to page param 2026-03-09 16:45:30 +00:00
FoxxMD 4cb792641d fix(pagination): Assign cursor on initial request and properly catch errors to add request parameter logging 2026-03-09 16:45:13 +00:00
FoxxMD fbc2950854 fix upstream scrobble tests 2026-03-06 20:47:04 +00:00
FoxxMD 08e0bdb437 feat(scrobbler): re-implement scrobble preload
Use a limit/maxFetch upper limit to return a bulk of scrobbles by count, rather than timerange, so that backlogged scrobbles are less likely to cause many fetches on first startup
2026-03-06 20:28:22 +00:00
FoxxMD 73dcab4de1 fix(scrobbler): Fix ttl for timerange cahe and missing awaits 2026-03-06 19:42:15 +00:00
FoxxMD 00594a14ed feat: Implement timerange consolidation 2026-03-06 19:41:54 +00:00
FoxxMD 52d5bab0f5 Implement noop logger 2026-03-06 19:40:50 +00:00
FoxxMD a41f4c56f7 feat(scrobbler): Implement play-dependent, arbitrary timerange fetching for duplicate checks
* Remove design bias towards "recent" scrobbles with limited timerange and complex shouldRefresh logic
* Replace with logic to fetch scrobbles from timeranges that are relevant to queued/dead scrobbles
  * timeranges are grouped by closely timestamped queued scrobbles
  * timeranges are cached based on staleAfter
2026-03-06 16:57:09 +00:00
Matt Foxx 8ea83962d6 Merge pull request #482 from FoxxMD/namedTransformFix
fix(transform): Fixes for user transform and transform selection
2026-03-06 08:15:34 -05:00
FoxxMD 9d97cc6e4c fix(transform): Fix transform for stage not using name for selection #481 2026-03-05 15:49:51 +00:00
FoxxMD 023579de9a refactor(atproto): Replace naive TID impl with @ewanc26/tid 2026-03-04 21:00:35 +00:00
FoxxMD 214d99f1c3 fix(lastfm): Check for singular scrobble response 2026-03-04 21:00:35 +00:00
FoxxMD d6fc6b9b10 debug for lastfm list type 2026-03-04 21:00:35 +00:00
FoxxMD cbdab93f92 refactor(tealfm): Replace TID package to avoid node-gyp dependency 2026-03-04 21:00:35 +00:00
FoxxMD abf37f0687 refactor(spotify): use listen timerange fetcher 2026-03-04 21:00:35 +00:00
FoxxMD e993a43399 refactor: Implement generic cursor iteration 2026-03-04 21:00:35 +00:00
FoxxMD bc79969fd0 refactor(maloja): use listen timerange fetcher 2026-03-04 21:00:35 +00:00
FoxxMD 801f9ed403 refactor(koito): Use listen timerange fetcher 2026-03-04 21:00:34 +00:00
FoxxMD 3d9f6f8f58 refactor(lastfm): Use listen timerange fetcher 2026-03-04 21:00:34 +00:00
FoxxMD c2676fb620 refactor(listenbrainz): Use listen timerange fetcher 2026-03-04 21:00:34 +00:00
FoxxMD cdb4ab23e9 refactor(listenbrainz)!: Remove Koito support
Koito functionality has diverged enough that it doesn't make sense to provide partial support via LZ components.

This also makes timerange pagination easier.
2026-03-04 21:00:33 +00:00
FoxxMD b3217f2d9c mostly implemented time range fetch utility 2026-03-04 20:59:52 +00:00
FoxxMD 7b61385ad5 implement time range scrobbles for teal 2026-03-04 20:59:52 +00:00
FoxxMD b5c86e74ad more pagination implementation 2026-03-04 20:59:51 +00:00
FoxxMD a3031a7eb9 Somewhat working
Stole pagination from FoxxMD/multi-scrobbler#390
2026-03-04 20:59:32 +00:00
FoxxMD 7c49a0535f fix typings 2026-03-04 20:36:35 +00:00
FoxxMD 797e5b0794 feat(scrobbler): Add dupe match debug information to lifecycle 2026-03-04 20:30:03 +00:00
FoxxMD bc6cd78c86 refactor: Implement alreadyScrobbled in base class
None of the child classes use a different implementation. DRY
2026-03-04 18:40:27 +00:00
FoxxMD 98a5b40be5 refactor: Use trace logging for defaults
* All logger use trace as minimum level
* Force app log stream to trace minimum so we always show all possible logs in dashboard
* Add trace level to dashboard
* Make dashboard start in debug logs for readability
2026-03-04 18:22:41 +00:00
FoxxMD 87c174fe0f chore: exclude schema folder from search 2026-03-04 15:52:49 +00:00
Matt Foxx 0cbb45e4ad Merge pull request #478 from FoxxMD/discordHangingStatus
fix(discord): Add hidden activity type
2026-03-04 10:41:11 -05:00
FoxxMD b11226af94 fix(discord): Don't throw on unknown activity type
This isn't used for filtering anymore so its not necessary to validate to a known activity
2026-03-04 15:40:14 +00:00
Matt Foxx 27dc5b5e19 Merge pull request #479 from FoxxMD/userTransformDefaults
fix(transform): Fix missing defaults assignment for stage config parsing
2026-03-04 08:12:58 -05:00
FoxxMD d892b83110 fix(transform): Fix user transform default value 2026-03-03 22:00:42 +00:00
FoxxMD c28984524a fix(transform): Fix missing defaults assignment for stage config parsing 2026-03-03 21:04:40 +00:00
FoxxMD 5d4fb63baa fix(discord): Add hidden activity type
Fixes #477
2026-03-03 13:50:14 +00:00
FoxxMD ca2574d1e5 Add comment pointing to JF source on MB ids 2026-03-02 15:45:43 +00:00
FoxxMD 758038e278 fix: Missed dependency bump 2026-02-27 16:57:24 +00:00
FoxxMD cb803b1a24 feat: Use lower minimum log level to prepare for logging cleanup 2026-02-27 16:51:30 +00:00
FoxxMD c985af5722 docs: Add discord to readme 2026-02-27 14:19:41 +00:00
FoxxMD 1ede54acbb docs: Fix broken links and anchors 2026-02-27 14:18:50 +00:00
FoxxMD a73ca6a95d feat(ui): Add service status page link to dashboard 2026-02-27 02:45:12 +00:00
FoxxMD 25f4095276 chore(release): Bump version 2026-02-26 20:37:22 +00:00
FoxxMD d242c133dd docs(faq): Add connection/dns guidance 2026-02-26 19:39:51 +00:00
FoxxMD da3e8044b7 docs: Add status page to monitoring section 2026-02-26 19:23:58 +00:00
FoxxMD b6d5939fbf chore: Add kasm service as extenable compose file for dev 2026-02-26 19:12:21 +00:00
FoxxMD d23ef88647 docs(discord): Clearer wording on user token usage 2026-02-26 17:21:48 +00:00
FoxxMD f374f130de fix(discord): Kasm improvements
* Fix permissions in compose example
* Better wording in advantages/disadvantages
2026-02-26 17:21:30 +00:00
FoxxMD b0c2c8611b docs(discord): Use named volume for kasmcord 2026-02-26 02:16:43 +00:00
FoxxMD 6f6f56ce64 docs(discord): Reorganize discord app container instructions and improve art examples 2026-02-26 02:06:21 +00:00
FoxxMD 4b28ec4b3a fix(discord): wrong protocol comparison 2026-02-25 21:14:12 +00:00
FoxxMD d189084c15 feat(discord): Implement retry for cover art api 2026-02-25 20:56:19 +00:00
FoxxMD 975d9540bc docs(discord): Update kasmcord with persistent config volume 2026-02-25 20:18:41 +00:00
FoxxMD 212bfba950 docs(discord): Add discord container instructions 2026-02-25 19:19:31 +00:00
FoxxMD 619e32cd83 feat(discord): Add more logging for cover art acquistion 2026-02-25 19:17:09 +00:00
FoxxMD ce9ff53ae1 feat(discord): Add debug log when no cover art found 2026-02-25 19:07:39 +00:00
FoxxMD d13fb33884 docs(discord): Improved discord app docs 2026-02-25 16:31:55 +00:00
FoxxMD 253e91250f fix(discord): Patch IPC client to catch socket error 2026-02-25 02:54:18 +00:00
FoxxMD b23668372b feat(discord): Correct position timestamp based on player last update time #468 2026-02-24 20:07:31 +00:00
FoxxMD 5b847c136e fix(discord): Don't queue scrobbles 2026-02-24 19:03:25 +00:00
FoxxMD 0d304a793d fix(scrobblers): Don't queue now playing data if scrobbler is not ready 2026-02-24 18:46:02 +00:00
FoxxMD 906e1a1a19 fix(discord): Stop scrobbler and set as auth failure on invalid client from IPC 2026-02-24 18:45:43 +00:00
FoxxMD 87f46f1e02 Improve failure mode handling for IPC discord
* Set auth failure on 4000 from server (invalid client id)
* Better logging for connection issues
* Don't fail on connect so we can keep retrying on MS activity
2026-02-24 18:31:46 +00:00
FoxxMD 56b4be1fe1 QoL features for discord-rpc library
* Add keepAlive to so close events actually happen
* DEBUG log human readable payload rather than hex
2026-02-24 18:28:37 +00:00
FoxxMD a08dcf05f1 refactor(discord): Remove activity filtering
https://github.com/FoxxMD/multi-scrobbler/issues/468#issuecomment-3952116123
2026-02-24 15:13:28 +00:00
FoxxMD 460882f6c1 fix(discord): wrong eqaulity for token check 2026-02-24 13:31:41 +00:00
FoxxMD 71fc94ba63 Missing category 2026-02-23 22:32:24 +00:00
FoxxMD b587d834bc docs: Add discord local/headless docs 2026-02-23 22:31:33 +00:00
FoxxMD 9b63e022ed Don't require media proxy for IPC 2026-02-23 21:15:37 +00:00
FoxxMD 324cbd76ee refator(discord): Move client init to build stage with more logging 2026-02-23 21:03:58 +00:00
FoxxMD ceab13f672 refactor(discord): Consolidate shared functionality 2026-02-23 20:47:22 +00:00
FoxxMD 10e17ed239 Initial IPC implementation 2026-02-23 20:15:21 +00:00
FoxxMD 4f84479513 fix: Fix labels for MS heartbeat task 2026-02-23 16:42:18 +00:00
FoxxMD 216ad4ed32 fix(discord): Stabalize heartbeat interval and logging
* Refactor sequence and gateway receive logging as labels
* Use timeout instead of interval for heartbeat to try to fix weird speedup
2026-02-23 16:42:18 +00:00
FoxxMD 85e4555322 fix(discord): Even more reconnect handling improvements
* Fix reconnect logic and ready state clearing
* Clearer and less noisy logging
* Delay clearing activities for convience on quick reconnect
2026-02-20 16:59:03 +00:00
FoxxMD a90e443a88 faster heartbeat for safety 2026-02-19 17:25:24 +00:00
FoxxMD a9c54b5f91 refactor(discord): More connection logic improvements
* Handle connect and auth separately so it can be restarted by scrobble heartbeat
* make ms-initiated reconnect use manual close/open since isosockets won't
* better error handling for auth/connection init stages
* send heartbeats even if not authed
2026-02-19 17:23:38 +00:00
FoxxMD 6d21435aab fix(discord): Use iso-websockets reconnect and workaround initial connection issues 2026-02-19 16:32:59 +00:00
FoxxMD 9c3bb11a66 more discord ws logging 2026-02-19 14:28:16 +00:00
FoxxMD d983080584 fix(discord): Fix config logging for artwork 2026-02-18 19:40:46 +00:00
FoxxMD 852b96009c docs cleanup 2026-02-18 18:13:54 +00:00
FoxxMD c82617d857 docs(discord): Update artwork guidance for cover art archive 2026-02-18 17:19:08 +00:00
FoxxMD 6f19256187 feat(discord): Use release mbid to get coverart if fallback would otherwise be used 2026-02-18 16:16:46 +00:00
FoxxMD 479ede334b fix(transform): Use temporally-invariant hash comparison
Fixes not using transform hashes due to user listening data on discover or for playing now data
2026-02-18 16:16:05 +00:00
FoxxMD e1349255de feat(scrobblers): Run preCompare transform hook on playing now data 2026-02-18 16:15:10 +00:00
FoxxMD 4a600dc01d Make art its own type 2026-02-18 15:27:09 +00:00
FoxxMD 315256ce96 feat(musicbrainz): Implement CoverArtArchive API 2026-02-18 15:25:14 +00:00
Matt Foxx bbead20723 Merge pull request #472 from FoxxMD/discordPresence
feat: Discord rich presence
2026-02-17 16:35:30 -05:00
FoxxMD bb77c1c0bb feat(discord): Use artwork url if its from a known domain 2026-02-17 21:28:53 +00:00
FoxxMD 2a2fb9ad55 refactor(discord): Update links and art
* Use pocike icon for placeholder art
* Use MS logo for small art with link to docs
* Use web link as track url, if available
* Use MB link as track or artist url
2026-02-17 21:05:26 +00:00
FoxxMD ea5b66cdae fix(discord): Fix ajv not liking defaultUrl string | false 2026-02-17 20:16:50 +00:00
FoxxMD 1a978c7ee3 fix: Fix config validation error source 2026-02-17 20:13:11 +00:00
FoxxMD cfd458f463 docs(discord): Improve artwork url guidance and application id 2026-02-17 20:12:49 +00:00
FoxxMD 61b8277822 feat(discord): Add actionable links for public URLs and musicbrainz
Add links to album art and/or small image if application id enabled
2026-02-17 19:05:17 +00:00
FoxxMD 53c8036e34 feat(discord): Add more presence configuration options 2026-02-16 21:08:23 +00:00
FoxxMD f5c8ce5109 more now playing fixes and improvements 2026-02-16 21:08:06 +00:00
FoxxMD 17b11f19a3 feat(nowplaying): Update now playing based on play presence AND player status 2026-02-16 17:26:34 +00:00
FoxxMD 2993279d78 feat(discord): Add platform specific now playing should update check 2026-02-15 18:36:27 +00:00
FoxxMD b95b7e3781 fix(discord): Add missing applicationId env and docs 2026-02-14 00:12:16 +00:00
FoxxMD c57200132e use discord.js deps in production build 2026-02-13 23:04:38 +00:00
FoxxMD f6d9921581 type fixes 2026-02-13 22:08:46 +00:00
FoxxMD 3aada673d5 feat(discord): Add album art functionality 2026-02-13 22:00:40 +00:00
FoxxMD 1456070044 fix(discord): Better error handling and reconnect logic 2026-02-13 20:42:23 +00:00
FoxxMD 883797a51d docs(discord): Add discord docs 2026-02-13 19:47:18 +00:00
FoxxMD 1b93512b0a feat(discord): artwork fallback and ENV config 2026-02-13 19:47:05 +00:00
FoxxMD 7c99262a79 feat(discord): Initial implementation #468 2026-02-13 18:39:33 +00:00
FoxxMD d10ecb88bb chore(release): Bump version 2026-02-12 13:31:36 +00:00
FoxxMD bb0f8e1a9a fix(spotify): Destructure external_ids from default object #470 2026-02-12 13:18:49 +00:00
FoxxMD 8be1ace9a1 chore(release): Bump version 2026-02-11 15:26:20 +00:00
FoxxMD 80d6879d2a chore: Update git-cliff workflow
* Add as dev dependency with npm script so it can be run anywhere project is installed
* Update config with newer template based on scopesorted
  * Add more scopes and give them pretty emojis
2026-02-11 15:24:54 +00:00
Matt Foxx 0b8dfaa5b5 Merge pull request #466 from FoxxMD/deezerImprovements
feat: Deezer family account and other improvements
2026-02-11 08:17:55 -05:00
Matt Foxx 3e25be1e9d Merge pull request #467 from FoxxMD/jellyfinUnknownLax
feat(jellyfin): More granular media type filtering
2026-02-11 08:17:35 -05:00
FoxxMD 4e550d14af fix(jellyfin): Fix options being required
The old jellyfin config had optional options which kept the new jf options required from *always* being required. Removing the old config revealed this bug.

Fixes #469
2026-02-10 20:06:06 +00:00
FoxxMD eab33559ca fix: allow musicvideo media type and use allowedMediaTypes for NowPlayingItem check 2026-02-10 19:39:35 +00:00
FoxxMD 83076a0770 docs: Update screenshot 2026-02-05 17:21:47 +00:00
FoxxMD db65b3140a docs: Remove erroneous ENV restriction 2026-02-05 00:43:17 +00:00
FoxxMD 70b703df8b docs: Wording and client order
* Make landing description more generalized.
* Put Koito as first client. Maloja is unmaintained and shouldn't be showcased.
2026-02-04 14:15:35 +00:00
FoxxMD 00070a1bd2 docs: Make compose default tab for installation 2026-02-04 13:44:13 +00:00
FoxxMD c7bf419ac4 chore: Remove unused dockerfile
alpine hasn't been used in awhile due to dns problems
2026-02-04 13:41:33 +00:00
FoxxMD 850f9f081a fix(jellyfin): Allow all media types when allowUnknown is true
Fixes #445
2026-02-03 18:51:28 +00:00
FoxxMD 1110b6b047 docs(deezer): Use config tabs 2026-02-03 17:41:18 +00:00
FoxxMD 3c99adc01c feat(deezer): Add family account monitoring #344 2026-02-03 17:26:05 +00:00
FoxxMD 55cec9a16f fix(deezer): Fix error list access #344 2026-02-03 16:04:30 +00:00
FoxxMD c36c7c6440 docs(plex): Add Musicbrainz stage guidance
#447
2026-02-03 15:48:39 +00:00
FoxxMD 7a4e0ea213 fix: Normalize state param for auth redirect URLs
Fixes #443
2026-02-03 15:07:34 +00:00
FoxxMD 5a7e1c0ae5 choer: Bump lastfm-ts-api version
scriptex/lastfm-ts-api#52
2026-02-03 13:40:22 +00:00
Matt Foxx 9c3b079620 Merge pull request #463 from Kernald/oci-source-label
chore(docker): Add source OCI labels
2026-01-31 11:43:26 -05:00
FoxxMD c75fff6833 fix: compatibility for old scrobbles #462 2026-01-31 11:40:14 -05:00
Marc Plano-Lesay 6adf2851ba chore(docker): Add source OCI labels
These labels are used, among other things, by Renovate to pull
changelogs/link to the upstream repository automatically
(https://docs.renovatebot.com/modules/datasource/docker/).
2026-01-31 11:06:08 +11:00
FoxxMD c6e1b9c629 chore: Fix links in issue templates 2026-01-30 10:17:08 -05:00
FoxxMD 09d7bad4a6 chore: Bump version for release 2026-01-30 15:01:47 +00:00
FoxxMD 4e0bc1552a fix(librefm): Relax response content-type
Patch package to fix response content type change from librefm until scriptex/lastfm-ts-api#52 is merged
2026-01-30 14:40:48 +00:00
Matt Foxx 205d626cd6 Merge pull request #460 from FoxxMD/playDiff
feat: Implement play diffing with inputs for debugging
2026-01-29 17:43:49 -05:00
FoxxMD dee2e5ecf8 docs: Add help docs and update github issue template with play debug data 2026-01-29 21:19:36 +00:00
FoxxMD 995f857b08 fix(plex): Do not use album artist MBID when existing artist or is VA #450 2026-01-29 18:58:22 +00:00
FoxxMD 073af2d3b4 fix(plex): Add missing brainz data to lifecycle original 2026-01-29 18:37:13 +00:00
FoxxMD 4b0eaff99c Add missing error capture to dead letter retry failures 2026-01-29 18:18:56 +00:00
FoxxMD 2aac56c97a feat(scrobblers): Serialize error correctly and add debug info to dead letter ui 2026-01-29 17:13:16 +00:00
FoxxMD 67f6880d32 feat(scrobblers): Refactor scrobbling functions to capture transactional data
Capture payload, response/body, errors, and warnings so we can store them in play lifecycle for future debugging
2026-01-29 16:34:25 +00:00
FoxxMD 1f2816e6fb Move debug icon to left side 2026-01-27 17:48:12 +00:00
FoxxMD 50565fe312 fix: Deep clone discovered plays
Fixes shared scrobble object overwriting lifecycle data for each scrobble client
2026-01-27 17:42:23 +00:00
FoxxMD 6332da52e6 Use ms play with scrobble payload for api response 2026-01-27 17:10:18 +00:00
FoxxMD fa06d65046 fix(maloja): Fix logging objects 2026-01-27 17:06:20 +00:00
FoxxMD 1ce27a2543 docs: Comment why compilations don't work for maloja 2026-01-27 17:05:01 +00:00
FoxxMD 406a4b3448 fix: add missing bug icon for copy action in scrobbled page 2026-01-26 20:23:48 +00:00
FoxxMD c0259ac409 feat: Add debug copy action to ui 2026-01-26 20:05:17 +00:00
FoxxMD d474ae24d3 feat: Use json diff to track play changes
* Store Source input and original play
* Store transformer hook results as diff patches alongside stage-specific arbitrary input data
  * Use jsondiffpatch console format to log stage diffs
* Store scrobble payload data
2026-01-26 19:13:03 +00:00
FoxxMD 62b06c0f56 refactor(sonos): Move device/group filters before track type checks to enable easier user workarounds
Device Name/GroupName is more likely to exist and less likely to cause issues than upnpclass and other things we are looking for to verify its a valid track.

User can block the erroring device to "fix" bad behavior.
2026-01-26 13:46:21 +00:00
FoxxMD af6851562c fix(sonos): Check for UpnpClass existing #398 2026-01-26 13:38:19 +00:00
FoxxMD cb62a6a659 fix(musicbrainz): Check for undefined status #458 2026-01-24 19:24:48 +00:00
Matt Foxx 7411f7324a Merge pull request #456 from FoxxMD/sonosStateHandle
fix(sonos): Gracefully handle failure when fetching device state #455
2026-01-23 13:33:54 -05:00
FoxxMD b3467e97b7 fix(sonos): Gracefully handle failure when fetching device state #455 2026-01-23 17:43:03 +00:00
FoxxMD 5b83e774e6 fix: TS typings for brainz meta and missed recording-track rename 2026-01-23 17:09:25 +00:00
FoxxMD 9cc2ca1010 docs: Refactor lastfm source instructions in quickstart guide to use ENV 2026-01-22 21:43:50 +00:00
FoxxMD 77aaefa3c3 docs: Update readme 2026-01-22 16:25:13 -05:00
FoxxMD 7a09950312 chore: Bump version for release 2026-01-22 20:17:07 +00:00
FoxxMD 2244eb4bf0 docs(sonos): Update admonitions 2026-01-22 20:10:23 +00:00
FoxxMD 5f9907adf7 chore: Cleanup dynamic import refactor 2026-01-22 14:49:57 +00:00
Matt Foxx 64eeae78a8 Merge pull request #448 from FoxxMD/mbTrack
feat(musicbrainz): Search by track MBID
2026-01-22 09:36:30 -05:00
Matt Foxx a053104b13 Merge pull request #451 from FoxxMD/lastfmDebug
feat(lastfm): Add response content logging
2026-01-22 09:34:26 -05:00
FoxxMD d2ea1adcb0 chore(lastfm): Use updated lastfm package
* Support timeout scriptex/lastfm-ts-api#50
* Error response debugging scriptex/lastfm-ts-api#51
2026-01-22 14:28:08 +00:00
Matt Foxx 20d86905c0 Merge pull request #439 from FoxxMD/sonos
Implement Sonos Source
2026-01-22 09:23:49 -05:00
FoxxMD 5fba6436ab refactor(sonos): Add missing sonos source dynamic usage 2026-01-22 13:51:54 +00:00
FoxxMD dea6d68228 feat(sonos): Better cleanup for for devices 2026-01-22 13:48:44 +00:00
FoxxMD 2ac9547f6a Use device invariant data for iterating devices
* Use invariant hash for seen state logging
  * Removes dependence on individual properties being available
* Drop player state if an existing existing player has the same play, rather than dropping by existing group
* Enable logging empty player for more debugging info

try to get device summary with for loop
2026-01-22 13:48:42 +00:00
FoxxMD 49529af813 feat(sonos): Add group/device filtering 2026-01-22 13:48:42 +00:00
FoxxMD 54eabf49f0 feat(sonos): Fix first media seen logging and add debug guidance to docs
add env gate to sonos test playground
2026-01-22 13:48:39 +00:00
FoxxMD 16ad50ca4d feat: Implement Sonos Source
disable debug test

Add mising type to source status data
2026-01-22 13:48:37 +00:00
Matt Foxx 49d09d0420 Merge pull request #453 from FoxxMD/memoryFix
refactor: Optimize production for memory usage
2026-01-22 08:31:14 -05:00
FoxxMD 50e613748f reactor: try dynamic import for components 2026-01-21 16:51:51 +00:00
FoxxMD 69d76d2d44 refactor: Use compiled json for schema in production
* Use dynamic import for schema based on environment
  * If production use pre-generated json to avoid loading vega generator -- big memory footprint reduction
  * If not production use vega so schema is always up to date
2026-01-21 16:24:58 +00:00
FoxxMD 65d9026f01 docs(tealfm): Update tealfm links 2026-01-21 13:16:21 +00:00
FoxxMD 5b6ad26b2e feat(lastfm): Add response content logging #449 2026-01-20 15:53:25 +00:00
FoxxMD 59a132e536 chore: Add config types to issue template 2026-01-19 21:35:08 +00:00
FoxxMD 9ec9de519e fix(musicbrainz): find correct release when release or track mbid is present 2026-01-19 21:08:10 +00:00
FoxxMD 54c631eb40 Fix missed track to recording rename 2026-01-19 18:24:59 +00:00
FoxxMD ef96241743 feat(musicbrainz): Search by track MBID using basicorids #447 2026-01-19 18:18:13 +00:00
FoxxMD 0b51c3a5fa refactor(musicbrainz): Rename recording mbid property to recording
So that introducing trackId isn't confusing
2026-01-19 18:09:29 +00:00
FoxxMD 9ccdd53bd8 feat: Implement ENV config for clients as sources
Source that are also clients did not have ENV config due to early design choices that are now irrelevant.

Implement ENV config for these source to make config easier for everyone.
2026-01-19 15:45:25 +00:00
Matt Foxx 8e6730a5ce Merge pull request #444 from FoxxMD/prometheus
feat: Add prometheus metrics #438
2026-01-18 18:02:24 -05:00
FoxxMD a2f4c3088a fix(prometheus): Set content type to plain text #438 2026-01-18 16:39:01 +00:00
FoxxMD ecb65a29c1 docs: Add prometheus usage 2026-01-16 21:16:55 +00:00
FoxxMD b4d8b9ad37 refactor: Add type label for prometheus metrics 2026-01-16 21:16:47 +00:00
FoxxMD d3cde0e373 feat: Add prometheus metrics #438 2026-01-16 21:03:23 +00:00
FoxxMD 28667067ca docs: Add missing default preset to quickstart MB instructions 2026-01-15 21:04:20 +00:00
FoxxMD c469ef02dd docs: Add librefm to repo readme 2026-01-15 15:50:20 +00:00
FoxxMD f48990e31f chore: Bump version for release 2026-01-15 15:39:55 +00:00
FoxxMD 2a0733968e fix: Fix koito spelling 2026-01-14 20:05:59 -05:00
FoxxMD cc7c90c012 docs: Fix styling on default details 2026-01-14 14:19:58 +00:00
FoxxMD 02a54ce8bc fix(librefm): Log warning for empty account rather than throwing
#401
2026-01-14 13:29:56 +00:00
Matt Foxx 25256321b2 Merge pull request #440 from FoxxMD/docComponents
Doc components
2026-01-13 15:42:43 -05:00
FoxxMD 370e3e90b0 docs: Details Admonotions for main configuration 2026-01-13 20:40:04 +00:00
FoxxMD c0c449ecc2 docs: Use AdmonitionDetails 2026-01-13 20:35:11 +00:00
FoxxMD 4f9cfcf46d docs: Re-style details and add custom admonition details component 2026-01-13 20:05:23 +00:00
Matt Foxx b05ff9814e feat: Librefm Source/Client (#436)
* feat(librefm): Implement librefm
* feat(librefm): Make api key/secret optional
* feat(librefm): Add LIBREFM_ENABLE env to allow enabling librefm with no other options
* feat(ui): Show client/source hint for all ambiguous components
2026-01-13 08:24:31 -05:00
Matt Foxx fa34e83474 Merge pull request #437 from jackwilsdon/add-undici
fix: add missing undici dependency
2026-01-12 11:07:00 -05:00
Jack Wilsdon 1c73dd5efa fix: add missing undici dependency 2026-01-11 22:22:28 +00:00
FoxxMD 8f66914dfb chore!: Remove deprecated Plex/Tautulli Sources 2026-01-08 19:00:56 +00:00
FoxxMD 424a764a9c chore!: Remove deprecated Jellyfin Source 2026-01-08 18:45:09 +00:00
FoxxMD 53ef315f50 feat(musicbrainz)!: Improve ENV presets
* Adds `fields` and `id` presets to give ENV users more flexibility
* BREAKING: Removes searchOrder from `sensible` so users must now use `default` with presets (other than `sensible`) to get default searchOrder methods added
2026-01-08 15:18:23 +00:00
FoxxMD 9e3c15c9e8 Improve logging for artist search method 2026-01-08 13:55:33 +00:00
FoxxMD 240fb2ca7d docs: Add read-only install instructions
Closes #429 thanks @drake7707
2026-01-08 13:33:42 +00:00
Matt Foxx 4657df2900 Merge pull request #433 from FoxxMD/musicbrainzSearchAgnostic
feat(musicbrainz)!: Add more control, and types, to api search execution
2026-01-08 08:14:53 -05:00
FoxxMD a3aa0b9988 docs: Improve MB docs 2026-01-07 22:50:01 +00:00
FoxxMD c33ed61220 fix(musicbrainz): Fix default assignment for searchOrder
Prevent undefined so in component transform options from causing defaults to override stage defaults
2026-01-07 22:50:01 +00:00
FoxxMD d7cf3f82ee fix(musicbrainz): Check for release data type before logging #434 2026-01-07 22:50:01 +00:00
FoxxMD 1ec492725c feat(musicbrainz): Implement field scoring 2026-01-07 22:49:57 +00:00
FoxxMD 03d9dc36ec fix: Remove cache assignment in child class 2026-01-07 22:47:22 +00:00
FoxxMD f0ffa1ad8a feat(transformer): Improved caching
* Cache full transform hooks and omit logging when cache hit
  * Big logging reduction for sources that return all plays (teal, lastfm, etc.)
* Implement new error type for stages to discriminate between expected prerequisite failures and true exceptions
  * Used to determine logging level and if hook should be cached
2026-01-07 22:47:22 +00:00
FoxxMD 528d269dde fix: Don't mutate original error when merging cause stack for logging 2026-01-07 22:47:22 +00:00
FoxxMD 5a642c4c06 fix some wording 2026-01-07 22:47:22 +00:00
FoxxMD 867f382cc0 fix type for env preset 2026-01-07 22:47:22 +00:00
FoxxMD 203411a875 docs(musicbrainz): Update search methods 2026-01-07 22:47:22 +00:00
FoxxMD 9833c6c7bb feat(musicbrainz): Implement basic-or-ids search 2026-01-07 22:47:22 +00:00
FoxxMDandgabe 4af0200161 feat(musicbrainz): add exclusive search by recording MBID
* adds mbidrecord search type

Co-authored-by: gabe <gabeklav@fastmail.com>
2026-01-07 22:47:22 +00:00
FoxxMD d27ec5f031 feat(musicbrainz)!: Replace fallback search with searchOrder for more search control
* search order and type of searches now determined by `searchOrder` instead of multiple `fallback*` options with hardcoded order
* Deprecate `fallback*` options
* Deprecate `fallbackArtistSearch` for `searchArtistMethod`
* Refactor ENV presets to use new options
2026-01-07 22:47:22 +00:00
Matt Foxx 9482b66846 Merge pull request #435 from FoxxMD/fixPreTransformClient
fix: Move preCompare transform hook for clients to the correct place …
2026-01-07 17:45:52 -05:00
FoxxMD dcf35a6930 more test fixes 2026-01-07 14:07:03 +00:00
FoxxMD e526fe79eb fix tests 2026-01-07 13:58:03 +00:00
FoxxMD ad61d29f08 fix: Move preCompare transform hook for clients to the correct place in lifecycle 2026-01-07 13:45:43 +00:00
Matt Foxx 2485267666 Merge pull request #426 from owendaprile/push-ursmqpqmrwns
feat(plex): Retrieve MusicBrainz IDs
2026-01-05 15:47:17 -05:00
FoxxMD 46f4fbe585 fix(endpointlz): Mark play as new from source
May fix scrobble clients not refreshing when scrobbling old/offline plays #430
2026-01-05 18:40:51 +00:00
FoxxMD a7a99eec05 feat(plex): Add reasonable timeout to cache calls 2026-01-05 18:15:26 +00:00
FoxxMD bad960d786 refactor(plex): Use existing cache and simplify failure result
* Use Keyv memory cache
* Return undefined instead of null to simplify assignment
* Throw error with cause for clearer logging
2026-01-05 18:10:32 +00:00
FoxxMD a3110dbddc fix(mpd): Add missing MPD envs to source building #432 2026-01-05 17:29:14 +00:00
FoxxMD 01c95d79c1 fix(musicbrainz): Simplify config parsing and log original ids
* simplify config building so new properties aren't accidentally not assigned
* add logPreMbid to defaults to make id search troubleshooting easier
2026-01-05 17:16:01 +00:00
FoxxMD 2b7cbc41f3 feat(musicbrainz): Improved missing mbid parsing and tests 2026-01-05 16:54:48 +00:00
FoxxMD 8bf1bffd70 fix(tealfm): Don't define brainz artist array if empty 2026-01-05 16:21:31 +00:00
FoxxMD df163a26de test(lastfm): Improve artist and mbid parsing
* Update scrobble types to more accurate represent what lastfm returns
* Add tests to check mbids and artists are parsed correctly
2026-01-05 15:29:48 +00:00
FoxxMD a98f8448d6 chore: Bump version for release 2025-12-31 20:47:17 +00:00
FoxxMD 541892a59e fix(musicbrainz): Don't assume duration is missing 2025-12-30 19:28:39 +00:00
FoxxMD 8dcb6528ac fix: Convert MB length to seconds
#423 #427
2025-12-28 16:03:01 +00:00
Owen D'Aprile 210f9a75ed feat(plex): Cache MusicBrainz IDs 2025-12-23 17:23:55 -05:00
Owen D'Aprile 50e3a3bbfe feat(plex): Retrieve MusicBrainz IDs 2025-12-23 17:23:49 -05:00
Matt Foxx 7dd238a48a Merge pull request #424 from SilverKnightKMA/patch-1
Rename 'unnamed-koito' to 'unnamed-rocksky'
2025-12-21 23:25:23 -05:00
Vũ Thanh Tùng 8a157947a6 Rename 'unnamed-koito' to 'unnamed-rocksky' 2025-12-22 10:54:51 +07:00
FoxxMD 5e309250f5 docs: Add valkey docker compose connection example 2025-12-18 16:48:19 +00:00
FoxxMD 0875aefacf feat(tealfm): Implement service filtering and parse isrc/music service from records 2025-12-17 16:34:48 +00:00
FoxxMD 083dcc494e refactor: Move ISRC to main play data
It's not a brainz-specific identifier
2025-12-17 16:09:45 +00:00
FoxxMD e5105b1bb2 chore: Bump version for release 2025-12-17 14:01:19 +00:00
FoxxMD e998a6d95a docs: Add debug mode logging hint 2025-12-17 14:00:16 +00:00
FoxxMD 98f045a70f docs: Improve general transform docs 2025-12-17 13:57:56 +00:00
FoxxMD 419f7cf657 docs(musicbrainz): Highlight ENV config 2025-12-17 13:45:49 +00:00
Matt Foxx 9bef0791c4 Merge pull request #421 from FoxxMD/secretsInterpolation
Secrets interpolation
2025-12-16 21:00:53 -05:00
FoxxMD 15d667f653 docs: Better warnings for ENV interpolation 2025-12-17 01:59:05 +00:00
FoxxMD 939ae6f892 docs: Add config interpolation docs 2025-12-17 01:52:07 +00:00
FoxxMD 0cd36e57d6 feat: Log as WARN if there are unmatched interpolation keys
#420
2025-12-17 01:30:52 +00:00
FoxxMD 5acb92e696 feat(musicbrainz): Search by ISRC before anything else
If ISRC is presents then it should be a guaranteed hit and match. Do a "pre" search using only ISRC before doing the normal field search.
2025-12-17 00:31:22 +00:00
FoxxMD 10a90c7d48 fix(musicbrainz): Add missing duration logic 2025-12-16 23:59:31 +00:00
FoxxMD f0c5686b4a fix: Parse non-interpolated json data as data 2025-12-16 23:53:38 +00:00
FoxxMD cae914b21b docs: Better language for mb quickstart section 2025-12-16 21:19:26 +00:00
Matt Foxx 344083a3a9 Merge pull request #419 from FoxxMD/spotifyBrainzMeta
feat: Add additional metadata from spotify and for listenbrainz submissions
2025-12-16 15:54:18 -05:00
FoxxMD 36ed40f628 feat: Implement secret interpolation from ENV
#420
2025-12-16 20:53:00 +00:00
FoxxMD c650c4a1e0 feat: Implement string interpolation from object values 2025-12-16 20:32:04 +00:00
FoxxMD f50c3b40d5 docs: Add musicbrainz step to quickstart 2025-12-16 19:29:06 +00:00
FoxxMD c1318f7efc feat: Add additional metadata from spotify and for listenbrainz submissions
* Parse irsc and track number from spotify data
* Add isrc and track number to listenbrainz submission
* Correct spotify ids for listenbrainz submission

#418
2025-12-16 18:18:30 +00:00
FoxxMD 615947b4d2 fix(transforms): Update types to allow json validation without type for user
#267
2025-12-16 16:36:47 +00:00
Matt Foxx 7c0a9fcd9a Merge pull request #417 from FoxxMD/improvedStageFlowControl
Improved stage flow control
2025-12-16 09:57:16 -05:00
FoxxMD 72572c9397 docs(transformers): Add Flow Control 2025-12-16 14:54:02 +00:00
FoxxMD 0e3874f35f chore: Update wording for disable web 2025-12-16 13:33:53 +00:00
FoxxMD db8a289517 feat(transformers): Log more transform stage detail for components 2025-12-16 13:33:53 +00:00
FoxxMD 698f0b91fc feat(transformers): Add onSkip flow control
* Don't use newtransform when nothing has been assigned
* Remove nanoid accidental commit
2025-12-16 13:33:23 +00:00
FoxxMD fb08a63e6f fix(musicbrainz): Throw errors on pre/post fetch so onFailure works as expected
#414
2025-12-15 18:37:26 +00:00
FoxxMD a320aba4da fix(transformer): Improve stage error logging
* Merge causes if a simple error exists in the stack, reduces stack logging noise
* Log top level message and print error instead of duplicating message in another error
* Fix adding transform history for failed-continue stage
2025-12-15 18:36:41 +00:00
FoxxMD 088e26ce4f feat(musicbrainz): Make fallback album search configurable #414 2025-12-13 22:23:41 +00:00
Matt Foxx e273159ecb Merge pull request #413 from FoxxMD/spotifyNonItem
fix(spotify): Don't report player state if spotify api doesn't return an item
2025-12-12 16:33:38 -05:00
FoxxMD f0ac53ffff fix(spotify): Don't report player state if spotify api doesn't return an item
It's not useful to the stateful player to return a player state without an item

#412
2025-12-12 21:14:09 +00:00
FoxxMD 4a364ce766 chore: Bump version for release 2025-12-12 13:59:33 +00:00
FoxxMD 6c4cd27aa0 fix(transformer): Don't try to build env transformer when no ENV exists 2025-12-12 13:36:51 +00:00
FoxxMD 861578a417 fix(musicbrainz): Wrong default argument for preRequest 2025-12-12 13:30:46 +00:00
FoxxMD 7f62aa79d0 docs(transforms): Add ENV Config quick example 2025-12-11 18:32:49 +00:00
352 changed files with 33148 additions and 5117 deletions
+1 -1
View File
@@ -1,7 +1,7 @@
version: '3.7'
services:
# Update this to the name of the service you want to work with in your docker-compose.yml file
app:
multi-scrobbler:
# Uncomment if you want to override the service's Dockerfile to one in the .devcontainer
# folder. Note that the path of the Dockerfile and context is relative to the *primary*
# docker-compose.yml file (the first in the devcontainer.json "dockerComposeFile"
+3 -1
View File
@@ -5,9 +5,11 @@
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
"dockerComposeFile": [
"compose.yml"
// uncomment to add kasm/discord service
//"../deploy/docker-compose.discord.yml"
],
"service": "app",
"service": "multi-scrobbler",
"workspaceFolder": "/workspaces",
+4 -1
View File
@@ -27,4 +27,7 @@ build
.vscode
**/act/*
tmp-*
.env
.env
*.env
.storybook
.stories
+31 -3
View File
@@ -7,7 +7,9 @@ body:
attributes:
label: Please check existing knowledge before opening an issue
options:
- label: I have [checked the FAQ](https://foxxmd.github.io/multi-scrobbler/docs/FAQ/) and [documentation](https://foxxmd.github.io/multi-scrobbler/docs/configuration/)
- label: I have [read the Help docs](https://foxxmd.github.io/multi-scrobbler/help/)
required: true
- label: I have [checked the FAQ](https://foxxmd.github.io/multi-scrobbler/FAQ/) and [documentation](https://foxxmd.github.io/multi-scrobbler/configuration/)
required: true
- label: I have [searched through existing issues](https://github.com/FoxxMD/multi-scrobbler/issues?q=sort%3Aupdated-desc) and [discussions.](https://github.com/FoxxMD/multi-scrobbler/discussions)
required: true
@@ -23,6 +25,16 @@ body:
placeholder: The app should have scrobbled from Spotify but instead it crashed with an error about undefined properties, etc...
validations:
required: true
- type: checkboxes
attributes:
label: What configuration types are you using for multi-scrobbler? Check all that apply.
options:
- label: "[Environmental Variables (ENV)](https://foxxmd.github.io/multi-scrobbler/configuration/?configType=env#configuration-types)"
required: false
- label: "[Individual](https://foxxmd.github.io/multi-scrobbler/configuration/?configType=file#configuration-types) Config Files"
required: false
- label: "[All-In-One](https://foxxmd.github.io/multi-scrobbler/configuration/?configType=aio#configuration-types) Config File"
required: false
- type: dropdown
id: platform
attributes:
@@ -52,8 +64,8 @@ body:
description: |
Please copy and paste any/all relevant from the DEBUG level log output.
Even if your issue does not seem to be shown in the logs you should still add as much detail as possible, a _lack_ of issues in logs may be a good hint during debugging.
Your logs will be automatically formatted into code, do not need use backticks.
If possible reproduce the issue with [**Debug Mode** enabled](https://foxxmd.github.io/multi-scrobbler/docs/configuration#debug-mode).
Your logs will be automatically formatted into code. Do not use fenced code blocks (backticks).
If possible reproduce the issue with [**Debug Mode** enabled](https://foxxmd.github.io/multi-scrobbler/configuration#debug-mode).
render: shell
placeholder: |
[2025-02-14 12:47:57.170 -0500] VERBOSE: [Init] Config Dir ENV: undefined -> Resolved: CWD/config
@@ -61,6 +73,22 @@ body:
[2025-02-14 12:47:57.258 -0500] INFO : [Init] Version: master
[2025-02-14 12:47:57.259 -0500] INFO : [Init] Generating schema definitions...
[2025-02-14 12:47:59.148 -0500] DEBUG : [App] [Scrobblers] [Maloja - default] Found 100 recent scrobbles
- type: textarea
id: playDebug
attributes:
label: Play Debug Data
description: |
If relevent, please copy and paste all [**Debug Data**](https://foxxmd.github.io/multi-scrobbler/help#copy-play-debug-data) related to the Plays you are having issues with.
Your data will be automatically formatted into code. Do not use fenced code blocks (backticks) in the text area below.
render: shell
placeholder: |
{
"input": {
"addedAt": 1690250024,
"art": "/library/metadata/186983/art/1698213665",
"duration": 243983,
"grandparentArt": "/library/metadata/186983/art/1698213665",
...
- type: textarea
attributes:
label: Additional Context
@@ -7,7 +7,7 @@ body:
attributes:
label: Please check existing knowledge before opening an issue
options:
- label: I have checked the [documentation](https://foxxmd.github.io/multi-scrobbler/docs/configuration/)
- label: I have checked the [documentation](https://foxxmd.github.io/multi-scrobbler/configuration/)
required: true
- label: I have [searched through existing issues](https://github.com/FoxxMD/multi-scrobbler/issues?q=sort%3Aupdated-desc) and [discussions.](https://github.com/FoxxMD/multi-scrobbler/discussions)
required: true
@@ -7,7 +7,7 @@ body:
attributes:
label: Please check existing knowledge before opening an issue
options:
- label: I have checked the [documentation](https://foxxmd.github.io/multi-scrobbler/docs/configuration/)
- label: I have checked the [documentation](https://foxxmd.github.io/multi-scrobbler/configuration/)
required: true
- label: I have [searched through existing issues](https://github.com/FoxxMD/multi-scrobbler/issues?q=sort%3Aupdated-desc) and [discussions.](https://github.com/FoxxMD/multi-scrobbler/discussions)
required: true
+12
View File
@@ -73,6 +73,7 @@ web_modules/
# dotenv environment variables file
.env
.env.test
*.env
# parcel-bundler cache (https://parceljs.org/)
.cache
@@ -127,6 +128,14 @@ config/*.cache
src/**/**.js
src/**/**.js.map
src/backend/common/schema/*.json
!src/backend/common/schema/aio-client.json
!src/backend/common/schema/aio-source.json
!src/backend/common/schema/aio.json
!src/backend/common/schema/client.json
!src/backend/common/schema/source.json
docsite/static/schemas/*.json
*.bak
*.p8
@@ -139,3 +148,6 @@ build
**/generated-sources.*
.github/act/out
tmp-*
*storybook.log
storybook-static
+45
View File
@@ -0,0 +1,45 @@
import { defineMain } from "@storybook/react-vite/node";
import { mergeConfig } from "vite";
export default defineMain({
"stories": [
"../src/**/*.mdx",
"../src/**/*.stories.@(js|jsx|mjs|ts|tsx)"
],
"addons": [
"@chromatic-com/storybook",
"@storybook/addon-vitest",
"@storybook/addon-a11y",
"@storybook/addon-docs",
"@storybook/addon-onboarding"
],
features: {
// https://github.com/storybookjs/storybook/discussions/33279
sidebarOnboardingChecklist: false,
},
"framework": "@storybook/react-vite",
viteFinal: async (config) => {
return mergeConfig(config, {
optimizeDeps: {
include: ["@storybook/addon-docs"],
},
plugins: [
{
name: "fix-mdx-react-shim",
enforce: "pre",
resolveId(source: any) {
if (
source.startsWith("file://") &&
source.includes("mdx-react-shim.js")
) {
// Convert file:///... path to normal filesystem path for Vite
return new URL(source).pathname;
}
return null;
},
},
],
});
},
});
+6
View File
@@ -0,0 +1,6 @@
import { addons } from 'storybook/manager-api';
import { themes } from 'storybook/theming';
addons.setConfig({
theme: themes.dark,
});
+28
View File
@@ -0,0 +1,28 @@
import addonDocs from "@storybook/addon-docs";
import addonA11y from "@storybook/addon-a11y";
import { definePreview } from "@storybook/react-vite";
import { themes } from 'storybook/theming';
export default definePreview({
parameters: {
controls: {
matchers: {
color: /(background|color)$/i,
date: /Date$/i,
},
},
a11y: {
// 'todo' - show a11y violations in the test UI only
// 'error' - fail CI on a11y violations
// 'off' - skip a11y checks entirely
test: 'todo'
},
docs: {
theme: themes.dark,
},
},
addons: [addonA11y(), addonDocs()]
});
+2 -1
View File
@@ -4,7 +4,8 @@
"mochaExplorer.exit": true,
"search.exclude": {
"**/.docusaurus": true,
"**/build": true
"**/build": true,
"**/schema": true
},
"tailwindCSS.files.exclude": [
"docsite/**"
+4
View File
@@ -90,6 +90,8 @@ RUN npm run build:parallel && rm -rf node_modules && rm -rf docsite/node_modules
FROM base AS app
LABEL org.opencontainers.image.source="https://github.com/FoxxMD/multi-scrobbler"
COPY --chown=abc:abc *.json *.js *.ts index.html ./
COPY --chown=abc:abc patches ./patches
COPY --from=build --chown=abc:abc /app/dist /app/dist
@@ -106,6 +108,8 @@ ARG APP_BUILD_VERSION
ENV APP_VERSION=$APP_BUILD_VERSION
RUN npm ci --omit=dev --no-audit \
# we used compiled schema json for production so this isn't needed
&& npm uninstall ts-json-schema-generator \
&& npm cache clean --force \
&& chown -R abc:abc node_modules \
&& rm -rf /root/.cache
+9 -5
View File
@@ -9,7 +9,7 @@
<img src="/assets/icon.png" align="right"
alt="multi-scrobbler logo" width="180" height="180">
A javascript app to scrobble music you listen to, to [Maloja](https://github.com/krateng/maloja), [Last.fm](https://www.last.fm), [ListenBrainz](https://listenbrainz.org), and other services.
A dockerized app that monitors your music listening activity from *everywhere* and scrobbles it *anywhere*.
* Supports scrobbling from many [**Sources**](https://foxxmd.github.io/multi-scrobbler/configuration/sources)
* [Azuracast](https://foxxmd.github.io/multi-scrobbler/configuration/sources/azuracast)
@@ -22,6 +22,7 @@ A javascript app to scrobble music you listen to, to [Maloja](https://github.com
* [Koito](https://foxxmd.github.io/multi-scrobbler/configuration/sources/koito-source)
* [Last.fm](https://foxxmd.github.io/multi-scrobbler/configuration/sources/lastfm-source)
* [Last.fm (Endpoint)](https://foxxmd.github.io/multi-scrobbler/configuration/sources/lastfm-endpoint)
* [Libre.fm](https://foxxmd.github.io/multi-scrobbler/configuration/sources/librefm-source)
* [ListenBrainz](https://foxxmd.github.io/multi-scrobbler/configuration/sources/listenbrainz-source)
* [ListenBrainz (Endpoint)](https://foxxmd.github.io/multi-scrobbler/configuration/sources/listenbrainz-endpoint)
* [Maloja](https://foxxmd.github.io/multi-scrobbler/configuration/sources/maloja)
@@ -31,6 +32,7 @@ A javascript app to scrobble music you listen to, to [Maloja](https://github.com
* [Musikcube](https://foxxmd.github.io/multi-scrobbler/configuration/sources/musikcube)
* [Plex](https://foxxmd.github.io/multi-scrobbler/configuration/sources/plex)
* [Rocksky](https://foxxmd.github.io/multi-scrobbler/configuration/sources/rocksky-source)
* [Sonos](https://foxxmd.github.io/multi-scrobbler/configuration/sources/sonos)
* [Spotify](https://foxxmd.github.io/multi-scrobbler/configuration/sources/spotify)
* [Subsonic-compatible APIs](https://foxxmd.github.io/multi-scrobbler/configuration/sources/subsonic) (like [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/))
* [teal.fm](https://foxxmd.github.io/multi-scrobbler/configuration/sources/tealfm-source)
@@ -39,13 +41,15 @@ A javascript app to scrobble music you listen to, to [Maloja](https://github.com
* [Yamaha MusicCast](https://foxxmd.github.io/multi-scrobbler/configuration/sources/yamaha-musiccast)
* [Youtube Music](https://foxxmd.github.io/multi-scrobbler/configuration/sources/youtube-music)
* Supports scrobbling to many [**Clients**](https://foxxmd.github.io/multi-scrobbler/configuration/clients)
* [Discord](https://foxxmd.github.io/multi-scrobbler/configuration/clients/discord) (Now Playing)
* [Koito](https://foxxmd.github.io/multi-scrobbler/configuration/clients/koito)
* [Last.fm](https://foxxmd.github.io/multi-scrobbler/configuration/clients/lastfm)
* [Libre.fm](https://foxxmd.github.io/multi-scrobbler/configuration/clients/librefm)
* [ListenBrainz](https://foxxmd.github.io/multi-scrobbler/configuration/clients/listenbrainz)
* [Maloja](https://foxxmd.github.io/multi-scrobbler/configuration/clients/maloja)
* [Rocksky](https://foxxmd.github.io/multi-scrobbler/configuration/clients/rocksky)
* [teal.fm](https://foxxmd.github.io/multi-scrobbler/configuration/clients/tealfm)
* Monitor status of Sources and Clients using [webhooks (Gotify, Ntfy, Apprise)](https://foxxmd.github.io/multi-scrobbler/configuration#webhook-configurations) or [healthcheck endpoint](https://foxxmd.github.io/multi-scrobbler/configuration#health-endpoint)
* Monitor status of Sources and Clients using [webhooks (Gotify, Ntfy, Apprise)](https://foxxmd.github.io/multi-scrobbler/configuration#webhook-configurations), [healthcheck endpoints](https://foxxmd.github.io/multi-scrobbler/configuration#health-endpoint), or [prometheus metrics](https://foxxmd.github.io/multi-scrobbler/configuration/#prometheus).
* Supports [Now Playing](https://foxxmd.github.io/multi-scrobbler/configuration/clients#now-playing) for scrobble Clients
* Supports configuring for single or multiple users (scrobbling for your friends and family!)
* Web server interface for stats, basic control, and detailed logs
@@ -57,7 +61,7 @@ A javascript app to scrobble music you listen to, to [Maloja](https://github.com
[**Quick Start Guide**](https://foxxmd.github.io/multi-scrobbler//quickstart)
<img src="/assets/status-ui.png" width="800">
<img src="/docsite/static/img/status-ui.png" width="800">
**Why should I use this over a browser extension and/or mobile app scrobbler?**
@@ -76,7 +80,7 @@ You set up [configurations](https://foxxmd.github.io/multi-scrobbler/configurati
### Source
A [**Source**](https://foxxmd.github.io/multi-scrobbler/configuration/sources) is a data source that contains information about music you are playing or have listened to, like a desktop player, web music player, or cloud music service. Examples are **Spotify, Jellyfin, Plex, Youtube Music, Navidrome**, etc...
A [**Source**](https://foxxmd.github.io/multi-scrobbler/configuration/sources) is a data source that contains information about music you are playing or have listened to, such as: a desktop player, web music player, or cloud music service. Examples are **Spotify, Jellyfin, Plex, Youtube Music, Navidrome**, etc...
Source configurations consist of:
@@ -86,7 +90,7 @@ Source configurations consist of:
### Client
A [**Client**](https://foxxmd.github.io/multi-scrobbler/configuration/clients) is an application that stores the historical information about what music you have played (scrobbles). Examples are **Maloja, Last.fm, Listenbrainz**...
A [**Client**](https://foxxmd.github.io/multi-scrobbler/configuration/clients) is an application that stores the historical information about what music you have played (scrobbles). Examples are **Koito, Last.fm, Listenbrainz**...
Client configurations consist of:
-71
View File
@@ -1,71 +0,0 @@
FROM lsiobase/alpine:3.18 as base
ENV TZ=Etc/GMT
RUN \
echo "**** install build packages ****" && \
apk add --no-cache \
avahi \
avahi-tools \
nodejs \
npm \
&& \
echo "**** cleanup ****" && \
rm -rf \
/root/.cache \
/tmp/*
RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
ARG data_dir=/config
VOLUME $data_dir
ENV CONFIG_DIR=$data_dir
COPY docker/root/ /
WORKDIR /app
FROM base as build
# copy dep/TS config and install dev dependencies
COPY --chown=abc:abc package*.json tsconfig.json ./
COPY --chown=abc:abc patches ./patches
RUN npm ci \
&& chown -R root:root node_modules
#RUN yarn install
COPY --chown=abc:abc . /app
# need to set before build so server/client build is optimized and has constants (if needed)
ENV NODE_ENV=production
RUN npm run docs:install && npm run build && rm -rf node_modules && rm -rf docsite/node_modules
FROM base as app
#COPY --chown=abc:abc package.json yarn.lock ./
COPY --chown=abc:abc package*.json ./
COPY --chown=abc:abc patches ./patches
COPY --from=build --chown=abc:abc /app/dist /app/dist
COPY --from=build --chown=abc:abc /app/src /app/src
COPY --from=build --chown=abc:abc /app/docsite /app/docsite
COPY --from=base /usr/local/bin /usr/local/bin
COPY --from=base /usr/local/lib /usr/local/lib
ENV NODE_ENV=production
ENV IS_DOCKER=true
ENV COLORED_STD=true
# https://stackoverflow.com/a/63640896/1469797
ARG APP_BUILD_VERSION
ENV APP_VERSION=$APP_BUILD_VERSION
RUN npm ci --omit=dev \
&& npm cache clean --force \
&& chown -R abc:abc node_modules \
&& rm -rf node_modules/@types
ARG webPort=9078
ENV PORT=$webPort
EXPOSE $PORT
+1
View File
@@ -0,0 +1 @@
* Attribution for [`default-artwork.png`](/assets/default-artwork.png): https://www.flaticon.com/free-icon/music_15795471
Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 699 KiB

+42 -29
View File
@@ -1,18 +1,20 @@
# configuration file for git-cliff (0.1.0)
# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration
[changelog]
# changelog header
# A Tera template to be rendered as the changelog's header.
# See https://keats.github.io/tera/docs/#introduction
header = """
# Changelog
# Changelog\n
All notable changes to this project will be documented in this file.\n
"""
# template for the changelog body
# https://tera.netlify.app/docs/#introduction
# A Tera template to be rendered for each release in the changelog.
# See https://keats.github.io/tera/docs/#introduction
body = """
{% if version %}\
## [{{ version | replace(from="v", to="") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
## {{ version | trim_start_matches(pat="v") }} - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
## [unreleased]
## Unreleased
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | upper_first }}
@@ -24,6 +26,7 @@ body = """
{% raw %} {% endraw %}- **BREAKING**: {{commit.breaking_description}}
{%- endif -%}
{%- endfor -%}
{% raw %}\n{% endraw %}\
{%- for commit in commits %}
{%- if commit.scope -%}
{% else -%}
@@ -33,35 +36,45 @@ body = """
{% endif -%}
{% endif -%}
{% endfor -%}
{% endfor %}
{% raw %}\n{% endraw %}\
{% endfor %}\n
"""
# remove the leading and trailing whitespaces from the template
trim = true
# changelog footer
# A Tera template to be rendered as the changelog's footer.
# See https://keats.github.io/tera/docs/#introduction
footer = """
<!-- generated by git-cliff -->
"""
# Remove leading and trailing whitespaces from the changelog's body.
trim = true
[git]
# allow only conventional commits
# https://www.conventionalcommits.org
# Parse commits according to the conventional commits specification.
# See https://www.conventionalcommits.org
conventional_commits = true
# regex for parsing and grouping commits
# Exclude commits that do not match the conventional commits specification.
filter_unconventional = true
# An array of regex based parsers for extracting data from the commit message.
# Assigns commits to groups.
# Optionally sets the commit's scope and can decide to exclude commits from further processing.
commit_parsers = [
{ message = "^feat", group = "Features"},
{ message = "^fix", group = "Bug Fixes"},
{ message = "^doc", group = "Documentation"},
{ message = "^perf", group = "Performance"},
{ message = "^refactor", group = "Refactor"},
{ message = "^style", group = "Styling"},
{ message = "^test", group = "Testing"},
{ message = "^chore\\(release\\): prepare for", skip = true},
{ message = "^chore", group = "Miscellaneous Tasks"},
{ body = ".*security", group = "Security"},
{ message = "^feat", group = "⛰️ Features" },
{ message = "^fix", group = "🐛 Bug Fixes" },
{ message = "^doc", group = "📚 Documentation" },
{ message = "^perf", group = "Performance" },
{ message = "^refactor", group = "🚜 Refactor" },
{ message = "^style", group = "💅 Styling" },
{ message = "^test", group = "🧪 Testing" },
{ message = "^ci", group = "🧑‍🍳 Continuous Integration" },
{ message = "^build", group = "🐋 Build" },
{ message = "^chore\\(release\\)", skip = true },
{ message = "^chore", group = "⚙️ Miscellaneous Tasks" },
{ body = ".*security", group = "🛡️ Security" },
]
# filter out the commits that are not matched by commit parsers
# Exclude commits that are not matched by any commit parser.
filter_commits = false
# glob pattern for matching git tags
tag_pattern = "[0-9]*"
# regex for skipping tags
skip_tags = "v0.1.0-beta.1"
# Order releases topologically instead of chronologically.
topo_order = false
# Order of commits in each group/release within the changelog.
# Allowed values: newest, oldest
sort_commits = "oldest"
+11
View File
@@ -0,0 +1,11 @@
[
{
"name": "MS",
"enable": true,
"data": {
"applicationId": "8190211179716453570",
"ipcLocations": ["192.168.0.105:6655"]
}
}
]
+11
View File
@@ -0,0 +1,11 @@
[
{
"name": "MS",
"enable": true,
"data": {
"token": "Ma7XBvzRERK3gQdkX4dkb3OQ.6aaGmJ.rvFiiVrzG4VXHHL3LyhZYhpWdG3Ph_if9aKz5E",
"applicationId": "8190211179716453570"
}
}
]
+2 -1
View File
@@ -16,7 +16,8 @@
"librariesAllow": ["GoodMusic"],
"librariesBlock": ["BadMusic"],
"additionalAllowedLibraryTypes": ["musicvideos"],
"allowUnknown": false,
"allowMediaTypes": ["audio"],
"frontendUrlOverride": "https://myJellyfinExternal.tld"
},
"options": {
"logPayload": true,
+22
View File
@@ -0,0 +1,22 @@
[
{
"name": "myLibreFmClient",
"enable": true,
"configureAs": "client",
"data": {
"apiKey": "anything",
"secret": "anything",
"redirectUri": "http://localhost:9078/librefm/callback"
}
},
{
"name": "myLibreFmSource",
"enable": true,
"configureAs": "source",
"data": {
"apiKey": "anything",
"secret": "anything",
"redirectUri": "http://localhost:9078/librefm/callback"
}
}
]
+1 -1
View File
@@ -16,7 +16,7 @@
"options": {
"logPayload": true,
"logFilterFailure": "debug",
"ignoreInvalidCert": "false"
"ignoreInvalidCert": false
}
}
]
-17
View File
@@ -1,17 +0,0 @@
[
// DEPRECATED, use API Source instead
// rename files to plex.json to use
{
"name": "MyPlex",
"enable": true,
"clients": [],
"data": {
"user": ["username@gmail.com","anotherUser@gmail.com"],
"libraries": ["music","my podcasts"],
"servers": ["myServer","anotherServer"],
"options": {
"logFilterFailure": "warn"
}
}
}
]
+13
View File
@@ -0,0 +1,13 @@
[
{
"enable": true,
"name": "MySonos",
"data": {
"host": "192.168.0.150",
"devicesAllow": ["move","beam"],
"devicesBlock": ["roam"],
"groupsAllow": ["family"],
"groupsBlock": ["bedroom"]
}
}
]
-15
View File
@@ -1,15 +0,0 @@
[
{
"name": "MyTautuilli",
"enable": true,
"clients": [],
"data": {
"user": ["username@gmail.com","anotherUser@gmail.com"],
"libraries": ["music","my podcasts"],
"servers": ["myServer","anotherServer"],
"options": {
"logFilterFailure": "warn"
}
}
}
]
+5 -1
View File
@@ -12,7 +12,11 @@
"configureAs": "source",
"data": {
"identifier": "alice.bsky.social",
"appPassword": "twog-phu7-4dhe-y4j3"
"appPassword": "twog-phu7-4dhe-y4j3",
// everything below is optional
"serviceAllow": ["plyr"],
"serviceDeny": ["last.fm"]
}
}
]
+26
View File
@@ -0,0 +1,26 @@
services:
multi-scrobbler:
volumes:
- kasm_run:/run
kasmcord:
container_name: kasmcord
image: kasmweb/discord:1.14.0
ports:
# VNC port to use in web browser
- 6901:6901
shm_size: 512m
environment:
# set a password for VNC access
VNC_PW: ${KASM_PW:-hunter2}
XDG_RUNTIME_DIR: /run/user/1000
volumes:
- kasm_run:/run/user/1000
- kasm_config:/home/kasm-user/.config
user: "0"
entrypoint: sh -c "chmod 700 /run/user/1000 && chown -R kasm-user:kasm-user /run/user/1000 && chown -R kasm-user:kasm-user /home/kasm-user/.config && su kasm-user -c '/dockerstartup/kasm_default_profile.sh /dockerstartup/vnc_startup.sh /dockerstartup/kasm_startup.sh'"
volumes:
kasm_run:
name: kasm_run
kasm_config:
name: kasm_config
+17 -2
View File
@@ -60,6 +60,21 @@ If multi-scrobbler is not running on the same machine your browser is on then th
EX `http://localhost:9078/lastfm/callback` -> `http://192.168.0.220:9078/lastfm/callback`
### I get errors with `ECONNRESET` `ETIMEDOUT` `ENOTFOUND` `EAI_AGAIN`
These are errors indicating a network issue is occuring between you and the Source/Client.
* `ECONNRESET` means the upstream service unexpectedly closed the connection
* `ETIMEDOUT` means the upstream service did not respond to a request MS
* `ENOTFOUND` means that MS could not find a DNS record for the domain of the upstream service
* `EAI_AGAIN` means that a DNS server did not respond to MS's request to lookup the record for a domain
`ECONNRESET` and timeout issues can occur when you have a poor connection or if the upstream service is overloaded or is generally not behaving well. This is a common occurrence for Listenbrainz/Musicbrainz related requests.
Please check the [Upstream Services Status Page](https://status.multi-scrobbler.app) to independently verify if the service is misbehaving. If the service is up and has good uptime then the issue may be in your network.
`ENOTFOUND` and `EAI_AGAIN` and generally caused by DNS caching (stale records) or misbehaving DNS servers. Though this can happen at the upstream service's end, it is *usually* an issue in your network. If you run a Pihole, AdGaurd, or other DNS solution try flushing the cache for the mishaving domain and check that your DNS application is working correctly.
### Youtube Music fails after some time
If you see errors in multi-scrobbler for YTM that contain **401** or **403** like
@@ -70,7 +85,7 @@ Error: Could not send the specified request to browse. Status code: 401
then YTM has invalidated your authentication.
First, ensure you are NOT using [YoutubeTV authentication.](/configuration/sources/youtube-music?ytmAuth=ytt#authentication) If you completed authentication by entering a "User Code" you are using YoutubeTV which has stopped working. You should reauthenticate using **Cookies** or **Custom OAuth.**
First, ensure you are NOT using [YoutubeTV authentication.](/configuration/sources/youtube-music?ytmAuth=ytt#ytm-auth) If you completed authentication by entering a "User Code" you are using YoutubeTV which has stopped working. You should reauthenticate using **Cookies** or **Custom OAuth.**
#### When using OAuth Client Authentication
@@ -80,7 +95,7 @@ Refresh your authentication by using the **(Re)authenticate** link from MS's web
The library MS uses relies on scraping the YTM site by using cookies from your actual browser to pretend it is a browser. It does its best to keep these up to date but since this is not an official way to access the service YTM may invalidate your access _to the authenticated session_ at any time. How this is triggered is unknown and not something multi-scrobbler can control. You can help limit the chance of your session being invalidated by [getting the cookie from an Incognito/Private Session](https://github.com/LuanRT/YouTube.js/issues/803#issuecomment-2504032666) and then immediately closing the browser afterwards.
To re-authenticate MS [follow the YTM instructions to retrieve a new set of cookies for multi-scrobbler](/configuration/sources/youtube-music?ytmAuth=cookie#authentication) and then restart MS to potentially resolve the problem.
To re-authenticate MS [follow the YTM instructions to retrieve a new set of cookies for multi-scrobbler](/configuration/sources/youtube-music?ytmAuth=cookie#ytm-auth) and then restart MS to potentially resolve the problem.
## Configuration Issues
@@ -12,7 +12,9 @@ A **Client** is an application that stores the historical information about what
| Name | Now Playing |
| :-------------------------------------------------- | :---------- |
| [Discord](/configuration/clients/discord) | ✅ |
| [Last.fm](/configuration/clients/lastfm) | ✅ |
| [Libre.fm](/configuration/clients/librefm) | ✅ |
| [Listenbrainz](/configuration/clients/listenbrainz) | ✅ |
| [Koito](/configuration/clients/koito) | ❌ |
| [Maloja](/configuration/clients/maloja) | ❌ |
@@ -21,6 +23,71 @@ A **Client** is an application that stores the historical information about what
## Features
### Duplicate Detection
Before a Play is scrobbled to a client MS checks existing scrobbles from the Client's API to see if the Play has already been scrobbled.
For each Play, MS fetches (cached) scrobbles from the Client in a time range inclusive of the Play's listening timestamp and then scores existing scrobbles against the Play based on:
* Similarity of Title, Artists, and Album
* Temporal closeness of the Play's timestamp to the existing scrobble's timestamp
* Whether MS detected the Play as a repeat (applicable to Sources that report realtime Player data)
Detailed scoring breakdowns against each existing scrobble are logged at the `TRACE` level.
<details>
<summary>Detailed Explanation</summary>
A **candidate** (to be scrobbled) Play is first transformed using the configured [`compare.candidate` Hook](/configuration/transforms/#hook), if any exists.
Next, MS checks (up to) the last 100 scrobbles *in-memory* scrobbles that it has made. These are *not* from the Client but the actual scrobbles MS made while it has been running. The data from these scrobbles is much richer than what is usually parsed from the Client which makes it easier to detect duplicates from.
If no in-memory scrobble matches then MS starts comparing the candidate against historical scrobbles fetched from an inclusive time range of the candidate's timestamp.
<h3>Matching Title/Artist/Album</h3>
For these string-based values MS uses an [token-order-invariant](https://github.com/FoxxMD/multi-scrobbler/blob/0dfa4c7aad6df98e13aee6d395827665c2414adb/src/backend/utils/StringUtils.ts#L299) method that scores string similarity based on a (token count) weighted average of two [similarity](https://foxxmd.github.io/string-sameness/#md:strategies) algorithms, [Levenshtien Distance](https://en.wikipedia.org/wiki/Levenshtein_distance) and [Dice's Coefficient](https://en.wikipedia.org/wiki/S%C3%B8rensen%E2%80%93Dice_coefficient). The weighted average ensures that very long strings (Track titles) are scored with a confidence proportional to their length.
<h3>Matching Timestamp</h3>
Timestamps are scored on how temporally close they are. There are four possible scores with decreasing value:
* **Exact** - Timestamps are within 1 second of each other
* **Close** - Timestamps are within `threshold` seconds of each other
* This is determined by the smallest update interval of Source
* Some Sources (subsonic) only update every 60 seconds so this is the smallest "close" value possible. Most are 10 seconds. Signified by `(Needed <10s)` in the breakdown example below.
* **Fuzzy** - One timestamp is within `threshold` seconds of the *end* of the other timestamp
* Sources can set the scrobble timestamp at different times. Some do it when the track is started listening to, some when it ends, some when the *player* stops.
* Where possible, MS knows and keeps track of when this timestamp *should* be, for each Source. If it's not possible then Fuzzy may be allowed.
* **None** - There is no correlation between timestamps
<h3>Scoring and Breakdows</h3>
A candidate Play must score >= 1 to be detected as a duplicate of an existing scrobble.
Each score and a breakdown of the scores for its individual components can be see at the `TRACE` logging level or in the [debug data](/help#copy-play-debug-data) for a scrobble. An example:
```
* Artist: 0.06 * 0.3 = 0.02
* Title: 0.04 * 0.4 = 0.02
* Time: (Exact) 1 * 0.5 = 0.50
* Existing: 19:13:33-04:00 - Candidate: 19:13:33-04:00
* Temporal Sameness: Exact
* Play Diff: 0s (Needed <10s)
* Range Comparison N/A
Score 0.54 => No Match
```
In each component equation, the first number is the similarity (or temporal closeness).
* 0 = no correlation
* 1 = exactly the same
The second number is the *weight* of that component in the final score.
</details>
### Dead Scrobbles
If multi-scrobbler is unable to submit a scrobble to a Client then it places the scrobble into a queue which is retried every 5 minutes for a number of times before it gives up.
@@ -0,0 +1,7 @@
{
"label": "Discord",
"link": {
"type": "doc",
"id": "configuration/clients/discord/discord"
}
}
@@ -0,0 +1,566 @@
---
title: Discord (App)
toc_min_heading_level: 2
toc_max_heading_level: 5
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import TcpWarning from "@site/src/components/snippets/_discord-port-warn.mdx";
import JsonConfig from '!!raw-loader!@site/../config/discord-local.json.example';
This scrobbler uses **[Now Playing](/configuration/clients#now-playing)** functionality to set your Discord [Rich Presence](https://docs.discord.com/developers/rich-presence/overview) to the music you are currently monitoring with multi-scrobbler.
<img src={require('/img/discord_presence_art.png').default} height="127"/>
This integration uses an **existing Discord application** to set your Rich Presence.
:::tip
Check the [main Discord docs page](/configuration/clients/discord) for a comparison between **App** and **Headless**.
:::
## Required Setup
### Discord Application
You must create a [Discord App](https://docs.discord.com/developers/quick-start/overview-of-apps) in order to use this integration. Creating an App is free and simple.
Go to the [Discord Developer Portal](https://discord.com/developers/applications)
* Click on "New Application" and give it a name
* Copy the **Application Id** (Client Id) shown after creation
* Add this Id to your Multi-Scrobbler config
* Env Config => `DISCORD_APPLICATION_ID=12345678`
* File Config => `"applicationId": "12345678"`
### Discord Connection
This integration uses an existing, running Discord application to communicate with Discord and set Rich Presence. Multi-scrobbler must be able to communicate with the Discord application, either by being on the same machine or over a network.
<Tabs groupId="discordType" queryString>
<TabItem value="container" label="Containerized Discord">
[Kasm Workspaces](https://kasm.com) provides a self-hostable [Discord container image](https://hub.docker.com/r/kasmweb/discord). This image provides a desktop-like experience, through browser-based VNC, to use the official Discord application.
<img src={require('/img/discord_kasm.png').default} height="400"/>
This containerized approach can be used instead of configuring MS to use a [Native Discord](./?discordType=native#discord-connection) application on a specific machine.
**Advantages**
* Setup is much simpler
* Discord runs in the same stack as multi-scrobbler
* **Configuration is copy-paste.** Skip all of the [Discord Connection](#discord-connection) instructions.
* Get a [Headless](/configuration/clients/discord/discord-headless)-like experience without needing to break Discord TOS
**Disadvantages**
* Image only available for x86 arch
* Image and container are large (1GB+)
* Discord does not notify *other* clients of notifications in a channel if *any* client is viewing that channel.
* To avoid this, make sure your container discord instance is not viewing any server/channel/dm.
* Sometimes, Discord does not deliver "notifications you missed" to mobile because this depends on *all* clients being offline.
<h2>Setup</h2>
Setup is basically the same as using the instructions for [Discord on Linux](./?osType=linux&discordType=native#find-ipc-connection) with [MS on Same Host (Docker)](./?osType=linux&discordType=native#pass-ipc-to-multi-scrobbler).
<h3>1. Add Discord Service to Multi-Scrobbler Docker Compose Stack</h3>
<details>
<summary>Detailed Explanation</summary>
* Add the `kasmweb/discord` service to your compose stack
* Mount the directory containing Discord's unix socket to a named volume
* Configure MS to use Discord's unix socket
* Mount the unix socket volume into MS's container
* Add ENV `DISCORD_IPC_LOCATIONS` to point to the mounted volume
</details>
Use this example `docker-compose.yaml` to modify your existing multi-scrobbler `docker-compose.yaml`:
<details>
<summary>Example</summary>
```yaml title="docker-compose.yaml"
services:
multi-scrobbler:
image: foxxmd/multi-scrobbler:latest
environment:
# ...
- DISCORD_APPLICATION_ID=12345678
# add below line
// highlight-start
- DISCORD_IPC_LOCATIONS=/run/discord-ipc-0
// highlight-end
volumes:
# ...
# add below line
// highlight-start
- kasm_run:/run
// highlight-end
# ...
# .. add discord service below
// highlight-start
kasmcord:
container_name: kasmcord
image: kasmweb/discord:1.14.0
ports:
# VNC port to use in web browser
- 6901:6901
shm_size: 512m
environment:
# set a password for VNC access
VNC_PW: hunter2
XDG_RUNTIME_DIR: /run/user/1000
volumes:
- kasm_run:/run/user/1000
- kasm_config:/home/kasm-user/.config
user: "0"
entrypoint: sh -c "chmod 700 /run/user/1000 && chown -R kasm-user:kasm-user /run/user/1000 && chown -R kasm-user:kasm-user /home/kasm-user/.config && su kasm-user -c '/dockerstartup/kasm_default_profile.sh /dockerstartup/vnc_startup.sh /dockerstartup/kasm_startup.sh'"
volumes:
kasm_run:
name: kasm_run
kasm_config:
name: kasm_config
// highlight-end
```
</details>
Then re-deploy your stack.
<h3>2. Login to Discord</h3>
Navigate in your browser to the IP/host Multi-Scrobbler/Discord are running on. Use the `port` set in the `kasmcord` service:
```
# basic auth login
# user: kasm_user
# pass is what was set in env VNC_PW
https://192.168.MY.HOST:6901
```
Login to Discord normally. After login is complete MS should connect automatically when a Now Playing event happens. If it does not or reports authentication failure then restart MS (but not Discord).
If MS works then you are done and can move on to [Optional Setup](#optional-setup).
</TabItem>
<TabItem value="native" label="Native Discord">
Use this method if you want to connect MS to Discord running on a physical desktop.
<DetailsAdmo type="tip" summary="Local MS Installation Requires No Config">
If MS was [installed locally](/installation#local-installation) (not Docker) on the same machine as the Discord application then MS should [automatically detect the correct method](#find-ipc-connection) and [use it](#pass-ipc-to-multi-scrobbler) **without** any configuration from you. This will work for **any OS**.
If MS cannot determine this automatically, follow the steps for your OS below.
</DetailsAdmo>
Follow the sections below to configure MS for your specific environment.
#### Find IPC Connection
Discord uses OS-specific methods to communicate with other applications on the same host, called [IPC](https://en.wikipedia.org/wiki/Inter-process_communication). You may need to determine some details about the IPC method in order for MS to communicate with it correctly.
<Tabs groupId="osType" queryString>
<TabItem value="linux" label="Discord on Linux">
On Linux, Discord uses a [Unix Socket](https://en.wikipedia.org/wiki/Unix_domain_socket) for IPC.
With Discord running, run this command:
```
$ sudo netstat -apeen | grep discord
unix 2 [ ACC ] STREAM LISTENING 11026149 1641787/Discord /home/foxx/.var/app/com.discordapp.Discord/cache/scoped_dirnnxNIn/SingletonSocket
unix 2 [ ACC ] STREAM LISTENING 11036791 1642030/exe /run/user/1000/discord-ipc-0
```
We see that the path we need is:
```
/run/user/1000/discord-ipc-0
```
</TabItem>
<TabItem value="macos" label="Discord on MacOS">
On MacOS, Discord uses a [Unix Socket](https://en.wikipedia.org/wiki/Unix_domain_socket) for IPC.
With Discord running, run this command:
```
$ sudo netstat -apeen | grep discord
unix 2 [ ACC ] STREAM LISTENING 11026149 1641787/Discord /home/foxx/.var/app/com.discordapp.Discord/cache/scoped_dirnnxNIn/SingletonSocket
unix 2 [ ACC ] STREAM LISTENING 11036791 1642030/exe /run/user/1000/discord-ipc-0
```
We see that the path we need is:
```
/run/user/1000/discord-ipc-0
```
</TabItem>
<TabItem value="windows" label="Discord on Windows">
Windows uses [**Named Pipes**](https://learn.microsoft.com/en-us/windows/win32/ipc/named-pipes) for IPC. These aren't easily iteratable without external software, like [Pipetap](https://github.com/sensepost/pipetap).
The syntax for a named pipe is like this:
```
\\.\pipe\app_named_pipe_foo
```
and Discord's names follow this pattern:
```
\\.\pipe\discord-ipc-0
```
Where `0` increments for each different instance of Discord (official, canary, nightly, etc...).
The default Discord pipe name is: `discord-ipc-0`
</TabItem>
</Tabs>
#### Pass IPC to Multi-Scrobbler
After [finding your IPC connection path](#find-ipc-connection) you will need to make it accessible to Multi-Scrobbler.
<Tabs groupId="osType" queryString>
<TabItem value="linux" label="Discord on Linux">
<Tabs groupId="msConnection">
<TabItem value="remote" label="MS on Different Host">
<TcpWarning/>
Use [`socat`](https://linux.die.net/man/1/socat) to bidirectionally relay communication from Discord's [unix socket](#find-ipc-connection) to a listening TCP port on the same host. Likely, you will want to setup a service to start this command on login.
```shell
$ socat -v TCP-LISTEN:6655,reuseaddr,fork UNIX-CONNECT:/run/user/1000/discord-ipc-0
```
In your MS docker compose file add the `host:port` of the host running Discord/`socat` to `DISCORD_IPC_LOCATIONS` `environment:`
```yaml title="docker-compose.yaml"
environment:
# ...
DISCORD_IPC_LOCATIONS=192.168.DISCORD_HOST.IP:6655
```
</TabItem>
<TabItem value="local-docker" label="MS on Same Host (Docker)">
In your MS docker compose file, pass the path of Discord's [unix socket](#find-ipc-connection) as a volume and add this path to `DISCORD_IPC_LOCATIONS` in `environment:`
```yaml title="docker-compose.yaml"
environment:
# ...
DISCORD_IPC_LOCATIONS=/run/discord-ipc-0
volumes:
- /run/user/1000/discord-ipc-0:/run/discord-ipc-0
```
</TabItem>
<TabItem value="local" label="MS on Same Host (Non-Docker)">
No configuration is required. If MS does not automatically work for you then try the **MS on Same Host (Docker)** method using the `DISCORD_IPC_LOCATIONS` environment variable.
</TabItem>
</Tabs>
</TabItem>
<TabItem value="macos" label="Discord on MacOS">
<Tabs groupId="msConnection">
<TabItem value="remote" label="MS on Different Host">
<TcpWarning/>
Use one of the methods below to setup `socat` on your macOS machine.
<details>
<summary>`socat` installed natively</summary>
Install [`socat`](https://formulae.brew.sh/formula/socat) using homebrew to use it as a native command on your host.
Then, use [`socat`](https://linux.die.net/man/1/socat) to bidirectionally relay communication from Discord's [unix socket](#find-ipc-connection) to a listening TCP port on the same host. Likely, you will want to setup a service to start this command on login.
```shell
$ socat -v TCP-LISTEN:6655,reuseaddr,fork UNIX-CONNECT:/run/user/1000/discord-ipc-0
```
</details>
<details>
<summary>`socat` in Docker</summary>
Use the [`socat` container](https://hub.docker.com/r/alpine/socat) in combination with the Discord [unix socket](#find-ipc-connection) found earlier:
```yaml title="docker-compose.yaml"
services:
socat:
image: alpine/socat
ports:
- "6655:6655"
volumes:
- /run/user/1000/discord-ipc-0:/run/discord-ipc-0
command:
- '-v'
- 'TCP-LISTEN:6655,reuseaddr,fork'
- 'UNIX-CONNECT:/run/discord-ipc-0'
```
</details>
In your MS docker compose file add the `host:port` of the host running Discord/`socat` to `DISCORD_IPC_LOCATIONS` `environment:`
```yaml title="docker-compose.yaml"
environment:
# ...
DISCORD_IPC_LOCATIONS=192.168.DISCORD_HOST.IP:6655
```
</TabItem>
<TabItem value="local-docker" label="MS on Same Host (Docker)">
In your MS docker compose file, pass the path of Discord's [unix socket](#find-ipc-connection) as a volume and add this path to `DISCORD_IPC_LOCATIONS` in `environment:`
```yaml title="docker-compose.yaml"
environment:
# ...
DISCORD_IPC_LOCATIONS=/discord-ipc-0
volumes:
- /run/user/1000/discord-ipc-0:/run/discord-ipc-0
```
</TabItem>
<TabItem value="local" label="MS on Same Host (Non-Docker)">
No configuration is required. If MS does not automatically work for you then try the **MS on Same Host (Docker)** method using the `DISCORD_IPC_LOCATIONS` environment variable.
</TabItem>
</Tabs>
</TabItem>
<TabItem value="windows" label="Discord on Windows">
<Tabs groupId="msConnection">
<TabItem value="remote" label="MS in Docker">
:::note
While it is possible to use [named pipes directly in Docker](https://forums.docker.com/t/volume-mount-path-error/143626/3) this has not been tested and [may only work for windows containers](https://github.com/docker/for-win/issues/6813#issuecomment-632859857). If you are adventurous, try this out and if you can get it working please [report your findings in an issue.](https://github.com/FoxxMD/multi-scrobbler/issues)
:::
:::warning
This method is **experimental** and may be buggy and prone to crashes. If you are a Windows or Rust developer please consider helping improve the [pipe proxy implementation](https://github.com/FoxxMD/named-pipe-to-tcp-proxy).
:::
<TcpWarning/>
Use [**pipeProxy**](https://github.com/FoxxMD/named-pipe-to-tcp-proxy) to connect to the Discord named pipe and expose it on a TCP port.
Download the latest [`pipeProxy.exe`](https://github.com/FoxxMD/named-pipe-to-tcp-proxy/releases) from the releases page.
The host/ip should be the IP of the machine running discord.
Run pipeProxy from the windows command line:
```
pipeProxy.exe --pipe "\\.\pipe\discord-ipc-0" --tcp "192.168.0.100:6655"
```
In your MS docker compose file add the `host:port` of the host running `pipeProxy` to `DISCORD_IPC_LOCATIONS` `environment:`
```yaml title="docker-compose.yaml"
environment:
# ...
DISCORD_IPC_LOCATIONS=192.168.0.100:6655
```
</TabItem>
<TabItem value="local" label="MS on Same Host (Non-Docker)">
No configuration is required. If MS does not automatically work for you then try the **MS in Docker** method using the `DISCORD_IPC_LOCATIONS` environment variable.
</TabItem>
</Tabs>
</TabItem>
</Tabs>
</TabItem>
</Tabs>
## Optional Setup
:::note
Due to the limitations of the Discord local API the other listening activity detection and online status customizations found in [Headless](/configuration/clients/discord/discord-headless#optional-setup) are not available for the Local integration.
:::
### Artwork
Multi-scrobbler can display Album Art in your Discord status. The image that is used differs based on if the image URL is publically accessible.
The order in which multi-scrobbler determines what image to use is the same as the order of the tabs shown below.
#### Artwork URL Types
<Tabs groupId="artworkUrl" queryString>
<TabItem label="External URLs" value="external">
MS can use external URLs for artwork.
<img src={require('/img/discord_presence_art.png').default} height="127"/>
External URLs that are not from known music services are **disabled by default.** This is to preserve *your* privacy because Discord does not host images, it only links to them and the URL is visible to other users.
<details>
<summary>Why Should I Care?</summary>
There are some scenarios where you may not want your artwork URLs to be visible, for example:
* A Source may be accessible only on your LAN (Jellyfin at `http://192.168.0.101`)
* A Source may be internet-facing but you do not want to expose this information to discord/other users
* A Source may be internet-facing but requires authentication to view the image
</details>
MS will use your artwork URLs only if:
* artwork url is from a known music service/[Cover Art Archive](./?artworkUrl=caa#artwork-url-types) or
* artwork url starts with `https` and
* `artwork` (`DISCORD_ARTWORK`) is
* `true` => always uses the url
* a list of custom domains keywords an external artwork url should contain EX
* ENV => `DISCORD_ARTWORK=mycdn,jellyfin`
* File Config => `"artwork": ["mycdn","jellyfin"]`
<details>
<summary>Examples</summary>
None of the below URLs will **ever** be used because they are not `https`
```
http://foobar.com/cool.jpg <-- NOT allowed, not http
http://192.168.0.112/fun.png <-- NOT allowed, not http
```
When `DISCORD_ARTWORK` is not set:
```
https://archive.org/download/dir/myimage.jpg <-- allowed, is https and known service
https://spotify.com/assets/cover.png?size=1000 <-- allowed, is https and known service
https://example.com/cool.jpg <-- NOT allowed, is https but not a known service and DISCORD_ARTWORK is not set
https://anything.com/neat.jpg <-- NOT allowed, is https but not a known service and DISCORD_ARTWORK is not set
```
Setting `DISCORD_ARTWORK=true`
```
https://archive.org/my/dir/myimage.jpg <-- allowed, is https and known service
http://foobar.com/cool.jpg <-- NOT allowed, not http
https://example.com/cool.jpg <-- allowed, is https
https://anything.com/neat.jpg <-- allowed, is https
```
Setting `DISCORD_ARTWORK=mycdn,jellyfin`
```
https://archive.org/my/dir/myimage.jpg <-- allowed, is https and known service
http://foobar.com/cool.jpg <-- NOT allowed, not http
https://example.com/cool.jpg <-- NOT allowed, is https but does not contain "mycdn" or "jellyfin"
https://jellyfin.mydomain.com/neat.jpg <-- allowed, is https and contains "jellyfin"
```
</details>
</TabItem>
<TabItem label="Musicbrainz/Cover Art Achive" value="caa">
MS can try to use [Cover Art Archive](http://coverartarchive.org/) to get album art. The URL it retrieves is public which means it acts like an External URL that is always available for you.
<img src={require('/img/discord_presence_art.png').default} height="127"/>
MS will try to use Cover Art Archive if:
* The scrobble data does not contain an album art url (no art in dashboard) or the existing url has failed an [External URL](./?artworkUrl=external#artwork-url-types) condition
* and **the scrobble data contains a [Musicbrainz](/configuration/transforms/musicbrainz) Release (Album) MBID**
Basically, if MS would normally use the [MS Default](./?artworkUrl=ms-default#artwork-url-types) art, it will first try to use Cover Art Archive if the scrobble has a Release MBID.
Some Source, like [Jellyfin](/configuration/sources/jellyfin) and [Plex](/configuration/sources/plex), can automatically provide this ID if the music is "matched" in your library.
For all others, you can [**configure MS to use the Musicbrainz Stage**](/configuration/transforms/musicbrainz#use-metadata-for-discord-album-art) for Discord to try to get this MBID.
</TabItem>
<TabItem label="MS Default" value="ms-default">
When these conditions are true:
* Cannot use an [External URL](./?artworkUrl=external#artwork-url-types) and
* Cannot get album art from [Cover Art Archive](./?artworkUrl=caa#artwork-url-types) and
* Play does not contain artwork information (no artwork shown in dashboard)
The status artwork will use a default URL instead of your artwork URL.
Without any other configuration, the default URL is an icon from the [multi-scrobbler repository](https://github.com/FoxxMD/multi-scrobbler/blob/master/assets/default-artwork.png):
<img src={require('/img/discord_presence_ms_default.png').default} height="127"/>
This default image can be customized:
* ENV Config => `DISCORD_ARTWORK_DEFAULT_URL=https://cooldomain.com/art.png`
* File Config => `"artworkDefaultUrl": "https://cooldomain.com/art.png"`
Remember, this URL need to be accessible on the public internet.
</TabItem>
</Tabs>
## Configuration
<Config config="DiscordClientConfig" fileContent={JsonConfig} client name="discord">
| Environmental Variable | Required? | Default | Description |
| :---------------------------- | --------- | ------- | :--------------------------------------------------------------------------------------------------------------- |
| `DISCORD_APPLICATION_ID` | Yes | | Application ID |
| `DISCORD_IPC_LOCATIONS` | No | | A commera-separated list of `host:port` network locations or file paths to unix socket for Discord |
| `DISCORD_ARTWORK` | No | | A boolean indicating if external artwork URLs should be used. Or a comma-separated list of allowed domains |
| `DISCORD_ARTWORK_DEFAULT_URL` | No | | A URL of an image to use as a fallback if the album art URL cannot be used. Or `false` to use discord's default. |
</Config>
@@ -0,0 +1,334 @@
---
title: Discord (Headless)
toc_min_heading_level: 2
toc_max_heading_level: 5
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import JsonConfig from '!!raw-loader!@site/../config/discord.json.example';
This scrobbler uses **[Now Playing](/configuration/clients#now-playing)** functionality to set your Discord [Rich Presence](https://docs.discord.com/developers/rich-presence/overview) to the music you are currently monitoring with multi-scrobbler.
<img src={require('/img/discord_presence_art.png').default} height="127"/>
This integration is **headless**, it does not depend on any specific Discord application to be running.
:::tip
Check the [main Discord docs page](/configuration/clients/discord) for a comparison between **App** and **Headless**.
:::
<DetailsAdmo type="note" summary="How MS Uses Discord API">
Multi-scrobbler does its upmost to implement, to-spec, [Gateway API communication](https://docs.discord.com/developers/events/gateway) and respect usage. It requires no [permissions](https://docs.discord.com/developers/events/gateway#gateway-intents) and reads no data other than monitoring what other user sessions are active.
Aside from the on-paper violation of using a user token programmatically (on your behalf), there is no misuse of the API to achieve rich presence.
Additionally, MS uses the state of non-MS sessions to conservatively update presence. [By default it will not conflict](#configure-when-presence-is-used) with any other official presence activities and is only used when you are actually active on a device.
</DetailsAdmo>
<DetailsAdmo type="note" summary="REQUIRED Interaction after Starting Multi-Scrobbler">
Every time multi-scrobbler is started a discord session update needs to be triggered so that [MS can capture the signals it uses to determine if presence can be updated.](#configure-when-presence-is-used) This only needs to be *once*, after starting multi-scrobbler. But it does need to be *every time* multi-scrobbler is (re)started. Without these signals MS will not update presence.
This session update can happen automatically after *some* time so you may not need to do anything. If you want to force the update then do one of the following:
* Open discord on a device it was not recently active on
* Exit discord on an active device
* Change your status (online, idle, etc...)
* Set a custom status
* Cause a presence update with a different app (listening to..., playing..., etc.)
</DetailsAdmo>
## Required Setup
### User Token
You must provide a **Discord User Token** for your account in order to authenticate with Discord.
<DetailsAdmo type="warning" summary="User Token usage violates Discord TOS">
This functionality requires you to use your own **Discord User Token** in a way that is **against Discord's policies/terms of service.** If you use this scrobbler you do so **at your risk**.
There is no precedent for Discord punishing users who use their own token for non-abuse/spam reasons but there is also no guarantee this lack of enforcement will continue.
Refer to the **How MS Uses Discord API** section above to gauge whether this risk is acceptable to you.
</DetailsAdmo>
<DetailsAdmo type="warning" summary="User Token is a Sensitive Credential">
Treat your User Token like a login credential. Anyone who has your token can access Discord as you.
When finding instructions for obtaining this token only run commands, or follow steps, that you can understand and trust. Do not run commands you do not understand. Never give your token to someone else.
</DetailsAdmo>
No instructions will be provided for obtaining a User Token because it is against Discord's policies to use it. Instead, you can search online for "how to obtain discord user token".
## Optional Setup
### Configure When Presence Is Used
MS uses several signals from your "real" Discord sessions to determine if it should update presence. The default configuration is conservative to ensure that MS does not conflict with other apps using presence. Additionally, it only updates if a "real" user device is active on discord.
:::tip[TLDR]
Without any additional configuration, MS will only update presence if:
* you have discord open on a real device
* your status is either: online, idle, or dnd (not invisible)
* no other apps are broadcasting listening activities (listening to spotify, etc...)
:::
#### Online Status
Configure if MS is allowed to update presence based on your online status. If this setting is not defined MS will only update if your status is **online**, **idle**, or **dnd**.
Allowed Values: `online` `idle` `dnd` `invisible`
<details>
<summary>Example</summary>
Only allow presence updating when all of your "real" sessions are either online or idle.
In File/AIO:
```json
[
{
"name": "MS",
"enable": true,
"data": {
"token": "Ma7XBvzRERK3gQdkX4dkb3OQ.6aaGmJ.rvFiiVrzG4VXHHL3LyhZYhpWdG3Ph_if9aKz5E",
"applicationId": "8190211179716453570",
"statusOverrideAllow": ["online", "idle"]
}
}
]
```
In ENV:
```
DISCORD_STATUS_OVERRIDE_ALLOW=online,idle
```
</details>
#### Other Listening Activities
Without any additional configuration, MS will not set Rich Presence if **other** apps are broadcasting **listening** activities EX "Listening to Spotify".
<details>
<summary>What about other activity types?</summary>
Discord uses an undocumented activity type priority to determine what activity is shown "first" for your profile. The Listening activity type has the *lowest priority*.
This means that if you start any other type of activity (streaming, watching, competing, etc...) it will take precedence over MS's listening activity.
Your listening activity will still be visible by clicking into your full profile.
</details>
Configure the names of **other** listening activities that MS **is allowed** to broadcast at the same time as.
<details>
<summary>Example</summary>
You want to allow MS to update presence even if Spotify is also broadcasting a listening activity.
In File/AIO:
```json
[
{
"name": "MS",
"enable": true,
"data": {
"token": "Ma7XBvzRERK3gQdkX4dkb3OQ.6aaGmJ.rvFiiVrzG4VXHHL3LyhZYhpWdG3Ph_if9aKz5E",
"applicationId": "8190211179716453570",
"listeningActivityAllow": ["spotify"]
}
}
]
```
In ENV:
```
DISCORD_LISTENING_ACTIVITY_ALLOW=spotify
```
</details>
### Discord Application
Creating a [Discord App](https://docs.discord.com/developers/quick-start/overview-of-apps) enables you to use custom album cover art and secondary status images for more links. Creating an App is free and simple, it is recommended you do this to get the most functionality from Rich Presence.
<details>
<summary>Create An Application</summary>
Go to the [Discord Developer Portal](https://discord.com/developers/applications)
* Click on "New Application" and give it a name
* Copy the **Application Id** (Client Id) shown after creation
* Add this Id to your Multi-Scrobbler config
* Env Config => `DISCORD_APPLICATION_ID=12345678`
* File Config => `"applicationId": "12345678"`
</details>
### Artwork
Multi-scrobbler can display Album Art in your Discord status. The image that is used differs based on if the image URL is publically accessible.
:::note
If no [**Application Id**](#discord-application) is configured the status art will **always** be the [Discord Default](./?artworkUrl=discord-default#artwork-url-types).
:::
The order in which multi-scrobbler determines what image to use is the same as the order of the tabs shown below.
#### Artwork URL Types
<Tabs groupId="artworkUrl" queryString>
<TabItem label="External URLs" value="external">
When [**Application Id**](#discord-application) **is** configured MS can use external URLs for artwork.
<img src={require('/img/discord_presence_art.png').default} height="127"/>
External URLs that are not from known music services are **disabled by default.** This is to preserve *your* privacy because Discord does not host images, it only links to them and the URL is visible to other users.
<details>
<summary>Why Should I Care?</summary>
There are some scenarios where you may not want your artwork URLs to be visible, for example:
* A Source may be accessible only on your LAN (Jellyfin at `http://192.168.0.101`)
* A Source may be internet-facing but you do not want to expose this information to discord/other users
* A Source may be internet-facing but requires authentication to view the image
</details>
MS will use your artwork URLs only if:
* artwork url is from a known music service/[Cover Art Archive](./?artworkUrl=caa#artwork-url-types) or
* artwork url starts with `https` and
* `artwork` (`DISCORD_ARTWORK`) is
* `true` => always uses the url
* a list of custom domains keywords an external artwork url should contain EX
* ENV => `DISCORD_ARTWORK=mycdn,jellyfin`
* File Config => `"artwork": ["mycdn","jellyfin"]`
<details>
<summary>Examples</summary>
None of the below URLs will **ever** be used because they are not `https`
```
http://foobar.com/cool.jpg <-- NOT allowed, not http
http://192.168.0.112/fun.png <-- NOT allowed, not http
```
When `DISCORD_ARTWORK` is not set:
```
https://archive.org/download/dir/myimage.jpg <-- allowed, is https and known service
https://spotify.com/assets/cover.png?size=1000 <-- allowed, is https and known service
https://example.com/cool.jpg <-- NOT allowed, is https but not a known service and DISCORD_ARTWORK is not set
https://anything.com/neat.jpg <-- NOT allowed, is https but not a known service and DISCORD_ARTWORK is not set
```
Setting `DISCORD_ARTWORK=true`
```
https://archive.org/my/dir/myimage.jpg <-- allowed, is https and known service
http://foobar.com/cool.jpg <-- NOT allowed, not http
https://example.com/cool.jpg <-- allowed, is https
https://anything.com/neat.jpg <-- allowed, is https
```
Setting `DISCORD_ARTWORK=mycdn,jellyfin`
```
https://archive.org/my/dir/myimage.jpg <-- allowed, is https and known service
http://foobar.com/cool.jpg <-- NOT allowed, not http
https://example.com/cool.jpg <-- NOT allowed, is https but does not contain "mycdn" or "jellyfin"
https://jellyfin.mydomain.com/neat.jpg <-- allowed, is https and contains "jellyfin"
```
</details>
</TabItem>
<TabItem label="Musicbrainz/Cover Art Achive" value="caa">
When [**Application Id**](#discord-application) **is** configured MS can try to use [Cover Art Archive](http://coverartarchive.org/) to get album art. The URL it retrieves is public which means it acts like an External URL that is always available for you.
<img src={require('/img/discord_presence_art.png').default} height="127"/>
MS will try to use Cover Art Archive if:
* The scrobble data does not contain an album art url (no art in dashboard) or the existing url has failed an [External URL](./?artworkUrl=external#artwork-url-types) condition
* and **the scrobble data contains a [Musicbrainz](/configuration/transforms/musicbrainz) Release (Album) MBID**
Basically, if MS would normally use the [MS Default](./?artworkUrl=ms-default#artwork-url-types) art, it will first try to use Cover Art Archive if the scrobble has a Release MBID.
Some Source, like [Jellyfin](/configuration/sources/jellyfin) and [Plex](/configuration/sources/plex), can automatically provide this ID if the music is "matched" in your library.
For all others, you can [**configure MS to use the Musicbrainz Stage**](/configuration/transforms/musicbrainz#use-metadata-for-discord-album-art) for Discord to try to get this MBID.
</TabItem>
<TabItem label="MS Default" value="ms-default">
When [**Application Id**](#discord-application) **is** configured and these conditions are true:
* Cannot use an [External URL](./?artworkUrl=external#artwork-url-types) and
* Cannot get album art from [Cover Art Archive](./?artworkUrl=caa#artwork-url-types) and
* Play does not contain artwork information (no artwork shown in dashboard)
The status artwork will use a default URL instead of your artwork URL.
Without any other configuration, the default URL is an icon from the [multi-scrobbler repository](https://github.com/FoxxMD/multi-scrobbler/blob/master/assets/default-artwork.png):
<img src={require('/img/discord_presence_ms_default.png').default} height="127"/>
This default image can be customized:
* ENV Config => `DISCORD_ARTWORK_DEFAULT_URL=https://cooldomain.com/art.png`
* File Config => `"artworkDefaultUrl": "https://cooldomain.com/art.png"`
Remember, this URL need to be accessible on the public internet.
</TabItem>
<TabItem label="Discord Default" value="discord-default">
When [**Application Id**](#discord-application) is **not** configured Discord will show its own image. No custom artwork can be used in this configuration.
This is also the image Discord will display if the artwork URL cannot be fetched.
<img src={require('/img/discord_presence_discord_default.png').default} height="127"/>
</TabItem>
</Tabs>
## Configuration
<Config config="DiscordClientConfig" fileContent={JsonConfig} client name="discord">
| Environmental Variable | Required? | Default | Description |
| :--------------------------------- | --------- | ----------------- | :---------------------------------------------------------------------------------------------------------------- |
| `DISCORD_TOKEN` | Yes | | User Token acquired from an active Discord sessions |
| `DISCORD_APPLICATION_ID` | No | | Application ID used to display album art |
| `DISCORD_ARTWORK` | No | | A boolean indicating if external artwork URLs should be used. Or a comma-separated list of allowed domains |
| `DISCORD_ARTWORK_DEFAULT_URL` | No | | A URL of an image to use as a fallback if the album art URL cannot be used. Or `false` to use discord's default. |
| `DISCORD_STATUS_OVERRIDE_ALLOW` | No | `online,idle,dnd` | A comma-separated list of statuses are allowed to have presence. |
| `DISCORD_LISTENING_ACTIVITY_ALLOW` | No | | A commera-seperated list of listening activity names MS **is allowed** to broadcast presence at the same time as. |
</Config>
@@ -0,0 +1,37 @@
---
sidebar_position: 2
title: Discord
toc_max_heading_level: 4
---
This scrobbler uses **[Now Playing](/configuration/clients#now-playing)** functionality to set your Discord [Rich Presence](https://docs.discord.com/developers/rich-presence/overview) to the music you are currently monitoring with multi-scrobbler.
<img src={require('/img/discord_presence_art.png').default} height="127"/>
There are two types of Discord integrations to choose from:
## App
The **App** integration uses an **existing** Discord application on a desktop computer to set Rich Presence.
* Uses "permitted" access to Discord, no TOS issues
* More restricted customization compared to Headless
* Only active when your existing Discord application is open
* For most scenarios it requires additional, OS-specific steps to setup correctly
* May require an additional program on your machine to relay the Discord connection
* This is potentially insecure, or less secure, then Headless
* **Can use [discord in a container](/configuration/clients/discord/discord-app#discord-connection) as an easy alternative**
* This is a Headless-like experience
[**App Docs**](/configuration/clients/discord/discord-app)
## Headless
The **Headless** integration uses Discord cloud Gateway/API, directly, to set Rich Presence.
* Does not require an existing Discord application (uses Discord cloud API)
* Using this **Violates Discord TOS** because it requires a user token
* More customization than App integration
* Active if **any** Discord application is online
[**Headless Docs**](/configuration/clients/discord/discord-headless)
+3 -3
View File
@@ -54,7 +54,7 @@ Ensure that Koito is configured to allow requests from multi-scrobbler! In Koito
<Config config="KoitoClientConfig" fileContent={JsonConfig} client name="koito">
| Environmental Variable | Required? | Default | Description |
| :--------------------- | --------- | ------- | --------------------------------- |
| KOITO_TOKEN | Yes | | API Key from your Koito Account |
| KOITO_USER | Yes | | Your Koito username |
| KOITO_URL | No | | The base URL for the Koito server |
| `KOITO_TOKEN` | Yes | | API Key from your Koito Account |
| `KOITO_USER` | Yes | | Your Koito username |
| `KOITO_URL` | No | | The base URL for the Koito server |
</Config>
+28 -6
View File
@@ -11,24 +11,46 @@ import JsonConfig from '!!raw-loader!@site/../config/lastfm.json.example';
:::tip[Other Users]
* To monitor and re-scrobble activity from your Last.fm account create a [Last.fm (Source)](/configuration/sources/lastfm-source)
* To monitor and re-scrobble activity from your Last.fm/Libre.fm account create a [Last.fm (Source)](/configuration/sources/lastfm-source)
* To accept scrobbles from outside applications as if multi-scrobbler was Last.fm, create a [Last.fm (Endpoint)](/configuration/sources/lastfm-endpoint)
:::
[Register for an API account here.](https://www.last.fm/api/account/create)
You will need a [Last.fm](https://www.last.fm) account to use the Last.fm API.
After creating your account, [register for an API account here.](https://www.last.fm/api/account/create)
The callback URL in the API account form is not used, but to keep it consistent use the same value you set using the [Callback/Redirect URL](#callbackredirect-url) section.
**Take note of your API Key and Secret after account creation.**
### Callback/Redirect URL
The Redirect (Callback) URL is used to redirect your **browser** to multi-scrobbler after authentication has completed.
So, the *base of the URL* you use should be the *same* as the URL you would use to navigate to the multi-scrobbler dashboard.
<details>
<summary>Example</summary>
If you can visit the multi-scrobbler dashboard by navigating to http://192.168.0.100:9078 in your web browser...
then the ENV `LASTFM_REDIRECT_URI`, or `redirectUri` for last.fm/libre.fm json config, should be
The Callback URL is actually specified by multi-scrobbler but to keep things consistent you should use
```
http://localhost:9078/lastfm/callback
http://192.168.0.100:9078/lastfm/callback
```
or replace `localhost:9078` with your own base URL.
</details>
The Redirect URL can be explicitly specified in the configuration below, or by using the global [Base URL](/configuration#base-url) setting.
## Configuration
<Config config="LastfmClientConfig" fileContent={JsonConfig} client name="lastfm">
| Environmental Variable | Required? | Default | Description |
|------------------------|-----------|-----------------------------------------|-------------------------------------------------------------------------------|
| ---------------------- | --------- | --------------------------------------- | ----------------------------------------------------------------------------- |
| `LASTFM_API_KEY` | Yes | | Api Key from your API Account |
| `LASTFM_SECRET` | Yes | | Shared secret from your API Account |
| `LASTFM_REDIRECT_URI` | No | `http://localhost:9078/lastfm/callback` | Url to use for authentication. Must include `lastfm/callback` somewhere in it |
@@ -0,0 +1,65 @@
---
title: Libre.fm
toc_min_heading_level: 2
toc_max_heading_level: 5
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';
import JsonConfig from '!!raw-loader!@site/../config/librefm.json.example';
:::tip[Other Users]
* To monitor and re-scrobble activity from your Libre.fm account create a [Libre.fm (Source)](/configuration/sources/librefm-source)
:::
To use the official [Libre.fm](https://libre.fm/) instance you will need an account. Or, you can run your own Libre.fm instance [using the legacy source code](https://github.com/foocorp/gnu-fm).
No API account, [API Key, or Secret](https://github.com/libre-fm/developer/wiki/Libre.fm-fundamentals#api-keys) is needed to use the Libre.fm API. Instead, use **any values** for API Key/Secret in the configuration. Authentication is done by allowing access from your account on redirect.
### Callback/Redirect URL
The Redirect (Callback) URL is used to redirect your **browser** to multi-scrobbler after authentication has completed.
So, the *base of the URL* you use should be the *same* as the URL you would use to navigate to the multi-scrobbler dashboard.
<details>
<summary>Example</summary>
If you can visit the multi-scrobbler dashboard by navigating to http://192.168.0.100:9078 in your web browser...
then the ENV `LIBREFM_REDIRECT_URI`, or `redirectUri` for libre.fm json config, should be
```
http://192.168.0.100:9078/librefm/callback
```
</details>
The Redirect URL can be explicitly specified in the configuration below, or by using the global [Base URL](/configuration#base-url) setting.
### Custom Libre.fm instance
If you are **not** using the official Libre.fm instance then specify your custom instance using ENV `LIBREFM_URLBASE` or `urlBase` property in the `data` section in File/AIO config.
The value should be `protocol://libre.tld/path/prefix` EX:
```
https://my.cool.libre.com/2.0/
```
## Configuration
<Config config="LibrefmClientConfig" fileContent={JsonConfig} client name="librefm">
| Environmental Variable | Required? | Default | Description |
| ---------------------- | --------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `LIBREFM_ENABLE` | No | | Set to `true` to enable Libre.fm, if not using any of the below variables |
| `LIBREFM_API_KEY` | No | `anything` | Optional API Key |
| `LIBREFM_SECRET` | No | `anything` | Optional shared secret |
| `LIBREFM_REDIRECT_URI` | No | `http://localhost:9078/librefm/callback` | Url to use for authentication. Must include `librefm/callback` somewhere in it |
| `LIBREFM_SESSION` | No | | Session id. Will be generated by authentication flow if not provided. |
| `LIBREFM_URLBASE` | No | | Use for custom Libre.fm instance only. The host + path prefix EX `https://my.libre.example/2.0/` |
</Config>
@@ -22,10 +22,10 @@ On your [profile page](https://listenbrainz.org/profile/) find your **User Token
## Configuration
<Config config="ListenbrainzClientConfig" fileContent={JsonConfig} client name="listenbrainz">
| Environmental Variable | Required? | Default | Description |
|------------------------|-----------|-------------------------------|---------------------------------|
| LZ_TOKEN | Yes | | User token from your LZ profile |
| LZ_USER | Yes | | Your LZ username |
| LZ_URL | No | https://api.listenbrainz.org/ | The base URL for the LZ server |
<Config config="ListenBrainzClientConfig" fileContent={JsonConfig} client name="listenbrainz">
| Environmental Variable | Required? | Default | Description |
| ---------------------- | --------- | ----------------------------- | ------------------------------- |
| `LZ_TOKEN` | Yes | | User token from your LZ profile |
| `LZ_USER` | Yes | | Your LZ username |
| `LZ_URL` | No | https://api.listenbrainz.org/ | The base URL for the LZ server |
</Config>
@@ -23,13 +23,13 @@ To monitor and re-scrobble activity **from** Rocksky create a [Rocksky (Source)]
</details>
:::warning[Public Data]
<DetailsAdmo type="warning" summary="Your Data Is Public">
The default Bluesky PDS is **public**, meaning your scrobbles are also public (read-only). This isn't any different than using Last.fm or Listenbrainz, in terms of privacy.
:::
</DetailsAdmo>
:::warning[No Scrobbling Guarantee]
<DetailsAdmo type="warning" summary="No Scrobbling Guarantee">
Rocksky **does not guarantee** that every scrobble you send will be persisted. Rocksky's design goal is to store scrobbles with **metdata-complete, 3rd party verifiable track information** so that it can be a metadata-rich discovery platform, rather than an exhaustive scrobble data source-of-truth.
@@ -37,7 +37,7 @@ To do this it *asynchronously* matches your scrobble data against Musicbrainz's
If you need your scrobbles to be 100% captured then you should scrobble to an *additional* [Scrobble Client](/configuration/clients).
:::
</DetailsAdmo>
## Setup
@@ -64,9 +64,9 @@ The handle used with multi-scrobbler should be your **full** ATProto handle, inc
If you do not include a TLD then multi-scrobbler will automatically append `.bsky.social` to your handle value.
<Config config="RockskyClientConfig" fileContent={JsonConfig} client name="rocksky">
<Config config="RockSkyClientConfig" fileContent={JsonConfig} client name="rocksky">
| Environmental Variable | Required? | Default | Description |
| :--------------------- | --------- | ------- | ----------------------------------------------------------------------------------- |
| ROCKSKY_HANDLE | Yes | | Your **full** ATProto handle. For Bluesky account this is like `myUser.bsky.social` |
| ROCKSKY_KEY | Yes | | API Key obtained from Rocksky developer dashboard |
| `ROCKSKY_HANDLE` | Yes | | Your **full** ATProto handle. For Bluesky account this is like `myUser.bsky.social` |
| `ROCKSKY_KEY` | Yes | | API Key obtained from Rocksky developer dashboard |
</Config>
+13 -13
View File
@@ -26,23 +26,23 @@ To monitor and re-scrobble activity from a ATProto Profile create a [teal.fm (So
</details>
:::warning
<DetailsAdmo type="warning" summary="Your Data Is Public">
The default Bluesky PDS is **public**, meaning your scrobbles are also public (read-only). This isn't any different than using Last.fm or Listenbrainz, in terms of privacy.
:::
</DetailsAdmo>
:::note
<DetailsAdmo type="note" summary="teal.fm Is Still In Development">
[teal.fm is still in developement](https://notes.teal.fm/3lzlwe6puis2l) and does not have a public website, yet.
[teal.fm is still in developement](https://notes.teal.fm/3lzlwe6puis2l) and does not have a true production website, yet.
To view your teal.fm scrobbles you can:
To view your teal.fm scrobble data you can:
* use [wrapped.baileytownsend.dev](https://wrapped.baileytownsend.dev/) which gives a simple stats overview of your scrobbles
* use [teal-slice.wisp.place](https://tealfm-slice.wisp.place/) for a preview of teal.fm
* use [atproto.at](https://atproto.at) to view the raw data (convenience URLs are generated in multi-scrobbler for you to do this)
* use [teal-relay-production.up.railway.app](https://teal-relay-production.up.railway.app) or [teal-slice.wisp.place](https://tealfm-slice.wisp.place/) for a preview of teal.fm
* use [yearinmusic.teal.fm](https://yearinmusic.teal.fm) or [wrapped.baileytownsend.dev](https://wrapped.baileytownsend.dev/) for wrapped-style stats of your teal.fm scrobbles
* use [atproto.at](https://atproto.at) to view the raw data (convenience URLs are generated in multi-scrobbler, per scrobble, for you to do this)
:::
</DetailsAdmo>
## Setup
@@ -71,8 +71,8 @@ If using a handle:
If your identifier does not look like a DID and does not include a TLD then multi-scrobbler will automatically append `.bsky.social` to your handle value.
<Config config="TealClientConfig" fileContent={JsonConfig} client name="tealfm">
| Environmental Variable | Required? | Default | Description |
| :--------------------- | --------- | ------- | ----------------------------------------------------------------------------------- |
| TEALFM_IDENTIFIER | Yes | | Your **full** ATProto handle or DID. For Bluesky account this is like `myUser.bsky.social` |
| TEALFM_APP_PW | Yes | | Bluesky/ATProto network App Password |
| Environmental Variable | Required? | Default | Description |
| :--------------------- | --------- | ------- | ------------------------------------------------------------------------------------------ |
| `TEALFM_IDENTIFIER` | Yes | | Your **full** ATProto handle or DID. For Bluesky account this is like `myUser.bsky.social` |
| `TEALFM_APP_PW` | Yes | | Bluesky/ATProto network App Password |
</Config>
+112 -7
View File
@@ -166,6 +166,84 @@ See the [Configuration Types](#configuration-types) above for your options for c
Each entry for a Source/Client includes a **Configuration** section that describes how to configure it using a [configuration type](#configuration-types).
## Secrets Interpolation
When using [File](./?configType=file#configuration-types) or [AIO](./?configType=aio#configuration-types) Configuration, Multi-Scrobbler can interpolate Environmental Variables into your json files. This can be used, for example, to keep sensitive data (like [Last.fm Client/Secret](/configuration/clients/lastfm#configuration)) out of your configuration files so that they can be committed to git.
Multi-scrobbler will look for patterns in text fields within _all_ of your json files:
* Some part of the text field matches: `[[MY_ENV]]`
* Is replaced by the value of the Environmental Variable named `MY_ENV`
<details>
<summary>Example</summary>
Given this [Last.fm](/configuration/clients/lastfm#configuration) [File](./?configType=file#configuration-types) config:
```json title="lastfm.json"
[
{
"name": "myLastFmClient",
"configureAs": "client",
"data": {
"apiKey": "[[MY_APIKEY]]",
"secret": "[[MY_SECRET]]",
"redirectUri": "http://localhost:9078/lastfm/callback"
}
}
]
```
And these environmental variables, in this scenario set through `environment` in the [docker compose installation](/quickstart#create-docker-compose-file):
```
MY_APIKEY=a89cba1569901a0671d5a9875fed4be1
MY_SECRET=ec42e09d5ae0ee0f0816ca151008412a
```
The resulting json multi-scrobbler would use:
```json title="lastfm.json"
[
{
"name": "myLastFmClient",
"configureAs": "client",
"data": {
"apiKey": "a89cba1569901a0671d5a9875fed4be1",
"secret": "ec42e09d5ae0ee0f0816ca151008412a",
"redirectUri": "http://localhost:9078/lastfm/callback"
}
}
]
```
</details>
<DetailsAdmo type="note" summary="Caveats">
* ENV variable names/interpolation keys are case-insensitive
* Interpolation only works for **string** values within json. This cannot be used for numbers, booleans, objects, etc...
</DetailsAdmo>
<DetailsAdmo type="warning" summary="Missing ENVs">
Multi-scrobbler **will not** throw an error if the environmental value is not found. Instead, it will leave the string as-is and log a warning (`WARN` level) with the names of the missing environmental variable names like so:
```
WARN : [App] [Sources] [spotify Secrets] Matched: None | Unmatched: SPOTIFY_SECRET
```
</DetailsAdmo>
<DetailsAdmo type="warning" summary="ENV Name Collisions">
**Verify that interpolation keys/environmental variable names you will use do not collide with existing ENV names used by multi-scrobbler.** Use the docs search to verify the name you want to use is not already used elsewhere by multi-scrobbler.
</DetailsAdmo>
## Application Options
These options affect multi-scrobbler's behavior and are not specific to any source/client.
@@ -404,6 +482,8 @@ volumes:
// highlight-end
```
Use `redis://valkey:6379` as the connection string in the configurations below.
</details>
The connection string used by multi-scrobbler to connect to your Valkey instance must be in the form:
@@ -475,7 +555,7 @@ If you do not need the dashboard and/or ingress sources, or have security concer
:::warning
Any **[ingress-based sources](/configuration/sources#ingress) will be unusable** (Webscrobbler, etc...) if this is disabled.
Any **[ingress-based sources](/configuration/sources?sourceComm=ingress#by-communication-method) will be unusable** (Webscrobbler, etc...) if this is disabled.
:::
@@ -486,7 +566,19 @@ Disable using either:
## Monitoring
Multi-scrobbler supports some common webhooks and a healthcheck endpoint in order to monitor Sources and Clients for errors.
### Upstream Services Status
A status page for monitoring the reachability of public services used by some Sources/Clients is available at
**https://status.multi-scrobbler.app**
This monitor runs on a VPS and checks the uptime of *actual* APIs for these services, not just landing pages. On a ~minute interval it checks:
* Listenbrainz API
* Musicbrainz API
* CoverArtArchive API
* Last.fm API
* A few MS-hosted support services
### Webhook Configurations
@@ -614,11 +706,24 @@ multi-scrobbler supports [stateless](https://github.com/caronc/apprise-api?tab=r
### Health Endpoint
An endpoint for monitoring the health of sources/clients is available at GET `http://YourMultiScrobblerDomain/health`
An endpoint for monitoring the health of sources/clients is available at GET `http://YourMultiScrobblerDomain/api/health`
* Returns `200 OK` when **everything** is working or `500 Internal Server Error` if **anything** is not
* The plain url (`/health`) aggregates status of **all clients/sources** -- so any failing client/source will make status return 500
* Use query params `type` or `name` to restrict client/sources aggregated IE `/health?type=spotify` or `/health?name=MyMaloja`
* The plain url (`/api/health`) aggregates status of **all clients/sources** -- so any failing client/source will make status return 500
* Use query params `type` or `name` to restrict client/sources aggregated IE `/api/health?type=spotify` or `/api/health?name=MyMaloja`
* On 500 the response returns a JSON payload with `messages` array that describes any issues
* For any clients/sources that require authentication `/health` will return 500 if they are **not authenticated**
* For sources that poll (spotify, yt music, subsonic) `/health` will 500 if they are **not polling**
* For any clients/sources that require authentication `/api/health` will return 500 if they are **not authenticated**
* For sources that poll (spotify, yt music, subsonic) `/api/health` will 500 if they are **not polling**
### Prometheus
A [Prometheus](https://prometheus.io/) export endpoint is available at GET `http://YourMultiScrobblerDomain/api/metrics`
It includes metrics for:
* Count of discovered plays per [Source](/configuration/sources)
* Count of Queued/Scrobbled/Deadletter scrobbles per [Client](/configuration/clients)
* Number of issues per Source/Client
* If any of these metrics is > 0 it means your Source/Client is not operating normally
Additionally, general process metrics like cpu and memory usage can be enabled with the env `PROMETHEUS_FULL=true`
+2 -2
View File
@@ -11,13 +11,13 @@ Scenario:
* Each person has their own [Maloja](/configuration/clients/maloja) server
* Each person has their own Spotify account
* You have your own Airsonic ([subsonic](/configuration/sources/subsonic)) server you to scrobble from
* You have your own [Youtube Music](/configuration/soures/youtube-mysic) account you want to scrobble from
* You have your own [Youtube Music](/configuration/sources/youtube-music) account you want to scrobble from
* Mary has her own [Last.fm](/configuration/clients/lastfm) account she also wants to scrobble to
* Fred has his own [Spotify](/configuration/sources/spotify) application and provides you with just his access and refresh token because he doesn't trust you (wtf Fred)
* Fred has a Plex server and wants to scrobble everything he plays
* Mary uses Fred's Plex server but only wants to scrobble her plays from the `podcast` library
* The three of you have a shared library on [Plex](/configuration/sources/plex) called `party` that you only play when you are hanging out. You want plays from that library to be scrobbled to everyone's servers.
* Fred also has his own [Jellyfin server](/configurion/sources/jellyfin) and wants to scrobble everything he plays
* Fred also has his own [Jellyfin server](/configuration/sources/jellyfin) and wants to scrobble everything he plays
* You have an android music app that can scrobble to a [custom listenbrainz server](/configuration/sources/listenbrainz-endpoint)
### All-in-one Config
@@ -8,7 +8,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';
import AzuracastConfig from '!!raw-loader!@site/../config/azuracast.json.example';
import ShouldScrobble from "@site/src/components/snippets/_should-scrobble.mdx"
import ShouldScrobble from "@site/src/components/snippets/_should-scrobble-details.mdx"
:::tip[Scrobbling Threshold]
@@ -36,14 +36,8 @@ URL From Config => MS Uses
'wss://mydomain.com/custom/azura/ws' => wss://mydomain.com/custom/azura/ws
```
#### Scrobble Behavior
:::info
<ShouldScrobble filename="azuracast"/>
:::
Multi-scrobbler will set the default **scrobbling behavior** based on if either of these settings is configured:
* live status (`AZURA_LIVE` or `monitorWhenLive`) or
@@ -55,28 +49,11 @@ If neither is configured automatic scrobble defaults to **off** and you should e
## Configuration
<Tabs groupId="configType" queryString>
<TabItem value="env" label="ENV">
<Config config="AzuracastSourceConfig" fileContent={AzuracastConfig} name="azuracast">
| Environmental Variable | Required? | Default | Description |
| :--------------------- | :-------- | :------ | ---------------------------------------------------------------------------------------------- |
| `AZ_URL` | Yes | | Azuracast URL *without station name* |
| `AZ_STATION` | Yes | | The station name shown on the public page |
| `AZURA_LIVE` | No | Yes | Only scrobble when station status is ONLINE |
| `AZURA_LISTENERS_NUM` | No | `true` | Only scrobble if station has any listeners (`true`) or listeners are equal-to/greater-than `X` |
</TabItem>
<TabItem value="file" label="File">
<CodeBlock title="CONFIG_DIR/azuracast.json" language="json5">{AzuracastConfig}</CodeBlock>
or <SchemaLink lower objectName="AzuracastSourceConfig"/>
</TabItem>
<TabItem value="aio" label="AIO">
<AIOExample data={AzuracastConfig} name="azuracast"/>
or <SchemaLink lower objectName="AzuracastSourceConfig"/>
</TabItem>
</Tabs>
</Config>
+70 -22
View File
@@ -44,28 +44,6 @@ import DeezerDeprecatedConfig from '!!raw-loader!@site/../config/deezer-deprecat
</TabItem>
</Tabs>
## Configuration
<Tabs groupId="configType" queryString>
<TabItem value="env" label="ENV">
| Environmental Variable | Required? | Default | Description |
| :--------------------- | --------- | ------- | ------------------------------------------------ |
| `DEEZER_ARL` | Yes | | The ARL cookie value retrieved from your browser |
</TabItem>
<TabItem value="file" label="File">
<CodeBlock title="CONFIG_DIR/deezer.json" language="json5">{DeezerConfig}</CodeBlock>
or <SchemaLink lower objectName="DeezerSourceConfig"/>
</TabItem>
<TabItem value="aio" label="AIO">
<AIOExample data={DeezerConfig} name="deezer"/>
or <SchemaLink lower objectName="DeezerSourceConfig"/>
</TabItem>
</Tabs>
### Duplicate detection
Third party integrations with Deezer (Sonos) may cause Deezer to [report the same track many times in listening history.](https://github.com/FoxxMD/multi-scrobbler/pull/296#issuecomment-2922374738) If you experience this issue modify your Deezer Source config (file-based only) to include the option `"fuzzyDiscoveryIgnore": "aggressive"`
@@ -91,6 +69,76 @@ import DeezerDeprecatedConfig from '!!raw-loader!@site/../config/deezer-deprecat
This option comes with some trade-offs: MS will aggressively detect repeated tracks within a window of time that should eliminate all duplicates. However, this will also prevent *intentionally* repeated tracks from being scrobbled. See [this thread](https://github.com/FoxxMD/multi-scrobbler/pull/296#issuecomment-2970417070) for more information on how this works.
### Family account
Multi-scrobbler can monitor listening history for accounts linked to a [Deezer Family Account](https://www.deezer.com/en/offers/family).
<details>
<summary>Instructions</summary>
Start multi-scrobbler using the [ARL](#retrieve-arl) for the **main account**.
In the logs look for **Linked Accounts** associated with the Deezer Source. It will look something like this:
```
VERBOSE: [App] [Sources] [Deezer - MyDeezer] Linked Accounts:
Name: Joe | ID: 166276334 | Private?: Yes
Name: Mary | ID: 48475231 | Private?: Yes
Name: FoxxMD | ID: 896225281 | Private?: No
Name: Cool Guy | ID: 128522478 | Private?: Yes
```
The Account **ID** you want to monitor should be set:
<Tabs groupId="configType" queryString>
<TabItem value="env" label="ENV">
Set in your docker compose `environment` section:
```yaml
- DEEZER_ACCOUNT_ID=896225281
```
</TabItem>
<TabItem value="file" label="File or AIO">
Add an `accountId` property to the `data` section
```json
[
{
"name": "DeezerARL",
"enable": true,
"clients": [],
"data": {
"arl": "UOsRPjT3U5Dhaaup3xQ30D...",
"accountId": "896225281"
}
}
]
```
</TabItem>
</Tabs>
Restart multi-scrobbler to start monitoring that account.
:::warning[Restrictions]
Deezer may not return the correct listening history under these circumstances:
* The ARL used is **not** for the main account
* If you can get an ARL specifically for the linked account (login as the linked account), use that **instead** of family `accountId`
* The ARL account is private
* The linked account to be monitored ( using `accountId`) is private
:::
</details>
## Configuration
<Config config="DeezerCompatConfig" fileContent={DeezerConfig} name="deezer">
| Environmental Variable | Required? | Default | Description |
| :--------------------- | --------- | ------- | ------------------------------------------------ |
| `DEEZER_ARL` | Yes | | The ARL cookie value retrieved from your browser |
</Config>
</TabItem>
<TabItem value="official" label="Official API">
@@ -144,8 +144,7 @@ To diagnose bad/incomplete track information or strange MS player behavior pleas
## Configuration
<Tabs groupId="configType" queryString>
<TabItem value="env" label="ENV">
<Config config="ChromecastSourceConfig" fileContent={ChromecastConfig} name="chromecast">
:::note
[Manually configuring cast device connections](#connecting-devices) is only available through file-based config.
:::
@@ -157,28 +156,4 @@ To diagnose bad/incomplete track information or strange MS player behavior pleas
| CC_BLACKLIST_DEVICES | No | | Do not scrobble from these Cast devices. Comma-delimited list |
| CC_WHITELIST_APPS | No | | Only scrobble from these casted Apps. Comma-delimited list. EX spotify, pandora |
| CC_BLACKLIST_APPS | No | | Do not scrobble from these casted Apps. Comma-delimited list |
</TabItem>
<TabItem value="file" label="File">
<details>
<summary>Example</summary>
<CodeBlock title="CONFIG_DIR/chromecast.json" language="json5">{ChromecastConfig}</CodeBlock>
</details>
or <SchemaLink lower objectName="ChromecastSourceConfig"/>
</TabItem>
<TabItem value="aio" label="AIO">
<details>
<summary>Example</summary>
<AIOExample data={ChromecastConfig} name="chromecast"/>
</details>
or <SchemaLink lower objectName="ChromecastSourceConfig"/>
</TabItem>
</Tabs>
</Config>
+5 -33
View File
@@ -8,7 +8,7 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';
import IcecastConfig from '!!raw-loader!@site/../config/icecast.json.example';
import ShouldScrobble from "@site/src/components/snippets/_should-scrobble.mdx"
import ShouldScrobble from "@site/src/components/snippets/_should-scrobble-details.mdx"
Parse metadata from any Icecast Station (streams) to use for scrobbling.
@@ -20,13 +20,9 @@ Multi-scrobbler will do its best to parse Artist/Album/Track information from th
:::
:::note[Scrobbling Behavior]
Multi-scrobbler cannot automatically determine if you are listening to a Station. Therefore, **automatic scrobbling for Icecast Sources is off by default.** Use **Should Scrobble Behavior** to initiate scrobbling or configure automatic scrobble.
Multi-scrobbler cannot automatically determine if you are listening to a Station. Therefore, **automatic scrobbling for Icecast Sources is off by default.**
Use [Should Scrobble Behavior](/configuration/sources#should-scrobble-behavior) to initiate scrobbling or configure automatic scrobble.
:::
<ShouldScrobble filename="icecast"/>
:::tip[Scrobbling Threshold]
@@ -66,32 +62,8 @@ If no `sources` are configured for multi-scrobbler it will automatically try to
## Configuration
<Tabs groupId="configType" queryString>
<TabItem value="env" label="ENV">
<Config config="IcecastSourceConfig" fileContent={IcecastConfig} name="icecast">
| Environmental Variable | Required? | Default | Description |
| :--------------------- | :-------- | :------ | ----------- |
| `ICECAST_URL` | Yes | | Icecast URL |
</TabItem>
<TabItem value="file" label="File">
<details>
<summary>Example</summary>
<CodeBlock title="CONFIG_DIR/icecast.json" language="json5">{IcecastConfig}</CodeBlock>
</details>
or <SchemaLink lower objectName="IcecastSourceConfig"/>
</TabItem>
<TabItem value="aio" label="AIO">
<details>
<summary>Example</summary>
<AIOExample data={IcecastConfig} name="icecast"/>
</details>
or <SchemaLink lower objectName="IcecastSourceConfig"/>
</TabItem>
</Tabs>
</Config>
+37 -35
View File
@@ -19,7 +19,7 @@ Must be using Jellyfin 10.7 or greater
It is **recommended** to use API Key + username but if you are not an admin for your Jellyfin instance you can also authenticate with your Jellyfin username and **password.**
:::tip[Important Defaults]
<DetailsAdmo type="tip" summary="Important Defaults">
By default...
@@ -27,41 +27,43 @@ By default...
* Allowed Users (`usersAllow` or `JELLYFIN_USERS_ALLOW`) are only necessary if you want to scrobble for additional users.
* multi-scrobbler will **only** scrobble media found in Jellyfin libraries that were labelled as **Music.**
* `librariesAllow` or `JELLYFIN_LIBRARIES_ALLOW` will override this
* OR use `additionalAllowedLibraryTypes` to allow more types (like `mixed` or `book` for audiobooks)
* multi-scrobbler will **only** scrobble media Jellyfin detects as **Audio.**
* To force multi-scrobbler to scrobble when media is detected as **Unknown** use `"allowUnknown": true` in file/aio configuration.
* OR use `additionalAllowedLibraryTypes` to allow more *library* types (like those labelled as `mixed` or `book` for audiobooks)
* multi-scrobbler will **only** scrobble media Jellyfin detects as **Audio**.
* To allow other media types to be scrobbled set `allowMediaTypes` or `JELLYFIN_MEDIATYPES_ALLOW` with a list of [official types](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/master/src/generated-client/models/media-type.ts#L22).
* One or more of: `Unknown`, `Video`, `Audio`, `Photo`, `Book`
* If you use this setting **you must explicitly specify `Audio`**, it will no longer be provided as a default
:::
</DetailsAdmo>
<DetailsAdmo type="tip" summary="External Asset URL">
If you use MS and Jellyfin on an internal or otherwise inaccessible network but still want album art assets used in the UI or for [Discord](/config/clients/discord) to be accessible you can specify a URL to replace your internal url.
Use (file) `frontendUrlOverride` or (env) `JELLYFIN_FRONTEND_URL_OVERRIDE` to replace `url`/`JELLYFIN_URL`, respectively, when rendering links for the dashboard UI or other resources.
Example:
Your `JELLYFIN_URL` is `http://jellyfin:8096` but your Jellyfin instance is externally accessible (by MS or in general) at `https://jellyfin.mydomain.com`.
Use `JELLYFIN_FRONTEND_URL_OVERRIDE=https://jellyfin.mydomain.com` in order for the MS dashboard to use `https://jellyfin.mydomain.com/art/1234.jpg` when linking to album art.
</DetailsAdmo>
#### Configuration
<Tabs groupId="configType" queryString>
<TabItem value="env" label="ENV">
| Environmental Variable | Required? | Default | Description |
| -------------------------- | --------- | ------- | ------------------------------------------------------------------------------------------ |
| `JELLYFIN_URL` | **Yes** | | The URL of the Jellyfin server IE `http://localhost:8096` |
| `JELLYFIN_USER` | **Yes** | | The user to authenticate with the API |
| `JELLYFIN_APIKEY` | No | | The API Key to use for authentication **(Must provide either apikey or password)** |
| `JELLYFIN_PASSWORD` | No | | The password of the user to authenticate for. **(Must provide either apikey or password)** |
| `JELLYFIN_USERS_ALLOW` | No | | Comma-separated list of usernames (from Jellyfin) to scrobble for |
| `JELLYFIN_USERS_BLOCK` | No | | Comma-separated list of usernames (from Jellyfin) to disallow scrobble for |
| `JELLYFIN_DEVICES_ALLOW` | No | | Comma-separated list of devices to scrobble from |
| `JELLYFIN_DEVICES_BLOCK` | No | | Comma-separated list of devices to disallow scrobbles from |
| `JELLYFIN_LIBRARIES_ALLOW` | No | | Comma-separated list of libraries to allow scrobbles from |
| `JELLYFIN_LIBRARIES_BLOCK` | No | | Comma-separated list of libraries to disallow scrobbles from |
</TabItem>
<TabItem value="file" label="File">
<CodeBlock title="CONFIG_DIR/jellyfin.json" language="json5">{JellyfinConfig}</CodeBlock>
or <SchemaLink lower objectName="JellyApiSourceConfig"/>
</TabItem>
<TabItem value="aio" label="AIO">
<AIOExample data={JellyfinConfig} name="jellyfin"/>
or <SchemaLink lower objectName="JellyApiSourceConfig"/>
</TabItem>
</Tabs>
<Config config="JellyApiSourceConfig" fileContent={JellyfinConfig} name="jellyfin">
| Environmental Variable | Required? | Default | Description |
| -------------------------------- | --------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `JELLYFIN_URL` | **Yes** | | The URL of the Jellyfin server IE `http://localhost:8096` |
| `JELLYFIN_USER` | **Yes** | | The user to authenticate with the API |
| `JELLYFIN_APIKEY` | No | | The API Key to use for authentication **(Must provide either apikey or password)** |
| `JELLYFIN_PASSWORD` | No | | The password of the user to authenticate for. **(Must provide either apikey or password)** |
| `JELLYFIN_USERS_ALLOW` | No | | Comma-separated list of usernames (from Jellyfin) to scrobble for |
| `JELLYFIN_USERS_BLOCK` | No | | Comma-separated list of usernames (from Jellyfin) to disallow scrobble for |
| `JELLYFIN_DEVICES_ALLOW` | No | | Comma-separated list of devices to scrobble from |
| `JELLYFIN_DEVICES_BLOCK` | No | | Comma-separated list of devices to disallow scrobbles from |
| `JELLYFIN_LIBRARIES_ALLOW` | No | | Comma-separated list of libraries to allow scrobbles from |
| `JELLYFIN_LIBRARIES_BLOCK` | No | | Comma-separated list of libraries to disallow scrobbles from |
| `JELLYFIN_MEDIATYPES_ALLOW` | No | | Comma-separated list of [media types](https://github.com/jellyfin/jellyfin-sdk-typescript/blob/master/src/generated-client/models/media-type.ts#L22) to allow scrobbling. Defaults to `audio` |
| `JELLYFIN_FRONTEND_URL_OVERRIDE` | No | | The external URL to use for album art assets instead of `JELLYFIN_URL` |
</Config>
+2 -20
View File
@@ -49,28 +49,10 @@ If any part of this URL is missing multi-scrobbler will use a default value. Thi
## Configuration
<Tabs groupId="configType" queryString>
<TabItem value="env" label="ENV">
<EnvType>
<Config config="JRiverSourceConfig" fileContent={JriverConfig} name="jriver">
| Environmental Variable | Required | Default | Description |
|------------------------|----------|---------------------------------|------------------------------------------------|
| JRIVER_URL | Yes | http://localhost:52199/MCWS/v1/ | The URL of the JRiver server |
| JRIVER_USERNAME | No | | If authentication is enabled, the username set |
| JRIVER_PASSWORD | No | | If authenticated is enabled, the password set |
</EnvType>
</TabItem>
<TabItem value="file" label="File">
<FileType>
<CodeBlock title="CONFIG_DIR/jriver.json" language="json5">{JriverConfig}</CodeBlock>
or <SchemaLink lower objectName="JRiverSourceConfig"/>
</FileType>
</TabItem>
<TabItem value="aio" label="AIO">
<AIOType>
<AIOExample data={JriverConfig} name="jriver"/>
or <SchemaLink lower objectName="JRiverSourceConfig"/>
</AIOType>
</TabItem>
</Tabs>
</Config>
@@ -19,13 +19,14 @@ To _scrobble to_ a Koito server, create a [Koito (Client)](/configuration/clien
See the [Koito (Client)](/configuration/clients/koito) configuration for general setup. The only difference for **Source** configuration:
* Cannot be setup with ENV config
* [File/AIO config](/configuration?configType=file#configuration-types) must include `"configureAs": "source"`
#### Configuration
<Config config="KoitoSourceConfig" fileContent={KoitoConfig} name="koito">
:::note
You cannot use ENV variables shown in the [Koito Client config](/configuration/clients/koito) -- multi-scrobbler assumes Koito ENVs are always used for the **client** configuration. You must use the [File or AIO](/configuration?configType=file#configuration-types) config to setup Koito as a Source.
:::
| Environmental Variable | Required? | Default | Description |
| :--------------------- | --------- | ------- | --------------------------------- |
| `SOURCE_KOITO_TOKEN` | Yes | | API Key from your Koito Account |
| `SOURCE_KOITO_USER` | Yes | | Your Koito username |
| `SOURCE_KOITO_URL` | No | | The base URL for the Koito server |
</Config>
@@ -1,5 +1,5 @@
---
title: Lastfm
title: Last.fm
toc_min_heading_level: 2
toc_max_heading_level: 5
---
@@ -13,7 +13,7 @@ This Source **monitors your Last.fm scrobble history** and re-scrobbles new acti
:::tip[Other Uses]
* To **scrobble to** Last.fm, create a [Last.fm (Client)](/configuration/clients/lastfm)
* To **scrobble to** Last.fm/Libre.fm, create a [Last.fm (Client)](/configuration/clients/lastfm)
* To accept scrobbles from outside applications as if multi-scrobbler was Last.fm, create a [Last.fm (Endpoint)](/configuration/sources/lastfm-endpoint)
:::
@@ -23,7 +23,10 @@ To configure this Source use the same registration instructions and configuratio
## Configuration
<Config config="LastfmSourceConfig" fileContent={LastfmConfig} name="lastfm">
:::note
You cannot use ENV variables shown in the [Last.fm Client config](/configuration/clients/lastfm) -- multi-scrobbler assumes Last.fm ENVs are always used for the **client** configuration. You must use the [File or AIO](/configuration?configType=file#configuration-types) config to setup Last.fm as a Source.
:::
| Environmental Variable | Required? | Default | Description |
| ---------------------------- | --------- | --------------------------------------- | ----------------------------------------------------------------------------- |
| `SOURCE_LASTFM_API_KEY` | Yes | | Api Key from your API Account |
| `SOURCE_LASTFM_SECRET` | Yes | | Shared secret from your API Account |
| `SOURCE_LASTFM_REDIRECT_URI` | No | `http://localhost:9078/lastfm/callback` | Url to use for authentication. Must include `lastfm/callback` somewhere in it |
| `SOURCE_LASTFM_SESSION` | No | | Session id. Will be generated by authentication flow if not provided. |
</Config>
@@ -0,0 +1,33 @@
---
title: Libre.fm
toc_min_heading_level: 2
toc_max_heading_level: 5
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';
import JsonConfig from '!!raw-loader!@site/../config/librefm.json.example';
This Source **monitors your Libre.fm scrobble history** and re-scrobbles new activity to configured [Clients.](/configuration/clients)
:::tip[Other Uses]
* To **scrobble to** Libre.fm, create a [Libre.fm (Client)](/configuration/clients/librefm)
:::
To configure this Source use the same registration instructions and configuration data shown in [Libre.fm (Client)](/configuration/clients/librefm) with the difference being `"configureAs": "source"` defined in the File/AIO configuration below.
## Configuration
<Config config="LibrefmSourceConfig" fileContent={JsonConfig} name="librefm">
| Environmental Variable | Required? | Default | Description |
| ----------------------------- | --------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `SOURCE_LIBREFM_ENABLE` | No | | Set to `true` to enable Libre.fm, if not using any of the below variables |
| `SOURCE_LIBREFM_API_KEY` | No | `anything` | Optional API Key |
| `SOURCE_LIBREFM_SECRET` | No | `anything` | Optional shared secret |
| `SOURCE_LIBREFM_REDIRECT_URI` | No | `http://localhost:9078/librefm/callback` | Url to use for authentication. Must include `librefm/callback` somewhere in it |
| `SOURCE_LIBREFM_SESSION` | No | | Session id. Will be generated by authentication flow if not provided. |
| `SOURCE_LIBREFM_URLBASE` | No | | Use for custom Libre.fm instance only. The host + path prefix EX `https://my.libre.example/2.0/` |
</Config>
@@ -25,7 +25,9 @@ On your [profile page](https://listenbrainz.org/profile/) find your **User Token
## Configuration
<Config config="ListenBrainzSourceConfig" fileContent={ListenbrainzConfig} name="listenbrainz">
:::note
You cannot use ENV variables shown in the [Listenbrainz Client config](/configuration/clients/listenbrainz) -- multi-scrobbler assumes Listenbrainz ENVs are always used for the **client** configuration. You must use the [File or AIO](/configuration?configType=file#configuration-types) config to setup Listenbrainz as a Source.
:::
| Environmental Variable | Required? | Default | Description |
| ---------------------- | --------- | ----------------------------- | ------------------------------- |
| `SOURCE_LZ_TOKEN` | Yes | | User token from your LZ profile |
| `SOURCE_LZ_USER` | Yes | | Your LZ username |
| `SOURCE_LZ_URL` | No | https://api.listenbrainz.org/ | The base URL for the LZ server |
</Config>
@@ -17,13 +17,13 @@ To _scrobble to_ a Maloja server, create a [Maloja (Client)](/configuration/cli
See the [Maloja (Client)](/configuration/clients/maloja) configuration for general setup. The only difference for **Source** configuration:
* Cannot be setup with ENV config
* [File/AIO config](/configuration?configType=file#configuration-types) must include `"configureAs": "source"`
## Configuration
<Config config="MalojaSourceConfig" fileContent={MalojaConfig} name="maloja">
:::note
You cannot use ENV variables shown in the [Maloja Client config](/configuration/clients/maloja) -- multi-scrobbler assumes Maloja ENVs are always used for the **client** configuration. You must use the [[File or AIO](/configuration?configType=file#configuration-types) config to setup Maloja as a Source.
:::
| Environmental Variable | Required? | Default | Description |
| ----------------------- | --------- | ------- | ----------------------------- |
| `SOURCE_MALOJA_URL` | Yes | | Base URL of your installation |
| `SOURCE_MALOJA_API_KEY` | Yes | | Api Key |
</Config>
+128
View File
@@ -63,6 +63,134 @@ By default multi-scrobbler will only scrobble media found in Plex libraries that
</details>
<DetailsAdmo type="tip" summary="Use Plex metadata with Musicbrainz for better scrobbling">
<h3>Matching With Plex</h3>
In Plex, if the **Plex Music** Agent is set on a Music Library then Plex attempts to match your music with Musicbrainz when it is first imported.
<img src={require('/img/plex_music_agent.jpg').default} height="400"/>
Plex uses ID3/metdata tags to match or falls back to matching based on file name and folder names. If it cannot find a match it can be fixed through a **Fix Match** option in the album/track context menu. See [plex documentation for more information](https://support.plex.tv/articles/correcting-your-music-content-matches/).
You can verify if an Item has been matched by:
* Clicking on the Item context menu (...)
* Get Info
* View XML
If a node like this is present then it has been matched: `<Guid id="mbid://4e631558-13b0..."/>`
<h3>Using Musicbrainz With Multi-Scrobbler</h3>
The MBID from the above `<Guid>` node is a [Track](https://musicbrainz.org/doc/Track), a special type of ID that specifically identifies a song on a specific album. If this is present then Multi-scrobbler can use it to gaurantee your scrobble, and all its metadata, is matched 1:1 with what is in your Plex library when using the [Musicbrainz Stage](/configuration/transforms/musicbrainz) to enrich your scrobble.
To configure MS to use Musicbrainz with your Plex metadata use one of the methods below:
<Tabs groupId="configType" queryString>
<TabItem value="env" label="ENV">
Add to your multi-scrobbler docker compose file `environment` section for [Musicbrainz ENV Configuration](/configuration/transforms/musicbrainz#env-configuration):
```yaml
# a real email that Musicbrainz can use to contact you in case of issues
- MB_CONTACT=myEmail@myEmailProvider.com
- MB_PRESETS=id,default
- PLEX_TRANSFORMS=musicbrainz
```
</TabItem>
<TabItem value="file" label="File">
Your [AIO Config](/configuration?configType=aio#configuration-types):
```json5 title="config.json"
{
// ...
"transformers": [
{
"type": "musicbrainz",
"name": "MyMB",
"data": {
"apis": [
{
// a real email that Musicbrainz can use to contact you in case of issues
"contact": "myEmail@myEmailProvider.com"
}
]
}
}
]
}
```
In your [File Config](/configuration?configType=file#configuration-types):
```json5 title="plex.json"
[
{
"name": "MyPlex",
"data": { /* ... */},
"options": {
"playTransform": {
"preCompare": [
{
"type": "musicbrainz",
"name": "MyMB"
"searchOrder": ["mbidrecording", "basicOrIds", "basic"]
}
]
}
}
}
]
```
</TabItem>
<TabItem value="aio" label="File AIO">
Your [AIO Config](/configuration?configType=aio#configuration-types):
```json5 title="config.json"
{
// ...
"transformers": [
{
"type": "musicbrainz",
"name": "MyMB",
"data": {
"apis": [
{
// a real email that Musicbrainz can use to contact you in case of issues
"contact": "myEmail@myEmailProvider.com"
}
]
}
}
]
// ...
"sources": [
// ...
{
"name": "MyPlex",
"type": "plex",
"data": { /* ... */},
"options": {
"playTransform": {
"preCompare": [
{
"type": "musicbrainz",
"name": "MyMB",
"searchOrder": ["mbidrecording", "basicOrIds", "basic"]
}
]
}
}
}
]
}
```
</TabItem>
</Tabs>
</DetailsAdmo>
#### Configuration
<Config config="PlexApiSourceConfig" fileContent={PlexConfig} name="plex">
@@ -29,11 +29,11 @@ Follow the **Setup** instructions in the [Rocksky (Client)](/configuration/clien
See the [Rocksky (Client)](/configuration/clients/rocksky#setup) configuration for general setup. The only difference for **Source** configuration:
* Cannot be setup with ENV config
* [File/AIO config](/configuration?configType=file#configuration-types) must include `"configureAs": "source"`
<Config config="RockskyClientConfig" fileContent={JsonConfig} name="rocksky">
:::note
You cannot use ENV variables shown in the [Rocksky Client config](/configuration/clients/rocksky#configuration) -- multi-scrobbler assumes Rocksky ENVs are always used for the **client** configuration. You must use the [File or AIO](/configuration?configType=file#configuration-types) config to setup Rocksky as a Source.
:::
<Config config="RockskySourceConfig" fileContent={JsonConfig} name="rocksky">
| Environmental Variable | Required? | Default | Description |
| :---------------------- | --------- | ------- | ----------------------------------------------------------------------------------- |
| `SOURCE_ROCKSKY_HANDLE` | Yes | | Your **full** ATProto handle. For Bluesky account this is like `myUser.bsky.social` |
| `SOURCE_ROCKSKY_KEY` | Yes | | API Key obtained from Rocksky developer dashboard |
</Config>
@@ -0,0 +1,100 @@
---
title: Sonos
toc_min_heading_level: 2
toc_max_heading_level: 5
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';
import JsonConfig from '!!raw-loader!@site/../config/sonos.json.example';
Multi-scrobbler can use the [Sonos](https://www.sonos.com) [local API](https://docs.sonos.com/docs/control) to monitor what your Sonos system is playing.
MS supports scrobbling simultaneous, different Plays based on what each Group/Zone is playing.
<DetailsAdmo type="tip" summary="Use Musicbrainz for better scrobbling">
For some services, including Spotify, Sonos only reports the **first** artist for a Track. You will most likely want to enable [Musicbrainz scrobble enhancements](/configuration/transforms/musicbrainz) so that your plays have correct information, including all artists, when scrobbled.
</DetailsAdmo>
<DetailsAdmo type="note" summary="Avoid Sonos activity through other Sources">
Activity reporting for **other [Sources](/configuration/sources)** does not work well **when played through Sonos.**
If you have other Sources configured for Multi-Scrobbler that you may play *through Sonos* you should try to add Sonos to the "deny" list for that Source so that it does not try to monitor Sonos activity. Check the documentation for each individual Source to see how to configure this exclusion.
For example, to prevent the [Plex](/configuration/sources/plex) Source from monitoring audio played through Sonos, add Sonos to the "block" list ENV EX: `PLEX_DEVICES_BLOCK=sonos`
</DetailsAdmo>
<details>
<summary>How to report issues</summary>
If your Sonos Source is logging errors or the scrobble data is not as expected please [create a bug report](https://github.com/FoxxMD/multi-scrobbler/issues/new?template=01-bug-report.yml) **after** enabling the following debug logging options based on the config type you have:
<Tabs groupdId="sonosBugConfig">
<TabItem value="env" label="ENV">
Enable [Debug Mode](/configuration#debug-mode) using `DEBUG_MODE=true`
</TabItem>
<TabItem value="file" label="File">
Enable `logPayload` and `logFitlerFailure` in your `sonos.json`, or AIO file, config:
```json
[
{
"enable": true,
"name": "MySonos",
"data": {
"host": "192.168.0.150"
},
"options": {
"logFilterFailure": "warn",
"logPayload": true
}
}
]
```
</TabItem>
</Tabs>
Additional logging for the Sonos library may be enabled by including this environmental variable (regardless of config type):
```
DEBUG=sonos:*
```
The above changes:
* Triggers multi-scrobbler to log the raw data recieved from Sonos when a new track/device/service is seen for the first time
* Trigger multi-scrobbler to log the reason it considers a play from Sonos as invalid (and will not monitor it)
* Logs low-level activity from the Sonos library
Please include these additional logs when creating a bug report. They are essential to troubleshooting your issue.
</details>
### Filtering Activity
The **optional** `devices` and `groups` related properties found in the config below can be used to include or exclude Sonos devices/groups by name, case-insensitive.
## Configuration
You **must** define the IP address of at least one Sonos/accessory in order for Multi-scrobbler to connect to your Sonos system.
<Config config="SonosSourceConfig" fileContent={JsonConfig} name="sonos">
| Environmental Variable | Required? | Default | Description |
| ---------------------- | --------- | ------- | :--------------------------------------------------------------------- |
| `SONOS_HOST` | Yes | | The IP address of any active Sonos device/accessory EX `192.168.0.150` |
| `SONOS_DEVICES_ALLOW` | No | | Comma-separated list of Sonos device names to scrobble from |
| `SONOS_DEVICES_BLOCK` | No | | Comma-separated list of Sonos device names to disallow scrobbles from |
| `SONOS_GROUPS_ALLOW` | No | | Comma-separated list of device group names to scrobble from |
| `SONOS_GROUPS_BLOCK` | No | | Comma-separated list of devices group names to disallow scrobbles from |
</Config>
@@ -23,6 +23,7 @@ A **Source** is a data source that contains information about tracks you are pla
| [Kodi](/configuration/sources/kodi) | [Active](./?sourceComm=active#by-communication-method) | [Activity](./?sot=activity#by-data-source-of-truth) | ❌ | ✅ | ✅ | ❌ |
| [Koito](/configuration/sources/koito-source) | [Active](./?sourceComm=active#by-communication-method) | [History](./?sot=history#by-data-source-of-truth) | ❌ | ✅ | ❌ | ❌ |
| [Last.fm](/configuration/sources/lastfm-source) | [Active](./?sourceComm=active#by-communication-method) | [History](./?sot=history#by-data-source-of-truth) | ❌ | ✅ | ❌ | ❌ |
| [Libre.fm](/configuration/sources/librefm-source) | [Active](./?sourceComm=active#by-communication-method) | [History](./?sot=history#by-data-source-of-truth) | ❌ | ✅ | ❌ | ❌ |
| [Last.fm (Endpoint)](/configuration/sources/lastfm-endpoint) | [Ingress](./?sourceComm=ingress#by-communication-method) | [History](./?sot=history#by-data-source-of-truth) | ❌ | ✅ | ❌ | ❌ |
| [ListenBrainz](/configuration/sources/listenbrainz-source) | [Active](./?sourceComm=active#by-communication-method) | [History](./?sot=history#by-data-source-of-truth) | ❌ | ✅ | ❌ | ❌ |
| [ListenBrainz (Endpoint)](/configuration/sources/listenbrainz-endpoint) | [Ingress](./?sourceComm=ingress#by-communication-method) | [History](./?sot=history#by-data-source-of-truth) | ❌ | ✅ | ❌ | ❌ |
@@ -32,6 +33,7 @@ A **Source** is a data source that contains information about tracks you are pla
| [Musikcube](/configuration/sources/musikcube) | [Active](./?sourceComm=active#by-communication-method) | [Activity](./?sot=activity#by-data-source-of-truth) | ❌ | ✅ | ✅ | ❌ |
| [Plex](/configuration/sources/plex) | [Active](./?sourceComm=active#by-communication-method) | [Activity](./?sot=activity#by-data-source-of-truth) | ✅ | ✅ | ✅ | ❌ |
| [Rocksky](/configuration/sources/rocksky-source) | [Active](./?sourceComm=active#by-communication-method) | [History](./?sot=history#by-data-source-of-truth) | ❌ | ✅ | ❌ | ❌ |
| [Sonos](/configuration/sources/sonos) | [Active](./?sourceComm=active#by-communication-method) | [Activity](./?sot=activity#by-data-source-of-truth) | ✅ | ✅ | ✅ | ❌ |
| [Spotify](/configuration/sources/spotify) | [Active](./?sourceComm=active#by-communication-method) | [Activity](./?sot=activity#by-data-source-of-truth) | ✅ | ✅ | ✅ | ❌ |
| [Subsonic-compatible APIs](/configuration/sources/subsonic) | [Active](./?sourceComm=active#by-communication-method) | [Activity](./?sot=activity#by-data-source-of-truth) | ✅ | ✅ | ✅ | ❌ |
| [teal.fm](/configuration/sources/tealfm-source) | [Active](./?sourceComm=active#by-communication-method) | [History](./?sot=history#by-data-source-of-truth) | ❌ | ✅ | ❌ | ❌ |
+20 -6
View File
@@ -8,17 +8,31 @@ import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';
import SpotifyConfig from '!!raw-loader!@site/../config/spotify.json.example';
import IconWarning from '@theme/Admonition/Icon/Warning';
<details>
<summary>Spotify and Automix</summary>
<DetailsAdmo type="note" summary="Spotify and Automix">
If your Spotify player has [Automix](https://community.spotify.com/t5/FAQs/What-is-Automix/ta-p/5257278) enabled and Spotify uses it for your playlist/queue then MS cannot accurately determine when a track will end. This is because the track is "mixed" in your queue with a shorter play time than its actual length and [Spotify does not report this modified play time in its API.](https://community.spotify.com/t5/Spotify-for-Developers/Wrong-duration-ms-of-track-with-Automix/m-p/5429147) This **does not affect MS's ability to scrobble** from Spotify but it will affect the accuracy of the duration MS reports was played.
</details>
</DetailsAdmo>
#### Authenticate Spotify with Multi-Scrobbler
<DetailsAdmo type="warning" summary="Premium Account Required">
Starting [March 9th 2026](https://developer.spotify.com/blog/2026-02-06-update-on-developer-access-and-platform-security) all applications on the Spotify Developer platform will only continue to work if they are **owned** by a **Spotify Premium** account.
If your App is not created by a Premium account you will likely recieve a 403 error when trying to use MS with Spotify.
If you do not have a Spotify Premium account *you can still use Spotify with MS* but it will require you to coordinate with a (friend?) user who *does* have Spotify Premium:
* Follow the steps below **logged in as the Spotify Premium account user**
* After completing App creation (step 4 or 5), navigate to the **User Management** page for the created App
* Add **your** (non-premium) account here using your account email/name
* Complete the rest of the authentication/configuration process normally
Assure your friend: **Creating a Spotify Developer app does not give anyone access to the owner's account.** The authentication process within MS is where authorization is given: it requires clicking the link in MS's dashboard and following a separate auth flow. This auth flow only authorizes access to the specific account used in the flow, unrelated to the owner of the developer app.
</DetailsAdmo>
To access your Spotify history you must [create a Spotify App](https://developer.spotify.com/dashboard) to get a
Client ID/Secret.
@@ -11,26 +11,26 @@ import SubsonicConfig from '!!raw-loader!@site/../config/subsonic.json.example';
This Source can be used for any application that implements the [Subsonic API](http://www.subsonic.org/pages/api.jsp) and supports the [`getNowPlaying`](http://www.subsonic.org/pages/api.jsp#getNowPlaying) endpoint (such as [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/))
:::warning[Known Issues]
<DetailsAdmo type="warning" summary="Known Issues">
* Multiple artists are reported as one value and cannot be separated
* If using [Airsonic Advanced](https://github.com/airsonic-advanced/airsonic-advanced) the password used (under **Credentials**) must be **Decodable**
:::
</DetailsAdmo>
:::tip
<DetailsAdmo type="tip" summary="Recommended Alternative Sources">
If your serivce supports scrobbling to **Listenbrainz** (such as Navidrome), considering using a [**Listenbrainz (Endpoint)** Source](/configuration/sources/listenbrainz-endpoint) instead of this one.
Service-specific scrobble implementations tend to be more accurate and provide more information (multiple artists) compared to the Subsonic API.
:::
</DetailsAdmo>
Use the optional `usersAllow` property with **File** or **AIO** configuration to restrict scrobbling to a list of defined users.
## Configuration
<Config config="SubsonicSourceConfig" fileContent={SubsonicConfig} name="subsonic">
<Config config="SubSonicSourceConfig" fileContent={SubsonicConfig} name="subsonic">
| Environmental Variable | Required? | Default | Description |
|------------------------|-----------|---------|--------------------------------------|
| `SUBSONIC_USER` | Yes | | |
@@ -27,13 +27,84 @@ Follow the **Setup** instructions in the [teal.fm (Client)](/configuration/clien
## Configuration
See the [teal.fm (Client)](/configuration/clients/tealfm#setup) configuration for general setup. The only difference for **Source** configuration:
See the [teal.fm (Client)](/configuration/clients/tealfm#setup) configuration for general setup. The main differences for **Source** configuration:
* Cannot be setup with ENV config
* [File/AIO config](/configuration?configType=file#configuration-types) must include `"configureAs": "source"`
### Service Filtering
`serviceAllow` and `serviceDeny` are lists that can be used to filter what Plays are scrobbles from teal.fm. These correspond to the base domain of the music service where the Play is from, originally. The values in the list can be a subset of the actual service name (they do not need to be exact matches).
Only one filter can be used at a time. If `serviceAllow` is configured then `serviceDeny` will be ignored.
If a Play does not have an associated music service it can be allowed/denied using the special keyword `unknown`.
If you are unsure what services are being used for your scrobbles you can check this by:
* use [atproto.at](https://atproto.at/) to lookup your DID/handle
* View the **Raw Data** for the PDS Collection `fm.teal.alpha.feed.play`
* Check the `musicServiceBaseDomain` property for each record
<details>
<summary>Examples</summary>
Allowing only scrobbles from [plyr.fm](https://plyr.fm/):
```json title="tealfm.json"
[
{
"name": "myTealSource",
"configureAs": "source",
"data": {
"identifier": "alice.bsky.social",
"appPassword": "twog-phu7-4dhe-y4j3",
"serviceAllow": ["plyr"],
}
}
]
```
Deny scrobbles from last.fm:
```json title="tealfm.json"
[
{
"name": "myTealSource",
"configureAs": "source",
"data": {
"identifier": "alice.bsky.social",
"appPassword": "twog-phu7-4dhe-y4j3",
"serviceDeny": ["last"],
}
}
]
```
Allow scrobbles from plyr.fm and unknown services:
```json title="tealfm.json"
[
{
"name": "myTealSource",
"configureAs": "source",
"data": {
"identifier": "alice.bsky.social",
"appPassword": "twog-phu7-4dhe-y4j3",
"serviceAllow": ["plyr", "unknown"],
}
}
]
```
</details>
<Config config="TealClientConfig" fileContent={JsonConfig} name="tealfm">
:::note
You cannot use ENV variables shown in the [teal.fm Client config](/configuration/clients/tealfm#configuration) -- multi-scrobbler assumes teal.fm ENVs are always used for the **client** configuration. You must use the [File or AIO](/configuration?configType=file#configuration-types) config to setup teal.fm as a Source.
:::
| Environmental Variable | Required? | Default | Description |
| :------------------------- | --------- | ------- | ------------------------------------------------------------------------------------------ |
| `SOURCE_TEALFM_IDENTIFIER` | Yes | | Your **full** ATProto handle or DID. For Bluesky account this is like `myUser.bsky.social` |
| `SOURCE_TEALFM_APP_PW` | Yes | | Bluesky/ATProto network App Password |
</Config>
@@ -42,6 +42,10 @@ If the file being played in VLC does not have ID3 tags/metadata information mult
To extract this information use [named capture groups](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Named_capturing_group) in your expression matching the field that should be extracted: `artist` `title` and/or `album`. MS accepts multiple expressions, the first one that matches a filename will be used.
<details>
<summary>Example</summary>
Example usage in [a file-based config:](/configuration?configType=file#configuration-types)
```json5 title="config/vlc.json" {10-15}
@@ -65,10 +69,16 @@ Example usage in [a file-based config:](/configuration?configType=file#configura
]
```
</details>
#### Vlc Information Reporting
If you find that VLC is incorrectly reporting track information (in its interface) but multi-scrobbler is not parsing it correctly it may be due to the _name_ of the fields VLC is reporting. mutli-scrobbler uses the most common field name but does not cover all use cases. Before reporting an issue please turn on metadata logging and include output from your logs while it is turned on:
<details>
<summary>Metadata Logging Configuration</summary>
```json5 title="config/vlc.json" {9-9}
[
{
@@ -84,6 +94,8 @@ If you find that VLC is incorrectly reporting track information (in its interfac
]
```
</details>
## Configuration
<Config config="VLCSourceConfig" fileContent={JsonConfig} name="vlc">
@@ -18,19 +18,19 @@ After installing the [Webscrobbler extension](https://web-scrobbler.com/) open t
Reload the extension after adding the webhook.
:::note
<DetailsAdmo type="note" summary="URL Types Supported by Webscrobbler">
* **On Firefox** - Only FQNs (domain.tld), `localhost`, and `127.0.0.1` are supported for API URL due to [firefox requiring https](https://github.com/web-scrobbler/web-scrobbler/issues/4183#issuecomment-1749222006)
* **On Chromium-based Browsers** - Any domain will work for API URL
* All other browsers are untested
:::
</DetailsAdmo>
:::warning
<DetailsAdmo type="warning" summary="Public-Facing Usage">
Multi-scrobbler is **not** designed to be publicly accessible from the internet. To use Webscrobbler outside your local network you should be accessing MS through a VPN or through a reverse proxy with some kind of authentication (though this is still not recommended).
:::
</DetailsAdmo>
### Multiple Users
@@ -86,7 +86,7 @@ This affects **only** MS's behavior and does not affect the general connector be
## Configuration
<Config config="WebscrobblerSourceConfig" fileContent={JsonConfig} name="webscrobbler">
<Config config="WebScrobblerSourceConfig" fileContent={JsonConfig} name="webscrobbler">
| Environmental Variable | Required? | Default | Description |
|------------------------|-----------|---------|--------------------------------------------------------------------------|
| WS_ENABLE | No | | Set to 'true' to enable WS without needing to define other ENVs |
@@ -115,7 +115,7 @@ Only one of these methods needs to be used.
If the beginning of the Redirect URI (before `api`) is EXACTLY how you would reach the MS dashboard from your browser (EX `http://localhost:9078`) then edit your google oauth client section for `Authorized redirect URIs` and add the URL MS has displayed.
If it is NOT EXACTLY the same you either need to set MS's [base url](https://foxxmd.github.io/multi-scrobbler/docs/configuration/#base-url) or you can provide your own (Custom) Redirect URI for MS to use by setting it in `ytmusic.json` or ENV.
If it is NOT EXACTLY the same you either need to set MS's [base url](/configuration#base-url) or you can provide your own (Custom) Redirect URI for MS to use by setting it in `ytmusic.json` or ENV.
<details>
@@ -50,7 +50,7 @@ Set up [Valkey Caching](/configuration?cachedThings=metadata#caching) to cache M
### API Setup
To avoid rate limiting, MusicBrainz requires API users to identify themself using a [User-Agent that contains an email or URL.](https://wiki.musicbrainz.org/MusicBrainz_API/Rate_Limiting#How_can_I_be_a_good_citizen_and_be_smart_about_using_the_Web_Service?) You must set this in the `data` for your [stage configuration](http://localhost:3000/docs/configuration/transforms/#configuring-stages) in your [AIO Config](/configuration?configType=aio#configuration-types):
To avoid rate limiting, MusicBrainz requires API users to identify themself using a [User-Agent that contains an email or URL.](https://wiki.musicbrainz.org/MusicBrainz_API/Rate_Limiting#How_can_I_be_a_good_citizen_and_be_smart_about_using_the_Web_Service?) You must set this in the `data` for your [stage configuration](/configuration/transforms/#configuring-stages) in your [AIO Config](/configuration?configType=aio#configuration-types):
```json5 title="config.json"
{
@@ -129,7 +129,6 @@ Example:
],
"defaults": {
"releaseStatusPriority": ["official"],
"fallbackArtistSearch": "native",
"releaseAllowEmpty": true
}
},
@@ -138,25 +137,97 @@ Example:
}
```
### Rules
### Rules and Hooks
Each [Rule](/configuration/transforms#stage-rules) should be either a boolean, specifying if the transformed data should be used for this field, or a [`when` condition](/configuration/transforms#conditional-moditication):
[Add your Stage](https://foxxmd.github.io/multi-scrobbler/configuration/transforms/#stage) to a Source or Client by specifying it in a [Hook](/configuration/transforms/#hook):
```json5
{
"type": "musicbrainz",
"name": "MyMB"
// ...
"title": false, // will not apply any changes to Play title
"artists": {
"when": {/* ... */}, // will only apply changes to Play artists if "when" is satisfied
/* ... */
},
"album": true // will always apply changes to Play album
"meta": true // adds MusicBrainz MBIDs to scrobble data
}
```json5 title="subsonic.json"
[
{
"name": "MySubsonic",
"data": { /* ... */},
"options": {
"playTransform": {
"preCompare": [
{
"type": "musicbrainz",
"name": "MyMB"
}
]
}
}
}
]
```
Each [**Stage Rule**](/configuration/transforms#stage-rules) should be either a boolean, specifying if the transformed data should be used for this field, or a [`when` condition](/configuration/transforms#conditional-modification):
<details>
<summary>Example</summary>
```json5 title="subsonic.json"
[
{
"name": "MySubsonic",
"data": { /* ... */},
"options": {
"playTransform": {
"preCompare": [
{
"type": "musicbrainz",
"name": "MyMB"
// ...
"title": false, // will not apply any changes to Play title
"artists": {
"when": {/* ... */}, // will only apply changes to Play artists if "when" is satisfied
/* ... */
},
"album": true // will always apply changes to Play album
"meta": true // adds MusicBrainz MBIDs to scrobble data
}
]
}
}
}
]
```
</details>
:::tip[Per Component Override]
The `defaults` you set in [Stage Configuration](#stage-configuration) [can be overriden/added to](/configuration/transforms/#overriding-configuration) (per property) in each Hook.
<details>
<summary>Example</summary>
```json5 title="subsonic.json"
[
{
"name": "MySubsonic",
"data": { /* ... */},
"options": {
"playTransform": {
"preCompare": [
{
"type": "musicbrainz",
"name": "MyMB",
"releaseStatusPriority": ["psuedo-release"], // override from defaults
"searchOrder": ["freetext"] // add new property, combined with defaults
}
]
}
}
}
]
```
</details>
:::
## ENV Configuration
The general configuration shown above can also be configured from a selection of *presets* using [ENV Config](/configuration?configType=env#configuration-types) for individual Sources/Clients.
@@ -169,20 +240,19 @@ MB_CONTACT=contact@mydomain.com
To configure [stage defaults](#stage-configuration) use `MB_PRESETS` with a comma-delimited list of presets you wish to apply. More than one preset can be applied, in which case they combine. You must choose at least one of the presets below:
* `default` - Applies no defaults. This is the same as using no options from [Matching With Musicbrainz](#matching-with-musicbrainz)
* `sensible` - Applies the [Sensible Default](#sensible-default) configuration for sorting releases
* `native` - Applies `fallbackArtistSearch: native` for [Artist Extraction](#artist-extraction) if the first search fails to find matches
* `aggressive` - Applies [Free Text Search](#free-text) `fallbackFreeTextSearch: true` if all other searches fail
* `default` - Adds the default [`searchOrder`](#search-methods) `isrc`+`basic` (same as using no presets that affect `searchOrder`)
* `id` - Adds [`searchOrder`](#search-methods) methods that priorites searching by ID: `isrc` + `mbidrecording` + `basicOrIds` + `basic`
* `native` - Adds **Extracted Artists** (`artist`) in `native` mode to [`searchOrder`](#search-methods)
* `aggressive` - Adds **Free Text Search** (`freetext`) to [`searchOrder`](#search-methods)
* `fields` - Applies [Field Scoring](#field-scoring) to match sorting so match text is baised towards similarity to original scrobble
* `sensible` - Applies the [Sensible Default](#sensible-default) configuration for [sorting releases](#sorting-releases)
Finally, use ENV `*_TRANSFORMS=musicbrainz` on each Source/Client you wish to apply this stage to. This applies the stage in the [`preTransform` Hook](#/configuration/transforms#lifecycle-hooks) with all [Rules](#rules) enabled.
Finally, use ENV `*_TRANSFORMS=musicbrainz` on each Source/Client you wish to apply this stage to. This applies the stage in the [`preTransform` Hook](/configuration/transforms#lifecycle-hooks) with all [Rules](#rules-and-hooks) enabled.
The `*` stands for the prefix used for each Source/Client's ENV keys. Refer to the individual Source/Client Configuration sections to find this.
The `*` stands for the prefix used for each Source/Client's ENV keys. Refer to the individual Source/Client Configuration sections to find this. Example:
:::tip
Enhancing a scrobble with the `preTransform` hook for a Source means that all Clients that recieve the scrobble get the enhanced version. You only need to apply the transform once, for a Source, to use it everywhere for downstream Clients.
:::
* All [Subsonic Source](/configuration/sources/subsonic) ENVs look like `SUBSONIC_USER=myuser` etc...
* Use `SUBSONIC_TRANSFORMS=musicbrainz`
<details>
@@ -196,15 +266,22 @@ services:
image: foxxmd/multi-scrobbler
container_name: multi-scrobbler
environment:
// highlight-start
- MB_CONTACT=contact@mydomain.com
- MB_PRESETS=sensible,native # creates sensible defaults with native fallback searching
# searches with sensible release sorting with the searchOrder
# isrc => basic => artist (native mode)
- MB_PRESETS=default,sensible,native
// highlight-end
- JELLYFIN_URL=192.168.0.110:8096
- JELLYFIN_APIKEY=c9fae8756fbf481ebd9c5bb56b
- JELLYFIN_USER=MyUser
- JELLYFIN_TRANSFORMS=musicbrainz # applies musicbrainz Stage to preTransform of Jellyfin source
// highlight-start
# applies musicbrainz Stage to preTransform of Jellyfin source
- JELLYFIN_TRANSFORMS=musicbrainz
// highlight-end
- MALOJA_URL=http://192.168.0.100:42010 # maloja receives enhanced scrobble from Jellyfin
# maloja receives enhanced scrobble from Jellyfin
- MALOJA_URL=http://192.168.0.100:42010
- MALOJA_API_KEY=myApiKey
@@ -236,53 +313,195 @@ Both steps have separate configuration.
### Searching
The first step is making [search queries to the Musicbrainz database](https://musicbrainz.org/doc/MusicBrainz_API/Search) to try to get potential candidates. Multi-scrobbler uses the **title, artist(s), and album** from your Scrobble data to query for matches.
#### Should MS Search?
Musicbrainz agressively normalizes these fields in its database which means that if your Scrobble data contains major innaccuracies or phrases fields in a non-normal way, it's possible Musicbrainz won't find any matches. This is a more common occurrence when trying to match Scrobble data from Sources that don't support multiple artist data, like [Subsonic](/configuration/sources/subsonic) and [Last.fm](/configuration/sources/lastfm).
Before MS begins a search it checks if your Scrobble data already contains:
* [MBIDs](https://musicbrainz.org/doc/MusicBrainz_Identifier) for [artists](https://musicbrainz.org/doc/Artist), [album](https://musicbrainz.org/doc/Release), and specific [track/recording](https://musicbrainz.org/doc/Recording)
* and duration
If it already has all required data types then the entire Musicbrainz Stage [is **skipped**.](/configuration/transforms/#flow-control) If any are missing then a search is performed.
Define which data types are required using:
* `searchWhenMissing` (defaults to all) - A list containing any of: `artists` `title` `album` `duration`
* `forceSearch` (default `false`) - Force searching even if all required data is present
<details>
<summary>Examples of Bad Data</summary>
<summary>Example</summary>
Last.fm Scrobble returns an Artist in the title and combines two artists into one string:
[Stage Configuration](/configuration/transforms#configuring-stages) example:
```json
{
"title": "Endless Possibility (feat. Wheatus)",
"artists": ["Bowling For Soup & Punk Rock Factory"]
}
```
```json5
// ...
"defaults": {
// only search if MBIDs for artists or album is missing
"searchWithMissing": ["artists", "album"]
The corresponding [Musicbrainz Recording](https://musicbrainz.org/release/85bf284b-8b39-414e-8ad9-61f593072588) has all artists separated and no artist in the title:
```json
{
"title": "Endless Possibility",
"artists": ["Bowling For Soup", "Punk Rock Factory", "Wheatus"]
}
// uncomment to make the stage always search, even if above data is present
//forceSearch: true
}
```
</details>
**If a normal search using all the fields mentioned above does not return any matches Multi-scrobbler can try additional searches with modified queries:**
If required data is missing then the next step is making [search queries to the Musicbrainz database](https://musicbrainz.org/doc/MusicBrainz_API/Search) to try to get potential candidates.
#### Album Only
#### Search Methods
If your Scrobble data contains a title, artist(s), and an album (all three fields) then Multi-scrobbler will **automatically** retry the search using only title and album.
Multi-scrobbler can search for Musicbrainz matches using **multiple** methods. You control:
#### Artist Extraction
* the search methods that are used
* **the order** in which search methods are executed
If...
All search methods will be run in the order they were defined until one method returns at least one match.
* [Album Only](#album-only) returns no results or did not run due to missing an album
* Your scrobble data contains only **one** artist string
* `fallbackArtistSearch` is set in [Stage Configuration](/configuration/transforms#configuring-stages)
**The methods you choose, and the order they run in, can drastically change how many API calls are needed to get a match, and what types of matches are returned.** See [**Search Considerations**](#search-considerations) for guidance on how to decide on methods based on Source.
Then Multi-scrobbler will attempt to extract multiple artists from your artist and track string. **This is not automatic. You must set `fallbackArtistSearch` to enable this additional search.**
To set search methods and their order use the `searchOrder` option in your [Stage Configuration](/configuration/transforms#configuring-stages):
`fallbackArtistSearch` can be set to **Native** or **Naive** mode:
```json5
// ...
"defaults": {
// only searches using these methods, in the order they are listed here
"searchOrder": ["isrc", "mbidrecording", "basic","freetext"]
}
```
<Tabs groupId="fallbackArtist" queryString>
:::tip[Default Search Methods]
If `searchOrder` is undefined then Multi-scrobbler will default to using `isrc` then `basic` method.
:::
<h4>Available Methods</h4>
<details>
<summary>ISRC (`isrc`)</summary>
If your Scrobble data contains an [ISRC](https://musicbrainz.org/doc/ISRC) (usually from Spotify) then Multi-scrobbler can search using this ID, only.
[Stage Configuration](/configuration/transforms#configuring-stages) example:
```json5
// ...
"defaults": {
// will only search using isrc
"searchOrder": ["isrc"]
}
```
</details>
<details>
<summary>Track MBID (`mbidrecording`)</summary>
If your Scrobble data contains an [Track (Recording) MBID](https://musicbrainz.org/doc/Recording) then Multi-scrobbler can search using this MBID, only.
[Stage Configuration](/configuration/transforms#configuring-stages) example:
```json5
// ...
"defaults": {
// will only search using recording mbid
"searchOrder": ["mbidrecording"]
}
```
</details>
<details>
<summary>Album, Artist, and Title Fields (`basic`)</summary>
Will search Musicbrainz using any/all available text fields from your scrobble: Album, Artists(s), and Title. Does not leverage any existing MBIDs.
[Stage Configuration](/configuration/transforms#configuring-stages) example:
```json5
// ...
"defaults": {
// will only search using album, artist(s), and title
"searchOrder": ["basic"]
}
```
</details>
<details>
<summary>Album/Artist/Title OR MBIDs (`basicOrIds`)</summary>
This is the same as the above **Album, Artist, and Title Fields** search except that if the scrobble data contains any corresponding MBIDs it will use those instead of the plain text field.
[Stage Configuration](/configuration/transforms#configuring-stages) example:
```json5
// ...
"defaults": {
// will only search using album, artist(s), and title
"searchOrder": ["basicOrIds"]
}
```
Example:
```json
{
"title": "Endless Possibility (feat. Wheatus)",
"artists": ["Bowling For Soup"]
"albumMbid": "c9f91cdc-984e-4303-9a51-4ac0dfa2348f",
"album": "My Cool Album"
}
```
Multi-scrobbler will search Musicbrainz using `title`, `artists`, and `albumMbid` but NOT `album`.
</details>
<details>
<summary>Album And Title Only (`album`)</summary>
If your Scrobble data contains a title, artist(s), and an album (all three fields) then Multi-scrobbler can search using only title and album by using `album` for `searchOrder`:
[Stage Configuration](/configuration/transforms#configuring-stages) example:
```json5
// ...
"defaults": {
// will only search using only title + album name
"searchOrder": ["album"]
}
```
</details>
<details>
<summary>Extracted Artists (`artist`)</summary>
If your scrobble data contains only **one** artist string then Multi-scrobbler can attempt to extract multiple artists from your artist and track string.
Use `artist` with `searchOrder` and optionally specify the extraction mode with `searchArtistMethod`:
[Stage Configuration](/configuration/transforms#configuring-stages) example:
```json5
// ...
"defaults": {
// will only search using title/album + extracted artists
"searchOrder": ["artist"],
//searchArtistMethod: 'native' // optional
}
```
`searchArtistMethod` can be set to **Native** or **Naive** mode:
<Tabs groupId="searchArtistMethod" queryString>
<TabItem value="native" label="Native (Recommended)">
**Native** (`native`) mode uses an aggressive configuration of the [Native Stage](/configuration/transforms/native) to extract artists using common delimiters and common "joined" artist patterns from the artist and title string of your Scrobble data.
@@ -325,8 +544,9 @@ Then Multi-scrobbler will attempt to extract multiple artists from your artist a
```json5
// ...
"defaults": {
// ...
"fallbackArtistSearch": "native"
// will only search using title/album + native extracted artists
"searchOrder": ["artist"],
"searchArtistMethod": "native"
}
```
@@ -363,23 +583,28 @@ Then Multi-scrobbler will attempt to extract multiple artists from your artist a
```json5
// ...
"defaults": {
// ...
"fallbackArtistSearch": "naive"
// will only search using title/album + naive extracted artists
"searchOrder": ["artist"],
"searchArtistMethod": "naive"
}
```
</TabItem>
</Tabs>
#### Free Text
</details>
If both [Album Only](#album-only) and [Artist Extraction](#artist-extraction) searches fail to return results you can additionally enable **Free Text** search. This will search Musicbrainz for **all** text of your Scrobble data artist/title/album, without constraint. **This is not automatic. You must set `fallbackFreeTextSeach: true` to enable this additional search.**
<details>
<summary>Free Text (`freetext`)</summary>
This will search Musicbrainz for **all** text of your Scrobble data artist/title/album, without constraint.
:::warning
Free text search is **unconstrained** which means that Musicbrainz will match text in **any** part of a Recording (artist, release, or recording field), regardless of where it is found. This may lead to results that are unexpected and undesired.
If you know your Source's Play data is well organized you should not enable this. Free Text search should only be used if:
If you know your Source's Play data is well organized you **should not** enable this. Free Text search should only be used if:
* your music is not well organized or
* there may be many alternative titles/artists for the music you listen to (such as with [psuedo-releases](https://wiki.musicbrainz.org/Release#Status))
@@ -394,10 +619,19 @@ If you know your Source's Play data is well organized you should not enable this
// ...
"defaults": {
// ...
"fallbackFreeTextSearch": true
// will only search using free text search of all artist/album/title
"searchOrder": ["freetext"],
}
```
</details>
:::note
If all defined search methods do not return any results then the stage is marked as [**failed** (`onFailure`) for **Flow Control**](/configuration/transforms/#flow-control).
:::
### Refining
### Score
@@ -463,14 +697,17 @@ You may want to filter the majority of your matches by releases but allow matchi
### Sorting
Each [Release Attribute](#release-attribute) has one additional property that can be used to **rank** releases based on the order of the values you give it. This is the `priority` property.
*After* matches have been [filtered](#filtering), the remaining matches will have their releases sorted. Release with an attribute that does not match are **not** removed, but they are sorted lower than releases that do match.
*After* matches have been [filtered](#filtering), the remaining matches *and their releases** can be sorted. Matches/Releases with an attribute that does not match are **not** removed, but they are sorted lower than matches that do match.
Sorting can be a good alternative to filtering: with filters there is a possibility your filters may eliminate all matches; if you want to ensure that **some** match will be used then sorting can ensure that the **best choice** out of those given will always be used, without accidentally ending up with **no choice**.
Sorting can be used instead of filters, or in conjunction with filters, it's your choice.
#### Release Attributes {#sorting-releases}
Each [Release Attribute](#release-attributes) has one additional property that can be used to **rank** releases based on the order of the values you give it. This is the `priority` property.
In configuration:
```
@@ -485,7 +722,58 @@ EX to prefer albums, then singles, over everything else
"releaseGroupPrimaryTypePriority": ["album", "single"]
```
If a rule is not present then multi-scrobbler defaults it to `true`.
#### Field Scoring
Matches can additionally be sorted/ranked based on how similar their fields are to the original Scrobble. Use these properties for sorting when you want the final Musicbrainz match to be as closely matched to the original Scrobble, as opposed to what may be the most "correct" match based on the Musicbrainz score or suggested Release.
<details>
<summary>Example Scenario</summary>
You scrobble [this track from spotify](https://open.spotify.com/track/21trRQA61afzljSK9V0SHX), which has an English title, Album name, and Artist name.
```json
{
"track": "Price",
"artists": ["ATLUS Sound Team"],
"album": "PERSONA5 ORIGINAL SOUNDTRACK"
}
```
However, the [Recording found by Musicbrainz](https://beta.musicbrainz.org/search?query=isrc%3AJPK651601515&type=recording&limit=25&method=advanced) has multiple Releases (albums). The first suggested release is a *related* Album with similar name (`Persona 25th Anniversary Deluxe Vinyl Box Set`) but it's not the same as your album. Additionally, the artists for this album are in Japanese, rather than English.
You have used `releaseStatusPriority` to prioritize `psuedo-release` which does work but there are still multiple releases chosen, and some are non-English (`『ペルソナ5』オリジナル・サウンドトラック`).
Using `"albumWeight": 0.4` and `"artistWeight": 0.3` ensures that the releases that have an album name, and artist names, more similar to your original scrobble are ranked higher. Resulting in [the correct Release (`PERSONA5 ORIGINAL SOUNDTRACK`)](https://beta.musicbrainz.org/release/82de33b1-1cd6-4236-b116-561d0ecc8acf) being chosen as the final match.
</details>
Add one or more of these weight properties to your [Stage Configuration](/configuration/transforms#configuring-stages) to enable Field Scoring:
```json5
// ...
"defaults": {
// ...
// enables album text similiarity scoring
"albumWeight": 0.33,
// enables title text similiarity scoring
"titleWeight": 0.33,
// enables artist text similiarity scoring
"artistWeight": 0.33
}
```
While not enforced, it's a good idea to keep these weights under `1`. And if using more than one weight, they should be add up to `1`.
<details>
<summary>How Scoring is Combined</summary>
The score similarity from `albumWeight` will be added to the score accumulated by [Release Attributes](#sorting-releases) to affect the final ranking of each Release for a Match/Recording.
In the final sorting of Recordings, title score + artist score is combined with the top ranked release album score. The top ranked score is then used to choose the matched Recording.
</details>
## Best Practices
@@ -506,16 +794,70 @@ For a more opinionated match that will mirror what you would expect from data fr
}
```
Consider adding [Artist Extraction](./?fallbackArtist=native#artist-extraction) in **Native Mode** if any of your Sources do not support multiple artists or your music collection is not tagged well.
Consider adding [Artist Extraction (`artist`)](#search-methods) in **Native Mode** if any of your Sources do not support multiple artists or your music collection is not tagged well.
<details>
```json5
{
// add the line below to the sensible defaults above
// (don't forget commas)
"fallbackArtistSearch": "native"
// use official release over anything else
"releaseStatusPriority": ["official"],
// prefer album, then single, then ep
"releaseGroupPrimaryTypePriority": ["album", "single", "ep"],
// prefer worldwide release
"releaseCountryPriority": ["XW"],
// search using extracted artist as last search attempt
"searchOrder": ["isrc", "basic", "artist"],
"searchArtistMethod": "native"
}
```
</details>
### Search Considerations
How complete, and accurate, your scrobble data is from a certain Source should dictate what [Search Methods](#search-methods) you should use for matching.
Musicbrainz agressively normalizes **artist, album, and title** fields in its database which means that if your Scrobble data contains major innaccuracies or phrases fields in a non-normal way, it's possible Musicbrainz won't find any matches. This is a more common occurrence when trying to match Scrobble data from Sources that don't support multiple artist data, like [Subsonic](/configuration/sources/subsonic) and [Last.fm](/configuration/sources/lastfm-source).
<details>
<summary>Examples of Bad Data</summary>
Last.fm Scrobble returns an Artist in the title and combines two artists into one string:
```json
{
"title": "Endless Possibility (feat. Wheatus)",
"artists": ["Bowling For Soup & Punk Rock Factory"]
}
```
The corresponding [Musicbrainz Recording](https://musicbrainz.org/release/85bf284b-8b39-414e-8ad9-61f593072588) has all artists separated and no artist in the title:
```json
{
"title": "Endless Possibility",
"artists": ["Bowling For Soup", "Punk Rock Factory", "Wheatus"]
}
```
</details>
**In general, you should prioritize methods that search by unique identifiers** (`isrc` `mbidRecording` `basicOrIds`) if you know your Sources may contain *accurate* data for these. Such as: Spotify, Jellyfin, Plex, and Listenbrainz (Source).
Use field-based methods if your Sources do not return IDs consistently (or at all). Add more field-based methods the more inaccurate your scrobble data may be, but be aware that more aggressive/broad searches may return less accurate results.
<DetailsAdmo type="tip" summary="Matching Scrobbles from Last.fm">
Last.fm is inconsistent when it comes to matching your scrobbles. It will accept (almost) any fields for track/title/album and aggressively attempt to match/correct these, regardless of your intentions.
Unless the client scrobbling to Last.fm is also sending an `mbid`, it's likely your scrobble will not be **consistently** matched correctly and so the `mbid` supplied by last.fm in its scrobble data will be wrong.
Therefore, you should *avoid* using `mbidRecording` and `basicOrIds` as the primary search methods (or understand the risks of using them). Instead, prefer to use field-based methods *before* falling back to id-based methods.
</DetailsAdmo>
### Filter Considerations
When using your own filters consider:
@@ -527,7 +869,7 @@ When using your own filters consider:
### Using Partial Match
Use [Rules](#rules) to apply MusicBrainz match data selectively.
Use [Rules](#rules-and-hooks) to apply MusicBrainz match data selectively.
If you know that your music collection is well organized and you do not want to change the artists/title/album etc... sent to a [Client](/configuration/clients), you can still benefit from matches by only applying MBIDs using `meta` so that any Client that supports Musicbrainz data ([Koito](/configuration/clients/koito), [Tealfm](/configuration/clients/tealfm), [Listenbrainz](/configuration/clients/listenbrainz), [Rocksky](/configuration/clients/rocksky)) can still get that data.
@@ -571,7 +913,7 @@ If
Enable logging by turning on [**Debug Mode**](/configuration#debug-mode) to help diagnose any issues with the Musicbrainz API and Scrobble enhancement. **Before creating an issue** please enable logging and include any logs with your issue as this is needed to debug.
If you have multiple Modification Stages and need to see the diff for your Play between each Stage, enable `"log": "all"` in the individual [Modification Stage](http://localhost:3000/docs/configuration/transforms/musicbrainz/?fallbackArtist=native#artist-extraction).
If you have multiple Modification Stages and need to see the diff for your Play between each Stage, enable `"log": "all"` in the individual [Modification Stage](#rules-and-hooks).
<details>
@@ -682,7 +1024,8 @@ Your [AIO Config](/configuration?configType=aio#configuration-types):
"releaseStatusPriority": ["official"],
"releaseGroupPrimaryTypePriority": ["album", "single", "ep"],
"releaseCountryPriority": ["XW"],
"fallbackArtistSearch": "native"
"searchArtistMethod": "native"
"searchOrder": ["isrc", "basic", "artist"]
}
}
]
@@ -743,9 +1086,9 @@ Your [AIO Config](/configuration?configType=aio#configuration-types):
}
```
In a [Jellyfin](/configuration/clients/jellyfin) [File Config](/configuration?configType=file#configuration-types):
In a [Jellyfin](/configuration/sources/jellyfin) [File Config](/configuration?configType=file#configuration-types):
```json5 title="subsonic.json"
```json5 title="jellyfin.json"
[
{
"name": "MyJellyfin",
@@ -768,4 +1111,277 @@ In a [Jellyfin](/configuration/clients/jellyfin) [File Config](/configuration?co
}
]
```
</details>
### Use Native Stage if no Musicbrainz Matches
* Musicbrainz Stage configured with
* [Sensible Defaults](#sensible-default)
* Fallback search with [Artist Extraction](#search-methods)
* [Default Native Stage](/configuration/transforms/native/#default-stage)
* Uses [Flow Control](/configuration/transforms#flow-control) to run Native only if there are no Musicbrainz matches
<details>
<summary>Example</summary>
Your [AIO Config](/configuration?configType=aio#configuration-types):
```json5 title="config.json"
{
// ...
"transformers": [
{
"type": "musicbrainz",
"name": "MyMB",
"data": {
"apis": [
{
"contact": "contact@mydomain.com"
}
]
},
"defaults": {
"releaseStatusPriority": ["official"],
"releaseGroupPrimaryTypePriority": ["album", "single", "ep"],
"releaseCountryPriority": ["XW"],
"searchArtistMethod": "native",
"searchOrder": ["isrc","basic", "artist"]
}
}
]
}
```
In a [Jellyfin](/configuration/sources/jellyfin) [File Config](/configuration?configType=file#configuration-types):
```json5 title="jellyfin.json"
[
{
"name": "MyJellyfin",
"data": { /* ... */},
"options": {
"playTransform": {
"preCompare": [
{
// if musicbrainz is successful then do NOT run native,
// only run native if musicbrainz fails to find a match (onFailure)
"type": "musicbrainz",
"name": "MyMB"
"onSuccess": "stop",
"onFailure": "continue"
},
{
"type": "native"
}
]
}
}
}
]
```
</details>
### Different Search Methods Based on Source (Last.fm and Spotify) {#override-stage-configuration-example}
[Last.fm has unreliable MBIDs](#search-considerations) and Spotify provides an [ISRC](https://musicbrainz.org/doc/ISRC) and consistent formatting.
* For Spotify, we want to rely on ID [searches](#search-methods) and matches that are [close to original scrobble text](#field-scoring)
* For Last.fm, we want to use only text searches and take whatever correction is given to us
Use [**Per Component Overrides**](#rules-and-hooks) with the default (or [sensible](#sensible-default)) [Stage Configuration](#stage-configuration) to specify different search behavior for each Source.
<details>
<summary>Example</summary>
Stage Configuration
```json5 title="config.json"
{
// ...
"transformers": [
{
"type": "musicbrainz",
"name": "MyMB",
"data": {
"apis": [
{
"contact": "contact@mydomain.com"
}
],
"defaults": {} // maybe use sensible?
},
}
]
}
```
```json5 title="lastfm.json"
[
{
"name": "MyLFM",
"configureAs": "source"
"data": { /* ... */},
"options": {
"playTransform": {
"preCompare": [
{
"type": "musicbrainz",
"name": "MyMB",
"searchArtistMethod": "native"
// does not use any ID searches
// fallback to more aggressive/broad searches
"searchOrder": ["basic", "artist", "freetext"]
}
]
}
}
}
]
```
```json5 title="spotify.json"
[
{
"name": "MySpotify",
"data": { /* ... */},
"options": {
"playTransform": {
"preCompare": [
{
"type": "musicbrainz",
"name": "MyMB",
// use ISRC as first search
"searchOrder": ["isrc", "basic"]
// bias matches towards similarity to original data
"albumWeight": 0.33,
"titleWeight": 0.33,
"artistWeight": 0.33
}
]
}
}
}
]
```
</details>
### Use Metadata for Discord Album Art
The [Discord](/configuration/clients/discord) Client can fetch album art images from [Cover Art Archive](http://coverartarchive.org/) if the Scrobble data contains a Release MBID. Use the Musicbrainz Stage on the `preCompare` hook for your Discord client so that missing Musicbrainz IDs are populated for this functionality.
<details>
<summary>Example</summary>
<Tabs groupId="configType" queryString>
<TabItem value="env" label="ENV">
Using the [ENV Configuration](#env-configuration) from above, add these fields to your docker compose `environment:`
```yaml
- MB_CONTACT=contact@mydomain.com
- MB_PRESETS=id,native,sensible
- DISCORD_TRANSFORMS=musicbrainz
```
</TabItem>
<TabItem value="file" label="File">
Your [AIO Config](/configuration?configType=aio#configuration-types):
```json5 title="config.json"
{
// ...
"transformers": [
{
"type": "musicbrainz",
"name": "MyMB",
"data": {
"apis": [
{
"contact": "contact@mydomain.com"
}
]
},
"defaults": {
// sensible defaults
"releaseStatusPriority": ["official"],
"releaseGroupPrimaryTypePriority": ["album", "single", "ep"],
"releaseCountryPriority": ["XW"],
"searchArtistMethod": "native",
"searchOrder": ["isrc","basic", "artist"]
}
}
]
}
```
In your [Discord](/configuration/clients/discord) [File Config](/configuration?configType=file#configuration-types):
```json5 title="discord.json"
[
{
"name": "MS",
"data": { /* ... */},
"options": {
"playTransform": {
"preCompare": [
{
"type": "musicbrainz",
}
]
}
}
}
]
```
</TabItem>
<TabItem value="aio" label="AIO">
Your [AIO Config](/configuration?configType=aio#configuration-types):
```json5 title="config.json"
{
// ...
"transformers": [
{
"type": "musicbrainz",
"name": "MyMB",
"data": {
"apis": [
{
"contact": "contact@mydomain.com"
}
]
},
"defaults": {
// sensible defaults
"releaseStatusPriority": ["official"],
"releaseGroupPrimaryTypePriority": ["album", "single", "ep"],
"releaseCountryPriority": ["XW"],
"searchArtistMethod": "native",
"searchOrder": ["isrc","basic", "artist"]
}
}
],
"sources": [
{
"name": "MS",
"type": "discord",
"data": { /* ... */},
"options": {
"playTransform": {
"preCompare": [
{
"type": "musicbrainz",
}
]
}
}
}
]
}
```
</TabItem>
</Tabs>
</details>
@@ -75,7 +75,7 @@ Config => extracted artists
### Rules
Each [Rule](/configuration/transforms#stage-rules) should be either a boolean, specifying if the transformed data should be used for this field, or a [`when` condition.](/configuration/transforms#conditional-moditication):
Each [Rule](/configuration/transforms#stage-rules) should be either a boolean, specifying if the transformed data should be used for this field, or a [`when` condition.](/configuration/transforms#conditional-modification):
```json5
{
@@ -96,7 +96,7 @@ If a rule is not present then multi-scrobbler defaults it to `true`.
For your convenience, if you do not define any Native [Stage Configurations](/configuration/transforms#configuring-stages) then multi-scrobbler automatically builds one using the defaults shown in [configuration](#configuration).
This can be used by omitting the `name` in your [modification Stage](/configuration/transforms#modification-stage).
This can be used by omitting the `name` in your [modification Stage](/configuration/transforms#stage).
<details>
@@ -128,15 +128,12 @@ In a [Subsonic](/configuration/sources/subsonic) [File Config](/configuration?co
The default configuration shown above can also be applied using [ENV Config](/configuration?configType=env#configuration-types) for individual Sources/Clients.
Use ENV `*_TRANSFORMS=native` on each Source/Client you wish to apply this stage to. This applies the stage in the [`preTransform` Hook](#/configuration/transforms#lifecycle-hooks) with all [Rules](#rules) enabled.
Use ENV `*_TRANSFORMS=native` on each Source/Client you wish to apply this stage to. This applies the stage in the [`preTransform` Hook](/configuration/transforms#lifecycle-hooks) with all [Rules](#rules) enabled.
The `*` stands for the prefix used for each Source/Client's ENV keys. Refer to the individual Source/Client Configuration sections to find this.
The `*` stands for the prefix used for each Source/Client's ENV keys. Refer to the individual Source/Client Configuration sections to find this. Example
:::tip
Enhancing a scrobble with the `preTransform` hook for a Source means that all Clients that recieve the scrobble get the enhanced version. You only need to apply the transform once, for a Source, to use it everywhere for downstream Clients.
:::
* All [Subsonic Source](/configuration/sources/subsonic/) ENVs look like `SUBSONIC_USER=myuser` etc...
* Use `SUBSONIC_TRANSFORMS=native`
<details>
@@ -36,7 +36,7 @@ Scrobble **Clients** listen for discovered Plays from Sources, then...
* The Client **compares** this Play to all the other scrobbles it has already seen, if the Play is unique (title/artist/album/listened datetime) then...
* The Client **scrobbles** the Play downstream to the scrobble service and adds it as a Scrobble it has seen already
## Lifecyle Hooks
## Lifecycle Hooks
You'll notice there is a pattern above that looks like this:
@@ -84,13 +84,14 @@ For **Clients**:
* `compare` - temporarily modify Play data when it is being compared to see if it was already scrobbled
* `postCompare` - modify Play data before scrobbling it to downstream service and adding to already seen scrobbles
:::tip
<DetailsAdmo type="tip" summary="Transformed Scrobbles Are Permanently Modified">
Keep in mind that modifying Scrobble/Play data earlier in the lifecycle will affect that data at all times later in the lifecycle (except when using the **compare** hook).
For example, to modify the track so it's the same anywhere it is processed in multi-scrobbler you only need to modify it in the **Source's** `preCompare` hook because all later processes will receive the data with the modified track.
:::
</DetailsAdmo>
:::tip[TLDR]
@@ -193,7 +194,7 @@ In a [Subsonic](/configuration/sources/subsonic) [File Config](/configuration?co
"preCompare": [
{
"type": "native"
// when "name" is not defined, uses first found "native" transformer
"name": "MyNativeTransformer" // when "name" is not defined, uses first found "native" transformer
}
]
}
@@ -363,7 +364,7 @@ The actual value of each property may be different for each Stage. Check the doc
Generically, though, each property may be some value **or** an object combining a [`when` condition](#conditional-modification) and that value.
If none of the properties are specified in the stage then it's assumed all transformed data should be used.
**If none of the properties are specified in the stage then it's assumed all transformed data should be used.**
:::note
@@ -371,7 +372,80 @@ Specifying these Rules is **not** the same as [configuring the Stage](#configuri
:::
## Conditional Modification
## Stage Flow Control {#flow-control}
Stages may be optionally configured to **continue** to the next Stage or **stop** (end early) all subsequent Stages, based on the outcome of the currently running Stage.
These three properties can be added to the [Modification Stage](#stage) data, alongside [Rules](#stage-rules):
* `onSuccess` (default `continue`) - If the Stage successfully finishes processing
* `onFailure` (default `stop`) - If the Stage encounters an error while processing, or otherwise fails to achieve the transformation result
* `onSkip` (default `continue`) - If the Stage does not process the Play data due to stage-level [`when`](#conditional-modification) or other stage-specific skip conditions
:::tip
The default behaviors for Flow Control are the same as you would intuitively think Stages should run IE the next Stage you have defined runs if the current Stage does not fail.
Specifying Flow Control is only necessary if the above assumptions are not true for your scenario.
<details>
<summary>Default Flow Control Example</summary>
```json5 title="subsonic.json"
// ...
"options": {
"playTransform": {
"preCompare": [
{
// if this stage is successful, native is run
// if this stage fails, native does not run
"type": "musicbrainz",
"name": "MyMB"
},
{
"type": "native",
"name": "MyNative"
}
]
}
}
```
</details>
:::
<details>
<summary>Customized Flow Control Example</summary>
```json5 title="subsonic.json"
// ...
"options": {
"playTransform": {
"preCompare": [
{
// if musicbrainz is successful then do NOT run native,
// only run native if musicbrainz fails to find a match (onFailure)
"type": "musicbrainz",
"name": "MyMB"
"onSuccess": "stop",
"onFailure": "continue"
},
{
"type": "native",
"name": "MyNative"
}
]
}
}
```
</details>
### Conditionally Run {#conditional-modification}
[Stages](#stage) within a [Hook](#hook), and [Rules](#stage-rules) within each Stage, support a `when` object for testing **if they should be run.**
@@ -379,6 +453,8 @@ The `when` object may have propertes for rule. Each property may be a string or
All parts of an individual `when` clause must test true to "pass" but if **any** `when` clauses pass the Stage/Rule is processed.
If the `when` test does not pass then the Stage is [**skipped (`onSkip`)**](#flow-control).
```json5
{
"when":
@@ -465,9 +541,10 @@ More succinctly:
## Logging
MS can log the output of Stage transformations if/when they occur. In the `playTransform` object of a Source/Client config use `log`:
MS can log a diff of Stage transformations if/when they occur. In the `playTransform` object of a Source/Client config use `log`:
* `"log": true` => Output original play + final transformed output of last Stage in the array
* This can also be enabled by using [`DEBUG_MODE=true`](/configuration/#debug-mode)
* `"log": "all"` => Output original play + final transformed output of **each** Stage in the array
```json5
@@ -481,4 +558,37 @@ MS can log the output of Stage transformations if/when they occur. In the `playT
}
}
}
```
```
<details>
<summary>Example</summary>
The output shows the diff between the previous stage (or original Play) and the current stage. In docker logs this is highlighted with diff syntax:
```diff
[2025-12-17 08:53:10.467 -0500] DEBUG : [App] [Sources] [Lastfm - mylfm] [Play Transform] [preCompare] [VLDJJo] Transform Diff
- Original
+ musicbrainz-MyMB
Title : Demons Theme Part II (original 12" mix)
Artists : LTJ Bukem
Album Artists: (None)
- Album : Producer 05: Rarities (Original 12" Version)
+ Album : Producer 05: Rarities (original 12" version)
Meta :
* brainz-album: 36759a8a-d3df-47da-a236-60f84fdc0cab
+ * brainz-artist: 28c1b7b7-355a-48b1-b2c4-75b8eb8080ef
+ * brainz-track: a0d51240-7ef1-4676-882e-be9f354075cb
+ * brainz-releaseGroup: e0cce74f-abcc-343b-9390-1673e4d57ce7
```
</details>
## Examples
See **Examples** sections in specific Stage docs (also in the sidebar):
* [User Stage](/configuration/transforms/user#examples)
* [Native Stage](/configuration/transforms/native#examples)
* [Musicbrainz Stage](/configuration/transforms/musicbrainz#examples)
@@ -16,7 +16,7 @@ The user [Stage `type`](/configuration/transforms#stage) is `user`.
## Configuration
All [Stage Configuration](/configuration/transforms#configuring-stage) is done using [**search-and-replace** expressions](#search-and-replace-expression) inside individual [rules](#rules). Default configuration for all Rules can still be done using Stage `defaults`.
All [Stage Configuration](/configuration/transforms#configuring-stages) is done using [**search-and-replace** expressions](#search-and-replace-expression) inside individual [rules](#rules). Default configuration for all Rules can still be done using Stage `defaults`.
<details>
@@ -46,9 +46,9 @@ All [Stage Configuration](/configuration/transforms#configuring-stage) is done u
#### Default Stage
For your convenience, if you do not define any User [Stage Configurations](/configuration/transforms#configuration) then multi-scrobbler automatically builds an empty one for you.
For your convenience, if you do not define any User [Stage Configurations](/configuration/transforms#configuring-stages) then multi-scrobbler automatically builds an empty one for you.
This can be used by omitting the `name` in your [modification Stage](/configuration/transforms#modification-stage).
This can be used by omitting the `name` in your [modification Stage](/configuration/transforms#stage).
<details>
@@ -126,7 +126,7 @@ The `replace` property uses javascript's [`replace()` function and so can use an
### Rules
Each [Rule](/configuration/transforms#stage-rules) must be an array of [search-and-replace expressions](#search-and-replace-expressions):
Each [Rule](/configuration/transforms#stage-rules) must be an array of [search-and-replace expressions](#search-and-replace-expression):
```json5 title="lastfm.json"
[
+12
View File
@@ -178,3 +178,15 @@ For more refer to the TS documentation for `PlayObject` or [`AmbPlayObject`](htt
* [Source Development and Tutorial](dev-source.md)
* [Client Development and Tutorial](dev-client.md)
## Profiling
Run tsx with inspect args
```
NODE_ENV=production node node_modules/.bin/tsx --inspect --heap-prof src/backend/index.ts
```
Use `chrome://inspect` from a chromium-based browser and attach to the running process, usually `localhost:9229`
From the opened DevTools window use Performance or Memory to profile the running process.
+71
View File
@@ -0,0 +1,71 @@
---
title: 'Help'
---
## Getting Useful Data
### Logs
Multi-scrobbeler has a real-time log shown in the dashboard. These are the same logs you would find in docker logs. In the dashboard, logs can be filtered by LEVELS to give you a better view of errors/warnings.
When creating an issue please include all logs at the lowest level possible (DEBUG) to help provide context for your issue. You should try to include logs that occurred *before* and *after* your issue/error occurs as this can help determine if MS was behaving normally.
### Debug Mode
If possible, turn on [**Debug Mode**](/configuration#debug-mode) and replicate your issue. Debug Mode enables *much more* logging that can reveal additional data for troubleshooting.
This mode will make your logs very noisy, though, so it's recommended to turn it off after collecting logs.
### Copy Play Debug Data
From the dashboard, each Source/Client has a few details page links:
<img src={require('/img/details.jpg').default} height="400"/>
Opening the details page for the Source/Client reveals a lists all of the Plays that were discovered (Sources) or scrobbled (Clients).
Click on the Debug icon to copy debugging data relevant to that Play. This data should be included in any issue you create.
<img src={require('/img/debug_button.jpg').default} height="400"/>
To include this data in an issue either paste the copied data into a text file and save as `debugdata.json`, attaching to the issue.
Or directly paste the copied data into an issue/comment using [**fenced code blocks**](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#fenced-code-blocks) markdown to preserve the structure like:
````
This is the contents of my comment/issue text on github.
I am explaining my issue here. Here is the debug data:
```json
{
"input": {
"aProperty: 123,
"foo": "bar"
}
}
```
Thank you for your time.
````
## Finding Help
### FAQ
Check the [FAQ](/FAQ) to see if your issue is a known issue or a commonly-experienced issue with Multi-Scrobbler. The FAQ also includes fixes or ways to help troubleshoot these common issues.
### Existing Issues
On the github repository for Multi-Scrobbler, search [existing issues](https://github.com/FoxxMD/multi-scrobbler/issues?q=sort%3Aupdated-desc) and [discussions](https://github.com/FoxxMD/multi-scrobbler/discussions) to see if anyone else has had this issue and if it has already been solved.
## Reporting an Issue
Before reporting an issue please consider:
* If this a how-do-I question, troublehooting, or generally **not** a bug/error with multi-scrobbler please consider [**starting a discussion**](https://github.com/FoxxMD/multi-scrobbler/discussions) instead of opening an issue
* If you want to request new functionality use the [**Feature Request issue** template](https://github.com/FoxxMD/multi-scrobbler/issues/new?template=02-feature-request.yml)
* If you want to request a new Source/Client implementation use the [**New Source/Client issue** template](https://github.com/FoxxMD/multi-scrobbler/issues/new?template=03-new-source-client.yml)
If none of the above apply to you then create a new [**bug report**](https://github.com/FoxxMD/multi-scrobbler/issues/new?template=01-bug-report.yml). Please include all [logs](#logs) and [play debug data](#copy-play-debug-data) relevant to your issue. The more logs the better. If possible, replicate the issue with [**debug mode** turned on](#debug-mode).
+8 -4
View File
@@ -10,9 +10,9 @@ sidebar_position: 1
<img src={require('/img/icon.png').default} align="right" alt="multi-scrobbler logo" width="180" height="180"/>
A javascript app to scrobble music you listened to, to [Maloja](https://github.com/krateng/maloja), [Last.fm](https://www.last.fm), [ListenBrainz](https://listenbrainz.org), and [Koito](https://koito.io/).
A dockerized app that monitors your music listening activity from *everywhere* and scrobbles it *anywhere*.
* Supports scrobbling from many [**Sources**](/configuration/sources)
* Supports monitoring activity from many [**Sources**](/configuration/sources)
* [Azuracast](/configuration/sources/azuracast)
* [Deezer](/configuration/sources/deezer)
* [Google Cast (Chromecast)](/configuration/sources/google-cast)
@@ -22,6 +22,7 @@ A javascript app to scrobble music you listened to, to [Maloja](https://github.c
* [Kodi](/configuration/sources/kodi)
* [Koito](/configuration/sources/koito-source)
* [Last.fm](/configuration/sources/lastfm-source)
* [Libre.fm](/configuration/sources/librefm-source)
* [Last.fm (Endpoint)](/configuration/sources/lastfm-endpoint)
* [ListenBrainz](/configuration/sources/listenbrainz-source)
* [ListenBrainz (Endpoint)](/configuration/sources/listenbrainz-endpoint)
@@ -32,6 +33,7 @@ A javascript app to scrobble music you listened to, to [Maloja](https://github.c
* [Musikcube](/configuration/sources/musikcube)
* [Plex](/configuration/sources/plex)
* [Rocksky](/configuration/sources/rocksky-source)
* [Sonos](/configuration/sources/sonos)
* [Spotify](/configuration/sources/spotify)
* [Subsonic-compatible APIs](/configuration/sources/subsonic) (like [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/))
* [teal.fm](/configuration/sources/tealfm-source)
@@ -40,8 +42,10 @@ A javascript app to scrobble music you listened to, to [Maloja](https://github.c
* [Yamaha MusicCast](/configuration/sources/yamaha-musiccast)
* [Youtube Music](/configuration/sources/youtube-music)
* Supports scrobbling to many [**Clients**](/configuration/clients)
* [Discord](/configuration/clients/discord) (Now Playing)
* [Koito](/configuration/clients/koito)
* [Last.fm](/configuration/clients/lastfm)
* [Libre.fm](/configuration/clients/librefm)
* [ListenBrainz](/configuration/clients/listenbrainz)
* [Maloja](/configuration/clients/maloja)
* [Rocksky](/configuration/clients/rocksky)
@@ -80,7 +84,7 @@ You set up [configurations](/configuration) for one or more [**Sources**](/confi
### Source
A [**Source**](/configuration/sources) is a data source that contains information about music you are playing or have listened to, like a desktop player, web music player, or cloud music service. Examples are **Spotify, Jellyfin, Plex, Youtube Music, Navidrome**, etc...
A [**Source**](/configuration/sources) is a data source that contains information about music you are playing or have listened to, such as: a desktop player, web music player, or cloud music service. Examples are **Spotify, Jellyfin, Plex, Youtube Music, Navidrome**, etc...
Source configurations consist of:
@@ -90,7 +94,7 @@ Source configurations consist of:
### Client
A [**Client**](/configuration/clients) is an application that stores the historical information about what music you have played (scrobbles). Examples are **Maloja, Last.fm, Listenbrainz**...
A [**Client**](/configuration/clients) is an application that stores the historical information about what music you have played (scrobbles). Examples are **Koito, Last.fm, Listenbrainz**...
Client configurations consist of:
+19 -4
View File
@@ -64,7 +64,7 @@ You should bind a host directory into the container for storing configurations a
docker run ... -v "$(pwd)/config:/config" foxxmd/multi-scrobbler
```
</TabItem>
<TabItem value="docker-compose" label="Docker Compose">
<TabItem value="docker-compose" label="Docker Compose" default>
[Using docker-compose](https://docs.docker.com/compose/compose-file/compose-file-v3/#short-syntax-3):
```yaml title="docker-compose.yml"
@@ -94,7 +94,7 @@ If you are using a [bridge network](https://www.appsdeveloperblog.com/docker-net
docker run ... -p 9078:9078 foxxmd/multi-scrobbler
```
</TabItem>
<TabItem value="docker-compose" label="Docker Compose">
<TabItem value="docker-compose" label="Docker Compose" default>
[docker-compose](https://docs.docker.com/compose/compose-file/compose-file-v3/#short-syntax-1):
```yaml title="docker-compose.yml"
@@ -130,7 +130,7 @@ set the [Base URL](../configuration/configuration.mdx#base-url) as the IP of the
docker run ... -e BASE_URL="http://hostMachineIP" foxxmd/multi-scrobbler
```
</TabItem>
<TabItem value="docker-compose" label="Docker Compose">
<TabItem value="docker-compose" label="Docker Compose" default>
[docker-compose](https://docs.docker.com/compose/compose-file/compose-file-v3/#short-syntax-1):
```yaml title="docker-compose.yml"
@@ -162,6 +162,21 @@ To get the UID and GID for the current user run these commands from a terminal:
::::
#### Read Only
MS can be hardended by setting the file system as read only with [`read_only`](https://docs.docker.com/reference/compose-file/services/#read_only), with a few exceptions:
```yaml title="docker-compose.yml"
services:
multi-scrobbler:
image: foxxmd/multi-scrobbler
# ...
read_only: true
tmpfs:
- /run:exec
- /tmp:noexec
```
### Docker Usage Example
:::tip
@@ -194,7 +209,7 @@ The example scenario:
</TabItem>
</Tabs>
</TabItem>
<TabItem value="docker-compose" label="Docker Compose">
<TabItem value="docker-compose" label="Docker Compose" default>
See [`docker-compose.yml`](#docker) sample above for more options and annotations.
```yaml title="docker-compose.yml"
+141 -60
View File
@@ -10,7 +10,7 @@ This guide will get you up and running with multi-scrobbler using [Docker](https
* the dashboard served on port `9078` of a host machine which has an IP of `192.168.0.100`
* data saved to the same directory as the `docker-compose.yml` file
* multi-scrobbler monitoring [Spotify](/configuration/sources/spotify), [Jellyfin](/configuration/sources/jellyfin), Navidrome, [Plex](/configuration/sources/plex), and/or [Last.fm](/configurations/sources/lastfm) for listening activity
* multi-scrobbler monitoring [Spotify](/configuration/sources/spotify), [Jellyfin](/configuration/sources/jellyfin), Navidrome, [Plex](/configuration/sources/plex), and/or [Last.fm](/configuration/sources/lastfm-source) for listening activity
* multi-scrobbler scrobbling to [Lastfm](/configuration/clients/lastfm), [Maloja](/configuration/clients/maloja), and/or [Koito](/configuration/clients/koito)
:::note
@@ -44,7 +44,7 @@ services:
[**Sources**](/configuration/sources) are the services/music players multi-scrobbler monitors to look for listening activity.
<Tabs>
<Tabs groupId="qsSource">
<TabItem value="jellyfin" label="Jellyfin">
Follow the Jellyfin configuration [instructions for setting up an **API Key**.](/configuration/sources/jellyfin)
@@ -126,31 +126,156 @@ services:
After account creation make note of the **Api Key** and **Secret** that are displayed.
Create a new [File](/configuration?configType=file#configuration-types) named `lastfm.json` in the `./config` directory that will be used with your [`docker-compose.yml` stack](#create-docker-compose-file) and copy the below contents, replacing placeholders with the data you got from Last.fm API account creation:
Add these values to the `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file)
```json title="~/msData/config/lastfm.json"
[
{
"name": "myLastFmSource",
"configureAs": "source",
"data": {
"apiKey": "MY_API_KEY_PLACEDHOLDER",
"secret": "MY_SECRET_PLACEHOLDER",
"redirectUri": "http://192.168.0.100:9078/lastfm/callback"
}
}
]
```yaml title="~/msData/docker-compose.yml"
- SOURCE_LASTFM_API_KEY=MY_API_KEY_PLACEDHOLDER
- SOURCE_LASTFM_SECRET=MY_SECRET_PLACEHOLDER
- SOURCE_LASTFM_REDIRECT_URI=http://192.168.0.100:9078/lastfm/callback
```
Later, after [starting multi-scrobbler](#start-multi-scrobbler), visit the dashboard at `http://192.168.0.100:9078` and click **(Re)authenticate** on the **Last.fm (Source)** card to authorize multi-scrobbler to use your account. Monitoring will begin automatically after authorization is complete.
</TabItem>
</Tabs>
## (Optional) Correct Scrobbles with Musicbrainz
Multi-scrobbler can use [Musicbrainz](https://musicbrainz.org/) to match activity from your Sources in order to [fill in missing data](/configuration/transforms/musicbrainz), or correct/normalize existing data, before it is scrobbled to the [Clients](#setup-clients) below. This step is optional.
<details>
<summary>Musicbrainz Setup Instructions</summary>
<h3>Configure Musicbrainz API</h3>
:::note
**This step only needs to be performed once** regardless of how many Sources you want to use Musicbrainz for.
:::
You must provide a way for Musicbrainz to [contact you.](https://wiki.musicbrainz.org/MusicBrainz_API/Rate_Limiting#How_can_I_be_a_good_citizen_and_be_smart_about_using_the_Web_Service?)
Add these value to the `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file)
```yaml title="~/msData/docker-compose.yml"
# an email or personal website musicbrainz can use to contact you
- MB_CONTACT=myCoolName@emailProvider.com
# how musicbrainz searches and selects matches
# isrc => then tries basic text fields => then tries extracted artists
- MB_PRESETS=default,sensible,native
```
**Presets** are found [here](/configuration/transforms/musicbrainz/#env-configuration).
<h3>Enable Musicbrainz For A Source</h3>
Musicbrainz can be enabled for multiple Sources. Follow the directions in each tab to enable it for that Source.
<Tabs groupId="qsSource">
<TabItem value="jellyfin" label="Jellyfin">
Add this value to the `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file)
```yaml title="~/msData/docker-compose.yml"
- JELLYFIN_TRANSFORMS=musicbrainz
```
</TabItem>
<TabItem value="spotify" label="Spotify">
Add this value to the `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file)
```yaml title="~/msData/docker-compose.yml"
- SPOTIFY_TRANSFORMS=musicbrainz
```
</TabItem>
<TabItem value="navidrome" label="Navidrome">
Add this value to the `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file)
```yaml title="~/msData/docker-compose.yml"
- LZE_TRANSFORMS=musicbrainz
```
</TabItem>
<TabItem value="plex" label="Plex">
Add this value to the `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file)
```yaml title="~/msData/docker-compose.yml"
- PLEX_TRANSFORMS=musicbrainz
```
</TabItem>
<TabItem value="lastfm" label="Last.fm">
Modify the `lastfm.json` file you created in the [Setup Sources](#setup-sources) step to add the highlighted section in the example below. The comma at the top highlighted section is important!
```json title="~/msData/config/lastfm.json"
[
{
"name": "myLastFmSource",
"configureAs": "source",
"data": {
"apiKey": "MY_API_KEY_PLACEDHOLDER",
"secret": "MY_SECRET_PLACEHOLDER",
"redirectUri": "http://192.168.0.100:9078/lastfm/callback"
// highlight-start
},
"options": {
"playTransform": {
"preCompare": {
"type": "musicbrainz"
}
}
}
// highlight-end
}
]
```
</TabItem>
</Tabs>
</details>
## Setup Clients
[**Clients**](/configuration/clients) are services that store scrobbles. Multi-scrobbler will scrobble all listening activity from the **Sources** you configured to all **Clients** you configure here.
<Tabs>
<Tabs groupId="qsClient">
<TabItem value="koito" label="Koito">
Setup a [Koito server](https://koito.io/guides/installation/) if you have not already done this.
* [Create (or get) an API Key](https://koito.io/guides/scrobbler/)
* From your Koito server dashboard navigate to **Settings** (bottom-left icon) => **API Keys**
* Create a new Key (or use an existing) and Copy the key using the copy icon to the right of the key
* EX `pM195xPV98CDpk0QW47FIIOR8AKATAX5DblBF-Jq0t1MbbKL`
* Take note of your Koito username (used below as `myUser`)
* Determine your Koito URL
* This is the URL you use to access your Koito dashboard OR whatever URL is accessible from your multi-scrobbler instance.
* EX dashboard at `http://192.168.0.100:4110` => replace `myURL` below with `http://192.168.0.100:4110`
* [More info on the URL to use is the full docs](/configuration/clients/koito)
Add/Substitute values above into these examples values and add them to the `environment` section in the [`docker-compose.yml` you created for multi-scrobbler earlier.](#create-docker-compose-file)
```yaml title="~/msData/docker-compose.yml"
- KOITO_TOKEN=myToken
- KOITO_USER=myUser
- KOITO_URL=myURL
```
:::tip
Ensure that Koito is configured to allow requests from multi-scrobbler! In Koito config set [`KOITO_ALLOWED_HOSTS`](https://koito.io/reference/configuration/#koito_allowed_hosts) to the IP the multi-scrobbler dashboard is accessible from.
:::
</TabItem>
<TabItem value="lastfm" label="Last.fm">
[Register for an API account at Last.fm.](https://www.last.fm/api/account/create)
Use the following for **Callback URL**:
```
http://192.168.0.100:9078/lastfm/callback
```
After account creation use the displayed information and add these values to the `environment` section in the [`docker-compose.yml` you created for multi-scrobbler earlier.](#create-docker-compose-file)
```yaml title="~/msData/docker-compose.yml"
- LASTFM_API_KEY=myApiKey
- LASTFM_SECRET=myApiSecret
```
</TabItem>
<TabItem value="maloja" label="Maloja">
Setup a [Maloja server](https://github.com/krateng/maloja?tab=readme-ov-file#how-to-install) if you have not already done this.
@@ -183,50 +308,6 @@ services:
- MALOJA_API_KEY=myApiKey
```
</TabItem>
<TabItem value="lastfm" label="Last.fm">
[Register for an API account at Last.fm.](https://www.last.fm/api/account/create)
Use the following for **Callback URL**:
```
http://192.168.0.100:9078/lastfm/callback
```
After account creation use the displayed information and add these values to the `environment` section in the [`docker-compose.yml` you created for multi-scrobbler earlier.](#create-docker-compose-file)
```yaml title="~/msData/docker-compose.yml"
- LASTFM_API_KEY=myApiKey
- LASTFM_SECRET=myApiSecret
```
</TabItem>
<TabItem value="koito" label="Koito">
Setup a [Koito server](https://koito.io/guides/installation/) if you have not already done this.
* [Create (or get) an API Key](https://koito.io/guides/scrobbler/)
* From your Koito server dashboard navigate to **Settings** (bottom-left icon) => **API Keys**
* Create a new Key (or use an existing) and Copy the key using the copy icon to the right of the key
* EX `pM195xPV98CDpk0QW47FIIOR8AKATAX5DblBF-Jq0t1MbbKL`
* Take note of your Koito username (used below as `myUser`)
* Determine your Koito URL
* This is the URL you use to access your Koito dashboard OR whatever URL is accessible from your multi-scrobbler instance.
* EX dashboard at `http://192.168.0.100:4110` => replace `myURL` below with `http://192.168.0.100:4110`
* [More info on the URL to use is the full docs](/configuration/clients/koito)
Add/Substitute values above into these examples values and add them to the `environment` section in the [`docker-compose.yml` you created for multi-scrobbler earlier.](#create-docker-compose-file)
```yaml title="~/msData/docker-compose.yml"
- KOTIO_TOKEN=myToken
- KOTIO_USER=myUser
- KOITO_URL=myURL
```
:::tip
Ensure that Koito is configured to allow requests from multi-scrobbler! In Koito config set [`KOITO_ALLOWED_HOSTS`](https://koito.io/reference/configuration/#koito_allowed_hosts) to the IP the multi-scrobbler dashboard is accessible from.
:::
</TabItem>
</Tabs>
## Start Multi-Scrobbler
+4 -3
View File
@@ -71,7 +71,7 @@ const config: Config = {
],
],
themes: [
"docusaurus-json-schema-plugin",
//"docusaurus-json-schema-plugin",
[
"@easyops-cn/docusaurus-search-local",
/** @type {import("@easyops-cn/docusaurus-search-local").PluginOptions} */
@@ -90,6 +90,7 @@ const config: Config = {
'docusaurus-theme-github-codeblock'
],
plugins: [
'docusaurus-plugin-sass',
[
'@docusaurus/plugin-client-redirects',
{
@@ -160,7 +161,7 @@ const config: Config = {
],
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
@@ -202,7 +203,7 @@ const config: Config = {
prism: {
theme: themes.themes.github,
darkTheme: themes.themes.dracula,
additionalLanguages: ['json','json5','typescript', 'docker', 'bash', 'ini']
additionalLanguages: ['json','json5','typescript', 'docker', 'bash', 'ini', 'diff']
},
colorMode: {
defaultMode: 'dark',
+1422 -102
View File
File diff suppressed because it is too large Load Diff
+11 -3
View File
@@ -11,7 +11,8 @@
"serve": "docusaurus serve",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids",
"typecheck": "tsc"
"typecheck": "tsc",
"postinstall": "patch-package"
},
"dependencies": {
"@docusaurus/core": "3.8.1",
@@ -20,15 +21,22 @@
"@docusaurus/preset-classic": "3.8.1",
"@easyops-cn/docusaurus-search-local": "0.51.1",
"@mdx-js/react": "^3.0.0",
"ajv": "^8.18.0",
"ajv-formats": "^3.0.1",
"cf-json-schema-viz": "^0.3.0",
"clsx": "^2.0.0",
"docusaurus-json-schema-plugin": "^1.14.0",
"docusaurus-plugin-sass": "^0.2.6",
"docusaurus-theme-github-codeblock": "^2.0.2",
"json5": "^2.2.3",
"micromark-extension-directive": "^3.0.1",
"modern-react-json-editor": "^1.0.2",
"patch-package": "^8.0.1",
"prism-react-renderer": "^2.3.0",
"raw-loader": "^4.0.2",
"react": "^19.0.0",
"react-dom": "^19.0.0"
"react-dom": "^19.0.0",
"react-markdown": "^10.1.0",
"sass": "^1.97.0"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.6.3",
File diff suppressed because one or more lines are too long
@@ -0,0 +1,47 @@
import Details from '@theme/Details';
import type {Props as DetailProps} from '@theme/Details';
import IconWarning from '@theme/Admonition/Icon/Warning';
import IconDanger from '@theme/Admonition/Icon/Danger';
import IconTip from '@theme/Admonition/Icon/Tip';
import IconNote from '@theme/Admonition/Icon/Note';
import { ReactElement } from 'react';
export interface DetailsAdmoProps extends DetailProps {
type?: 'warning' | 'danger' | 'note' | 'tip'
}
const DetailsAdmo = (props: DetailsAdmoProps) => {
let cn: string = '';
let icon: ReactElement;
switch(props.type) {
case 'warning':
cn = 'alert--warning';
icon = <IconWarning/>;
break;
case 'danger':
cn = 'alert--danger';
icon = <IconDanger/>;
break;
case 'note':
cn = 'alert--secondary';
icon = <IconNote/>;
break;
case 'tip':
cn = 'alert--success';
icon = <IconTip/>
break;
}
const iconWrapper = icon === undefined ? null : <span className="admoIcon">{icon}</span>;
const summary = <summary>{iconWrapper}{props.summary}</summary>;
return <Details className={cn} summary={summary}>
{props.children}
</Details>
};
export default DetailsAdmo;
+86
View File
@@ -0,0 +1,86 @@
import React, { ReactNode, CSSProperties } from 'react';
import clsx from 'clsx';
import Link from '@docusaurus/Link';
// Define the Button type to control the props that can be passed to the Button component.
export type ButtonProps = {
// The size prop can be one of the following values: 'sm', 'lg', 'small', 'medium', 'large', or null.
// We'll convert 'small' to 'sm' and 'large' to 'lg' in the component. 'medium' will be considered null.
size?: 'sm' | 'lg' | 'small' | 'medium' | 'large' | null;
// The outline prop is a boolean that determines if the button should be an outline button.
outline?: boolean;
// The variant prop is a string that determines the color of the button.
// It can be one of the following values: 'primary', 'secondary', 'danger', 'warning', 'success', 'info', 'link', or any other string.
// The default value is 'primary'.
variant: 'primary' | 'secondary' | 'danger' | 'warning' | 'success' | 'info' | 'link' | string;
// The block prop is a boolean that determines if the button should be a block-level button.
block?: boolean;
// The disabled prop is a boolean that determines if the button should be disabled.
disabled?: boolean;
// The className prop is a string that allows you to add custom classes to the button.
className?: string;
// The style prop is an object that allows you to add custom styles to the button.
style?: CSSProperties;
// The link prop is a string that determines the URL the button should link to.
link: string;
// The label prop is a string that determines the text of the button.
label: string;
onClick?: () => any
}
// Button component that accepts the specified props.
export default function Button ({
size = null,
outline = false,
variant = 'primary',
block = false,
disabled = false,
className,
style = {},
link,
label,
onClick = () => null,
...rest
}: ButtonProps) {
// Map the size prop values to corresponding CSS classes.
const sizeMap = {
sm: 'sm',
small: 'sm',
lg: 'lg',
large: 'lg',
medium: null,
};
const buttonSize = size ? sizeMap[size] : '';
const sizeClass = buttonSize ? `button--${buttonSize}` : '';
const outlineClass = outline ? 'button--outline' : '';
const variantClass = variant ? `button--${variant}` : '';
const blockClass = block ? 'button--block' : '';
const disabledClass = disabled ? 'disabled' : '';
// If the button is disabled, set the destination to null.
const destination = disabled ? null : link;
return (
<Link to={destination}>
<button
className={clsx(
'button',
sizeClass,
outlineClass,
variantClass,
blockClass,
disabledClass,
className
)}
style={style}
role='button'
aria-disabled={disabled}
onClick={(e) => {
e.preventDefault();
onClick()
}}
{...rest}
>
{label}
</button>
</Link>
);
}
+82
View File
@@ -0,0 +1,82 @@
import React, { ReactNode, CSSProperties } from 'react';
import clsx from 'clsx';
import Link from '@docusaurus/Link';
import Button, { ButtonProps } from './Button';
const leftButton = {
borderRadius: 'var(--ifm-button-border-radius) 0 0 var(--ifm-button-border-radius)'
}
const rightButton = {
borderRadius: '0 var(--ifm-button-border-radius) var(--ifm-button-border-radius) 0'
}
const middleButton = {
borderRadius: '0'
}
// Define the Button type to control the props that can be passed to the Button component.
type ButtonGroup = {
options: [string, string][]
value?: string
defaultValue?: string
// The size prop can be one of the following values: 'sm', 'lg', 'small', 'medium', 'large', or null.
// We'll convert 'small' to 'sm' and 'large' to 'lg' in the component. 'medium' will be considered null.
size?: 'sm' | 'lg' | 'small' | 'medium' | 'large' | null;
variant: 'primary' | 'secondary' | 'danger' | 'warning' | 'success' | 'info' | 'link' | string;
// The block prop is a boolean that determines if the button should be a block-level button.
block?: boolean;
// The disabled prop is a boolean that determines if the button should be disabled.
disabled?: boolean;
// The className prop is a string that allows you to add custom classes to the button.
className?: string;
// The style prop is an object that allows you to add custom styles to the button.
style?: CSSProperties;
onChange?: (val: string) => any
}
// Button component that accepts the specified props.
export default function ButtonGroup ({
size = null,
variant = 'primary',
block = false,
disabled = false,
className,
style,
options,
value,
defaultValue,
onChange = () => null
}: ButtonGroup) {
if(options === undefined || options.length === 0) {
return null;
}
const buttons = options.map((opt, index) => {
const props: ButtonProps = {
style: middleButton,
outline: true,
size,
variant,
label: opt[1],
link: '#',
onClick: () => onChange(opt[0])
};
if(index === 0) {
props.style = leftButton;
} else if(index === options.length - 1) {
props.style = rightButton;
}
if((value ?? defaultValue) === opt[0]) {
props.outline = false;
}
return <Button key={index} {...props}/>
});
return <span>{buttons}</span>;
}
@@ -0,0 +1,74 @@
import React, { Fragment, useMemo } from "react"
import CodeBlock, {Props as CodeBlockProps} from '@theme/CodeBlock';
import Admonition from '@theme/Admonition';
import ErrorBoundary from "@docusaurus/ErrorBoundary"
import Error from "@theme/Error"
import { Simulate } from "react-dom/test-utils";
import error = Simulate.error;
import json5 from 'json5';
import FileExample, { FileProps } from "./FileExample";
export interface FileConfigProps extends FileProps {
data: string
name: string
configureAs?: 'client' | 'source'
aio?: boolean
filePathName?: string
}
const FileConfigExample = (props: FileConfigProps) => {
const {
data,
configureAs = 'source',
aio = false,
name,
...rest
} = props;
let configObj;
// eslint-disable-next-line prefer-const
try {
configObj = json5.parse(data) as object[];
} catch (e) {
console.error(e);
return <Admonition type="danger" title="Unexpected Error">
<p>Example component crashed because of error!</p>
<CodeBlock>{e.message}</CodeBlock>
</Admonition>
}
const transformed = useMemo(() => {
let content: object;
if(typeof data === 'string') {
content = json5.parse(data);
} else {
content = data;
}
if(configureAs !== undefined && Array.isArray(content)) {
const filtered = content.filter(x => x.configureAs === undefined || x.configureAs === configureAs);
if(aio) {
const configType = configureAs === 'client' ? 'clients' : 'sources';
content = {[configType]: filtered.map(x => ({...x, type: name}))}
} else {
content = filtered;
}
}
return content;
},[data, configureAs, aio, name])
configObj = configObj.filter(x => x.configureAs === undefined || x.configureAs === configureAs);
return <FileExample data={transformed} {...rest}/>
}
const WrappedFileConfigExample = (props: FileConfigProps) => {
return <ErrorBoundary
fallback={({error}) => (
<div>
<p>Example component crashed because of error: {error.message}.</p>
</div>
)}
><FileConfigExample {...props} /></ErrorBoundary>
}
export default WrappedFileConfigExample;
+66 -20
View File
@@ -1,44 +1,90 @@
import React, { Fragment } from "react"
import CodeBlock, {Props as CodeBlockProps} from '@theme/CodeBlock';
import React, { Fragment, useMemo } from "react"
import CodeBlock, { Props as CodeBlockProps } from '@theme/CodeBlock';
import Admonition from '@theme/Admonition';
import ErrorBoundary from "@docusaurus/ErrorBoundary"
import Error from "@theme/Error"
import { Simulate } from "react-dom/test-utils";
import error = Simulate.error;
import json5 from 'json5';
import { useTypedLocalStorage } from "./useLocalStorage";
import ButtonGroup from "./ButtonGroup";
import EditorFetch from '@site/src/components/Schema/SchemaEditorFetch';
import {useWindowSize} from '@docusaurus/theme-common';
export interface FileProps extends Omit<CodeBlockProps, 'children'> {
data: string
client?: boolean
data: string | object
filePathName?: string
schemaName?: string
interactive?: boolean
defaultDisplay?: 'plain' | 'interactive'
readOnlyAtWidth?: number
}
const FileExample = (props: FileProps) => {
const {
data,
client = false,
interactive = true,
defaultDisplay = 'interactive',
schemaName,
filePathName,
readOnlyAtWidth = 1,
...rest
} = props;
let configObj;
// eslint-disable-next-line prefer-const
try {
configObj = json5.parse(data) as object[];
} catch (e) {
console.error(e);
return <Admonition type="danger" title="Unexpected Error">
<p>Example component crashed because of error!</p>
<CodeBlock>{e.message}</CodeBlock>
</Admonition>
const [fileExampleShow, setFileExampleShow] = useTypedLocalStorage('docusaurus.tab.fileExampleShow', defaultDisplay, false);
const windowSize = useWindowSize({desktopBreakpoint: readOnlyAtWidth});
let displaySwitch = null;
const isInteractive = interactive && windowSize === 'desktop'
if (isInteractive) {
displaySwitch = (
<ButtonGroup
options={[['plain', 'Plain'], ['interactive', 'Interactive']]}
defaultValue={defaultDisplay}
value={fileExampleShow}
variant="primary"
size="medium"
onChange={(val) => setFileExampleShow(val as 'interactive' | 'plain')}
/>
);
}
configObj = configObj.filter(x => x.configureAs === undefined || x.configureAs === (client ? 'client' : 'source'));
let fileNameContent = null;
if(filePathName !== undefined && (isInteractive && fileExampleShow === 'interactive')) {
fileNameContent = <code style={{float: 'right', paddingRight: '0.5em', paddingLeft: '0.5em'}}>{filePathName}</code>
}
return <CodeBlock {...rest} language="json5">{JSON.stringify(configObj, null, 2)}</CodeBlock>
let header = null;
if(displaySwitch !== null || fileNameContent !== null) {
header = (
<div style={{marginBottom: '1em'}}>
{displaySwitch}{fileNameContent}
</div>
);
}
const codeBlockContent = useMemo(() =>{
if(isInteractive && fileExampleShow === 'interactive') {
return null;
}
if(typeof data !== 'string') {
return JSON.stringify(data, null, 2);
}
return data;
}, [interactive, fileExampleShow, data]);
return (<Fragment>
{header}
{!isInteractive || fileExampleShow === 'plain' ? <CodeBlock title={filePathName} language="json5">{codeBlockContent}</CodeBlock> : null}
{isInteractive && fileExampleShow === 'interactive' ? <EditorFetch configContent={data} schemaName={schemaName}/> : null}
</Fragment>
);
}
const WrappedFileExample = (props: FileProps) => {
return <ErrorBoundary
fallback={({error}) => (
fallback={({ error }) => (
<div>
<p>Example component crashed because of error: {error.message}.</p>
</div>
@@ -1,6 +1,11 @@
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import CodeBlock from '@theme/CodeBlock';
import ExplorerFetch from '@site/src/components/Schema/ExplorerFetch';
import EditorFetch from '@site/src/components/Schema/SchemaEditorFetch';
import './GenericConfiguration.scss';
import FileConfigExample from './FileConfigExample';
import {useWindowSize} from '@docusaurus/theme-common';
<Tabs groupId="configType" queryString>
<TabItem value="env" label="ENV">
@@ -10,19 +15,96 @@ import CodeBlock from '@theme/CodeBlock';
</TabItem>
<TabItem value="file" label="File">
<FileType>
<div
className="schemaWrapper"
style={{
display: "flex"
}}
>
<div style={{ padding: '0 1em 0 1em', flexBasis: 'min-content', flexGrow: 2}}>
<DetailsAdmo type="note" summary="Config Structure">
This displays the **structure** of the [File Configuration](/configuration?configType=aio#configuration-types) for a <strong children={props.name}/> type <strong children={props.client ? 'Client' : 'Source'}/> with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.
</DetailsAdmo>
<ExplorerFetch name={`schemas/${props.config}`} />
</div>
<div style={{ flexBasis: 'auto', flexGrow: 3 }}>
<div className="fileEditor">
<DetailsAdmo type="note" summary="Config Example">
This displays an **example config file** of a <strong children={props.name}/> <span children={props.client ? 'Client' : 'Source'}/> [File Configuration](/configuration?configType=aio#configuration-types) that adheres to the shown **Config Structure**.
<FileExample title={`CONFIG/${props.name}.json`} client={props.client ?? false} data={props.fileContent}/>
* **text** mode lets you edit the JSON directly.
* **tree** mode gives you a guided point-and-click editing experience that always keeps the JSON *syntax* valid.
or <SchemaLink lower objectName={props.config}/>
Both modes **validate** that the configuraion is correct. Any errors show up as squiggly lines.
After you finish editing, switch to **text** and then copy all text to get a completed config.
</DetailsAdmo>
</div>
<div className="fileEditorMobile">
<DetailsAdmo type="warning" summary="Config Example Mobile Experience">
This displays an **example config file** of a <strong children={props.name}/> <span children={props.client ? 'Client' : 'Source'}/> [File Configuration](/configuration?configType=aio#configuration-types) that adheres to the shown **Config Structure**.
The example config file editor is meant for a larger screen experience so **only the read-only example is shown.** Please use this site on a tablet/laptop/desktop to enable file editor features.
</DetailsAdmo>
</div>
<FileConfigExample
filePathName={`CONFIG/${props.name}.json`}
configureAs={props.client ? 'client' : 'source'}
data={props.fileContent}
schemaName={props.config}
readOnlyAtWidth={500}
/>
</div>
</div>
</FileType>
</TabItem>
<TabItem value="aio" label="AIO">
<AIOType>
<div
className="schemaWrapper"
style={{
display: "flex"
}}
>
<div style={{ padding: '0 1em 0 1em', flexBasis: 'min-content', flexGrow: 2}}>
<DetailsAdmo type="note" summary="Config Structure">
This displays the **structure** of the [all-in-one (`config.json`) configuration](/configuration?configType=aio#configuration-types) with all possible properties, their shape, and descriptions/types. Use this to understand how to write a valid config.
<AIOExample data={props.fileContent} client={props.client ?? false} name={props.name}/>
Select the <strong children={props.name}/> type from the respective <code children={props.client ? 'clients' : 'sources'}/> node below, then expand it.
</DetailsAdmo>
<ExplorerFetch name={`schemas/aio`} />
</div>
<div style={{ flexBasis: 'auto', flexGrow: 3 }}>
<div className="fileEditor">
<DetailsAdmo type="note" summary="Config Example">
This displays an **example config file** of a [all-in-one (`config.json`) configuration](/configuration?configType=aio#configuration-types) that includes a <strong children={props.name}/> <span children={props.client ? 'Client' : 'Source'}/> that adheres to the shown **Config Structure**.
* **text** mode lets you edit the JSON directly.
* **tree** mode gives you a guided point-and-click editing experience that always keeps the JSON *syntax* valid.
or <SchemaLink lower objectName={props.config}/>
Both modes **validate** that the configuraion is correct. Any errors show up as squiggly lines.
After you finish editing, switch to **text** and then copy all text to get a completed config.
</DetailsAdmo>
</div>
<div className="fileEditorMobile">
<DetailsAdmo type="warning" summary="Config Example Mobile Experience">
This displays an **example config file** of a [all-in-one (`config.json`) configuration](/configuration?configType=aio#configuration-types) that includes a <strong children={props.name}/> <span children={props.client ? 'Client' : 'Source'}/> that adheres to the shown **Config Structure**.
The example config file editor is meant for a larger screen experience so **only the read-only example is shown.** Please use this site on a tablet/laptop/desktop to enable file editor features.
</DetailsAdmo>
</div>
<FileConfigExample
filePathName={`CONFIG/config.json`}
configureAs={props.client ? 'client' : 'source'}
data={props.fileContent}
schemaName="aio"
name={props.name}
readOnlyAtWidth={500}
aio
/>
</div>
</div>
</AIOType>
</TabItem>
</Tabs>
</Tabs>
@@ -0,0 +1,26 @@
.schemaWrapper {
margin-top: 1em;
display: flex;
flex-direction: row;
row-gap: 1em;
column-gap: 1em;
}
.fileEditorMobile {
display: none;
}
@media screen and (max-width: 1378px) {
.schemaWrapper {
flex-direction: column;
}
}
@media screen and (max-width: 500px) {
.fileEditor {
display: none;
}
.fileEditorMobile {
display: block
}
}
-44
View File
@@ -1,44 +0,0 @@
import React from "react"
import BrowserOnly from "@docusaurus/BrowserOnly"
import { useColorMode } from "@docusaurus/theme-common"
import JSONSchemaEditor from "@theme/JSONSchemaEditor"
// Context
import { usePlaygroundContext } from "@site/src/contexts/PlaygroundContext"
// Common stringify of the JSON
const STRINGIFY_JSON = (json: unknown) => JSON.stringify(json, null, "\t")
function JSONSchemaDataInner(): JSX.Element {
const {
state: { userSchema, editorRef, data: value },
updateState,
} = usePlaygroundContext()
const { colorMode } = useColorMode()
return (
<div style={{ boxSizing: "border-box", width: "50%" }}>
<JSONSchemaEditor
value={value}
schema={userSchema}
theme={colorMode === "dark" ? "vs-dark" : "vs"}
editorDidMount={(editor) => {
updateState({ editorRef: editor })
}}
height={"70vh"}
key={STRINGIFY_JSON(userSchema)}
/>
</div>
)
}
export default function JSONSchemaDataComponent(): JSX.Element {
return (
<BrowserOnly fallback={<div>Loading...</div>}>
{() => {
return <JSONSchemaDataInner />
}}
</BrowserOnly>
)
}
+26
View File
@@ -0,0 +1,26 @@
.schemaWrapper2 {
margin: 1em;
display: flex;
flex-direction: row;
row-gap: 1em;
column-gap: 1em;
}
.fileEditorMobile2 {
display: none;
}
@media screen and (max-width: 1280px) {
.schemaWrapper2 {
flex-direction: column;
}
}
@media screen and (max-width: 500px) {
.fileEditor2 {
display: none;
}
.fileEditorMobile2 {
display: block
}
}
+90 -35
View File
@@ -1,50 +1,105 @@
import React from "react"
import React, {useEffect, useState} from "react"
import BrowserOnly from "@docusaurus/BrowserOnly"
import {useColorMode, useWindowSize} from '@docusaurus/theme-common';
import CodeBlock from '@theme/CodeBlock';
import Schema from "@site/static/aio.json";
import Schema from "@site/static/schemas/aio.json";
import ConfigExample from "@site/static/configExample.json";
import JSONSchemaViewer from "@theme/JSONSchemaViewer"
import JSONSchemaEditor from "@theme/JSONSchemaEditor";
import {useColorMode} from "@docusaurus/theme-common";
const STRINGIFY_JSON = (json: unknown) => JSON.stringify(json, null, "\t")
import './Playground.scss';
import { JsonSchemaViewer } from 'cf-json-schema-viz';
import "./json-schema-viewer-styles.css";
import "./modern-json-react-styles.css";
import { ReactJsonEditor, createAjvValidator, type Content } from 'modern-react-json-editor';
import f from "ajv-formats"
import DetailsAdmo from "./AdmonitionDetails";
const validator = createAjvValidator({
schema: Schema,
ajvOptions: {
strict: "log",
strictSchema: "log",
allowUnionTypes: true,
},
onCreateAjv: (ajv) => {
ajv.addKeyword('deprecationMessage');
f.default(ajv);
return ajv;
}
});
// based on https://github.com/jy95/docusaurus-json-schema-plugin/blob/main/testsite/src/components/PlaygroundInner.tsx
function PlaygroundInner(): JSX.Element {
const { colorMode } = useColorMode()
const {
colorMode, // the "effective" color mode, never null
// colorModeChoice, // the color mode chosen by the user, can be null
// setColorMode, // set the color mode chosen by the user
} = useColorMode();
const windowSize = useWindowSize({desktopBreakpoint: 500});
const [data, setData] = useState<Content>({json: ConfigExample });
return (
<div
style={{
display: "flex",
flexDirection: "column",
overflowY: "hidden",
overflowX: "hidden",
}}
>
<div
style={{
display: "flex",
flexDirection: "row",
justifyContent: "space-between",
}}
>
<div style={{width: '50%'}}>
<JSONSchemaViewer
schema={Schema}
showExamples={true}
<div className="schemaWrapper2">
<div style={{ padding: '0 1em 0 1em', flexBasis: 'min-content', flexGrow: 2}}>
<DetailsAdmo type="note" summary="Config Structure">
<p>This displays the <strong>structure</strong> of the <a href="/configuration?configType=aio#configuration-types">all-in-one (<code>config.json</code>) configuration</a> with all possible properties, their shape, and descriptions/types.</p>
<p>Use this to understand how to write a valid config.</p>
</DetailsAdmo>
<JsonSchemaViewer
name="Todos Model"
schema={Schema}
expanded={false}
hideTopBar={false}
renderRootTreeLines={true}
emptyText="No schema defined"
defaultExpandedDepth={0}
markup
/>
</div>
<div style={{ boxSizing: "border-box", width: "50%" }}>
<JSONSchemaEditor
value={STRINGIFY_JSON(ConfigExample)}
theme={colorMode === "dark" ? "vs-dark" : "vs"}
schema={Schema}
height={"70vh"}
/>
<div style={{ flexBasis: 'auto', flexGrow: 3 }}>
<div className="fileEditor2">
<DetailsAdmo type="note" summary="Config Example">
<p>
This displays an <strong>example config file</strong> of a <a href="/configuration?configType=aio#configuration-types">all-in-one (<code>config.json</code>) configuration</a> that adheres to the shown <strong>Config Structure.</strong>
</p>
<ul>
<li>
<strong>text</strong> mode lets you edit the JSON directly.
</li>
<li>
<strong>tree</strong> mode gives you a guided point-and-click editing experience that always keeps the JSON <i>syntax</i> valid.
</li>
</ul>
<p>Both modes <strong>validate</strong> that the configuraion is correct. Any errors show up as squiggly lines.</p>
<p>After you finish editing, switch to <strong>text</strong> and then copy all text to get a completed config.</p>
</DetailsAdmo>
</div>
<div className="fileEditorMobile2">
<DetailsAdmo type="warning" summary="Config Example Mobile Experience">
<p>
This displays an <strong>example config file</strong> of a <a href="/configuration?configType=aio#configuration-types">all-in-one (<code>config.json</code>) configuration</a> that adheres to the shown <strong>Config Structure.</strong>
</p>
<p>
The example config file editor is meant for a larger screen experience so <strong>only the read-only example is shown.</strong> Please use this site on a tablet/laptop/desktop to enable file editor features.
</p>
</DetailsAdmo>
</div>
{windowSize === 'mobile' ? (<CodeBlock title={`CONFIG/config.json`} language="json5">{JSON.stringify(data, null, 2)}</CodeBlock>) : (
<ReactJsonEditor
validator={validator}
theme={colorMode}
content={data}
mode="text"
style={{height: 'initial'}}
/>
)}
</div>
</div>
</div>
)
}
@@ -0,0 +1,38 @@
import React, {useEffect, useState} from "react"
import BrowserOnly from "@docusaurus/BrowserOnly"
//import './Explorer.scss';
import { JsonSchemaViewer } from 'cf-json-schema-viz';
import '../json-schema-viewer-styles.css'
export interface ExplorerProps {
schema: object
}
// based on https://github.com/jy95/docusaurus-json-schema-plugin/blob/main/testsite/src/components/PlaygroundInner.tsx
export default function Explorer(props: ExplorerProps): JSX.Element {
//injectStyles();
return (
<div>
<JsonSchemaViewer
schema={props.schema}
renderRootTreeLines={true}
emptyText="No schema defined"
defaultExpandedDepth={0}
markup
/>
</div>
)
}
// export default function PlaygroundComponent(): JSX.Element {
// return (
// <BrowserOnly fallback={<div>Loading...</div>}>
// {() => {
// return <PlaygroundInner />
// }}
// </BrowserOnly>
// )
// }
@@ -0,0 +1,48 @@
import React, {useEffect, useState, Fragment} from "react"
//import BrowserOnly from "@docusaurus/BrowserOnly"
import Explorer from './Explorer';
import useBaseUrl from '@docusaurus/useBaseUrl';
export interface ExplorerFetchProps {
name: string
}
export default function ExplorerFetchFunc(props: ExplorerFetchProps): JSX.Element {
const [schema, setSchema] = useState(undefined as undefined | Error | object);
const url = useBaseUrl(`/${props.name}.json`);
useEffect( () => {
fetch(
url,
{
headers: {
'Accept': 'application/json',
}
}
)
.then((response) => response.json())
.then((data) => setSchema(data))
.catch( (err) => setSchema(err) )
}, [setSchema, url])
return (
<Fragment>
{schema === undefined && <div>Loading ...</div>}
{schema !== undefined && schema instanceof Error && <div>Houston we have a problem : {schema.message}</div>}
{schema !== undefined && !(schema instanceof Error) && <Explorer schema={schema}/>}
</Fragment>
)
}
// export default function ExplorerFetch(props: ExplorerFetchProps): JSX.Element {
// return (
// <BrowserOnly fallback={<div>Loading...</div>}>
// {() => {
// return <ExplorerFetchFunc {...props} />
// }}
// </BrowserOnly>
// )
// }
@@ -0,0 +1,7 @@
import Schema from "@site/static/aio.json";
import Explorer from './Explorer';
export default function ExplorerSSR(): JSX.Element {
return <Explorer schema={Schema}/>
}
@@ -0,0 +1,76 @@
import React, { useEffect, useState, useMemo } from "react"
import BrowserOnly from "@docusaurus/BrowserOnly"
import { useColorMode } from '@docusaurus/theme-common';
const STRINGIFY_JSON = (json: unknown) => JSON.stringify(json, null, "\t");
import "../modern-json-react-styles.css";
import { JSONSchema, ReactJsonEditor, createAjvValidator, type Content, type Validator } from 'modern-react-json-editor';
import f from "ajv-formats"
import json5 from 'json5';
export interface SchemaEditorProps {
config: object | string
schema?: object
height?: string
}
// based on https://github.com/jy95/docusaurus-json-schema-plugin/blob/main/testsite/src/components/PlaygroundInner.tsx
function SchemaEditorInner(props: SchemaEditorProps): JSX.Element {
const validator: Validator | undefined = useMemo(() => {
if(props.schema === undefined) {
return undefined;
}
return createAjvValidator({
schema: props.schema as JSONSchema,
ajvOptions: {
strict: "log",
strictSchema: "log",
allowUnionTypes: true,
},
onCreateAjv: (ajv) => {
ajv.addKeyword('deprecationMessage');
f.default(ajv);
return ajv;
}
});
}, [props.schema]);
const initialData = useMemo(() => {
let content: object;
if(typeof props.config === 'string') {
content = json5.parse(props.config);
} else {
content = props.config;
}
return {json: content};
},[props.config])
// const [data, setData] = useState({ json: props.config });
const {
colorMode, // the "effective" color mode, never null
} = useColorMode();
//const val = typeof props.config === 'object' ? STRINGIFY_JSON(props.config) : props.config;
return (
<ReactJsonEditor
validator={validator}
theme={colorMode}
mode="text"
content={initialData}
style={{height: 'initial'}}
/>
)
}
export default function SchemaEditor(props: SchemaEditorProps): JSX.Element {
return (
<BrowserOnly fallback={<div>Loading...</div>}>
{() => {
return <SchemaEditorInner {...props} />
}}
</BrowserOnly>
)
}
@@ -0,0 +1,74 @@
import React, {useEffect, useState, Fragment} from "react"
import useBaseUrl from '@docusaurus/useBaseUrl';
import SchemaEditor from "./SchemaEditor";
import json5 from 'json5';
export interface SchemaEditorFetchProps {
configContent: string | object
schemaName?: string
}
export default function ExplorerFetchFunc(props: SchemaEditorFetchProps): JSX.Element {
const {
schemaName
} = props;
const [schema, setSchema] = useState(undefined as undefined | Error | object | false);
const [config, setConfig] = useState(undefined as undefined | Error | object);
const schemaUrl = schemaName === undefined ? undefined : useBaseUrl(`schemas/${props.schemaName}.json`);
//const configUrl = props.configName !== undefined ? useBaseUrl(`/${props.configName}.json`) : undefined;
useEffect( () => {
if(schemaUrl === undefined) {
setSchema(false);
} else {
fetch(
schemaUrl,
{
headers: {
'Accept': 'application/json',
}
}
)
.then((response) => response.json())
.then((data) => setSchema(data))
.catch( (err) => setSchema(err) )
}
}, [setSchema, schemaUrl])
// useEffect( () => {
// if(configUrl !== undefined) {
// fetch(
// configUrl,
// {
// headers: {
// 'Accept': 'application/json',
// }
// }
// )
// .then((response) => response.json())
// .then((data) => setConfig(data))
// .catch( (err) => setConfig(err) )
// } else if(props.configContent !== undefined) {
// if(typeof props.configContent === 'string') {
// setConfig(json5.parse(props.configContent));
// } else {
// setConfig(props.configContent);
// }
// }
// }, [setConfig, configUrl, props.configContent])
return (
<Fragment>
{schema === undefined && <div>Loading ...</div>}
{schema !== undefined && schema instanceof Error && <div>Houston we have a problem : {schema.message}</div>}
{schema !== undefined && !(schema instanceof Error) &&
<SchemaEditor
schema={schema === false ? undefined : schema}
config={props.configContent}
/>}
</Fragment>
)
}
@@ -0,0 +1,480 @@
/* JSON Schema Viewer - Pure CSS with CSS Custom Properties */
/* ========================================
Theme Variables - Light Mode (default)
Define at :root so portaled elements inherit them
======================================== */
:root {
--jsv-font-sans: ui-sans-serif, system-ui, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif;
--jsv-font-mono: ui-monospace, SFMono-Regular, "SF Mono", Menlo, Consolas, monospace;
--jsv-font-size: 0.875rem;
/* Colors - Light Mode defaults */
--jsv-color-body: #1a1a1a;
--jsv-color-muted: #6b7280;
--jsv-color-border: #e5e7eb;
--jsv-color-canvas: #f4f4f5;
--jsv-color-canvas-tint: #f4f4f5;
--jsv-color-bg: #ffffff;
/* Semantic colors - Cloudflare orange as primary */
--jsv-color-primary: #f6821f;
--jsv-color-danger: #dc2626;
--jsv-color-warning: #f97316;
--jsv-color-success: #16a34a;
}
/* ========================================
Theme Variables - Dark Mode
Cloudflare docs dark theme colors
======================================== */
:root[data-theme="dark"],
[data-theme="dark"] {
--jsv-color-body: #e4e4e7;
--jsv-color-muted: #a1a1aa;
--jsv-color-border: #3f3f46;
--jsv-color-canvas: #27272a;
--jsv-color-canvas-tint: #3f3f46;
--jsv-color-bg: #18181b;
--jsv-color-primary: #f6821f;
--jsv-color-danger: #f87171;
--jsv-color-warning: #fb923c;
--jsv-color-success: #4ade80;
}
/* ========================================
Base Styles
======================================== */
.jsv-root {
font-size: var(--jsv-font-size);
font-family: var(--jsv-font-sans);
color: var(--jsv-color-body);
line-height: 1.5;
position: relative;
}
.jsv-content {
padding-left: 2rem;
padding-right: 1rem;
padding-bottom: 0.5rem;
padding-top: 0.375rem;
}
/* ========================================
Schema Row
======================================== */
.jsv-row {
position: relative;
padding-top: 0.25rem;
padding-bottom: 0.25rem;
display: flex;
align-items: flex-start;
max-width: 100%;
}
.jsv-row-content {
display: flex;
flex-direction: column;
gap: 0.125rem;
max-width: 100%;
flex: 1;
min-width: 0;
}
.jsv-row-header {
display: flex;
align-items: center;
max-width: 100%;
gap: 0.25rem;
}
/* Nubbin - horizontal connector from left border to property */
.jsv-nubbin {
width: 0.75rem;
height: 0;
border-top: 1px solid var(--jsv-color-border);
flex-shrink: 0;
margin-top: 0.5rem;
margin-right: 0.5rem;
margin-left: -1rem;
}
.jsv-nubbin-short {
width: 0.25rem;
}
/* ========================================
Child Stack (nested content with left border)
======================================== */
.jsv-child-stack {
font-size: var(--jsv-font-size);
}
.jsv-child-stack-nested {
border-left: 1px solid var(--jsv-color-border);
margin-left: 0.5rem;
padding-left: 1rem;
margin-top: 0.25rem;
}
/* ========================================
Property Name
======================================== */
.jsv-property-name {
font-family: var(--jsv-font-mono);
font-weight: 600;
margin-right: 0.5rem;
flex-shrink: 0;
}
/* ========================================
Type Display
======================================== */
.jsv-type {
color: var(--jsv-color-muted);
overflow: hidden;
text-overflow: ellipsis;
white-space: nowrap;
}
.jsv-types-container {
display: flex;
align-items: baseline;
font-size: var(--jsv-font-size);
min-width: 0;
}
/* ========================================
Badges (required, deprecated, read-only)
======================================== */
.jsv-badges {
display: flex;
align-items: center;
gap: 0.5rem;
flex-shrink: 0;
}
.jsv-badge {
font-size: 0.75rem;
}
.jsv-badge-required {
color: var(--jsv-color-warning);
}
.jsv-badge-deprecated {
color: var(--jsv-color-warning);
}
.jsv-badge-readonly {
color: var(--jsv-color-muted);
}
/* ========================================
Divider (horizontal line on hover)
======================================== */
.jsv-divider {
height: 1px;
flex: 1;
margin-left: 0.75rem;
margin-right: 0.75rem;
min-width: 1rem;
background-color: transparent;
transition: background-color 0.15s ease;
}
.jsv-divider-visible {
background-color: var(--jsv-color-border);
}
/* ========================================
Description
======================================== */
.jsv-description {
font-size: var(--jsv-font-size);
color: var(--jsv-color-muted);
margin-top: 0.0625rem;
line-height: 1.4;
}
/* ========================================
Validations
======================================== */
.jsv-validations {
display: flex;
flex-wrap: wrap;
gap: 0.25rem;
align-items: center;
margin-top: 0.125rem;
}
.jsv-validations-row {
display: flex;
flex-wrap: wrap;
gap: 0.25rem;
align-items: center;
}
.jsv-validation {
display: flex;
align-items: baseline;
gap: 0.375rem;
color: var(--jsv-color-muted);
font-size: 0.75rem;
}
.jsv-validation-label {
flex-shrink: 0;
}
.jsv-validation-values {
display: flex;
flex-wrap: wrap;
gap: 0.25rem;
flex: 1;
}
.jsv-validation-value {
padding: 0.0625rem 0.375rem;
background-color: var(--jsv-color-canvas-tint);
color: var(--jsv-color-muted);
border: 1px solid var(--jsv-color-border);
border-radius: 0.25rem;
font-family: var(--jsv-font-mono);
font-size: 0.75rem;
word-break: break-all;
}
/* ========================================
Caret (expand/collapse icon)
======================================== */
.jsv-caret {
width: 1.25rem;
height: 1.25rem;
margin-left: -1.5rem;
margin-right: 0.25rem;
color: var(--jsv-color-muted);
display: flex;
justify-content: center;
align-items: center;
cursor: pointer;
flex-shrink: 0;
transition: transform 0.15s ease;
}
.jsv-caret:hover {
color: var(--jsv-color-body);
}
.jsv-caret-expanded {
transform: rotate(90deg);
}
/* ========================================
Error Display
======================================== */
.jsv-error {
color: var(--jsv-color-danger);
display: flex;
align-items: center;
gap: 0.25rem;
font-size: 0.75rem;
}
/* ========================================
Change Annotations (added/removed/modified)
======================================== */
.jsv-annotation {
position: absolute;
width: 0.25rem;
height: 1rem;
border-radius: 0.125rem;
top: 50%;
transform: translateY(-50%);
}
.jsv-annotation-added {
background-color: var(--jsv-color-success);
}
.jsv-annotation-removed {
background-color: var(--jsv-color-danger);
}
.jsv-annotation-modified {
background-color: var(--jsv-color-warning);
}
/* ========================================
Path Crumbs (sticky breadcrumb header)
Wrapper is sticky with height:0 (no layout impact)
Inner crumbs div is absolute, overlays content
======================================== */
.jsv-crumbs {
height: 2rem;
padding-left: 2rem;
padding-right: 1rem;
font-family: var(--jsv-font-mono);
font-size: var(--jsv-font-size);
line-height: 1;
z-index: 20;
background-color: var(--sl-color-bg, var(--jsv-color-bg, #fff));
color: var(--jsv-color-muted);
display: flex;
align-items: center;
gap: 0.25rem;
border-bottom: 1px solid var(--jsv-color-border);
border-top-left-radius: 0.5rem;
border-top-right-radius: 0.5rem;
box-sizing: border-box;
/* Hidden by default */
opacity: 0;
pointer-events: none;
}
[data-theme="dark"] .jsv-crumbs,
:root[data-theme="dark"] .jsv-crumbs {
border-bottom-color: var(--sl-color-gray-5, #52525b);
}
.jsv-crumbs[data-visible="true"] {
opacity: 1;
pointer-events: auto;
}
.jsv-crumb-current {
color: var(--jsv-color-body);
font-weight: 600;
}
/* ========================================
Select / Menu Dropdown
======================================== */
.jsv-select-trigger {
display: inline-flex;
align-items: center;
gap: 0.375rem;
padding: 0.125rem 0.5rem;
font-size: var(--jsv-font-size);
font-family: var(--jsv-font-sans);
background-color: transparent;
border: 1px solid var(--jsv-color-border);
border-radius: 0.25rem;
cursor: pointer;
color: var(--jsv-color-muted);
line-height: 1.4;
transition: background-color 0.15s ease, border-color 0.15s ease;
}
.jsv-select-trigger:hover {
background-color: var(--jsv-color-canvas);
border-color: var(--jsv-color-muted);
}
.jsv-select-trigger:focus {
outline: none;
box-shadow: 0 0 0 2px var(--jsv-color-primary);
}
.jsv-select-positioner {
z-index: 9999 !important;
position: relative;
}
.jsv-select-popup {
background-color: var(--jsv-color-bg);
border: 1px solid var(--jsv-color-border);
border-radius: 0.375rem;
box-shadow: 0 4px 16px rgba(0, 0, 0, 0.15), 0 2px 4px rgba(0, 0, 0, 0.1);
padding: 0.25rem 0;
min-width: 10rem;
overflow: hidden;
font-family: var(--jsv-font-sans);
font-size: var(--jsv-font-size);
}
.jsv-select-item {
padding: 0.5rem 0.75rem;
padding-left: 2rem;
font-size: var(--jsv-font-size);
cursor: pointer;
display: flex;
align-items: center;
gap: 0.5rem;
outline: none;
color: var(--jsv-color-body);
background-color: var(--jsv-color-bg);
position: relative;
transition: background-color 0.1s ease;
}
.jsv-select-item:hover,
.jsv-select-item:focus,
.jsv-select-item[data-highlighted] {
background-color: var(--jsv-color-canvas);
}
.jsv-select-item[data-selected] {
font-weight: 600;
}
.jsv-select-item-indicator {
position: absolute;
left: 0.625rem;
top: 50%;
transform: translateY(-50%);
display: flex;
align-items: center;
justify-content: center;
color: var(--jsv-color-primary);
}
/* ========================================
Top Level Styles
======================================== */
.jsv-top-label {
font-family: var(--jsv-font-mono);
font-weight: 600;
font-size: var(--jsv-font-size);
padding-bottom: 0.5rem;
}
.jsv-top-section {
display: flex;
align-items: center;
gap: 0.75rem;
padding-bottom: 0.5rem;
}
.jsv-combiner-label {
display: flex;
align-items: center;
color: var(--jsv-color-muted);
font-size: var(--jsv-font-size);
}
/* ========================================
Link Styles
======================================== */
.jsv-link {
color: var(--jsv-color-primary);
cursor: pointer;
text-decoration: none;
margin-left: 0.5rem;
}
.jsv-link:hover {
text-decoration: underline;
}
/* ========================================
Misc Helpers
======================================== */
.jsv-cursor-pointer {
cursor: pointer;
}
.jsv-ml-2 {
margin-left: 0.5rem;
}
@@ -0,0 +1 @@
.jse-theme-dark{--jse-theme: dark;--jse-theme-color: #2f6dd0;--jse-theme-color-highlight: #467cd2;--jse-background-color: #1e1e1e;--jse-text-color: #d4d4d4;--jse-text-color-inverse: #4d4d4d;--jse-main-border: 1px solid #4f4f4f;--jse-menu-color: #fff;--jse-modal-background: #2f2f2f;--jse-modal-overlay-background: rgba(0, 0, 0, .5);--jse-modal-code-background: #2f2f2f;--jse-tooltip-color: var(--jse-text-color);--jse-tooltip-background: #4b4b4b;--jse-tooltip-border: 1px solid #737373;--jse-tooltip-action-button-color: inherit;--jse-tooltip-action-button-background: #737373;--jse-panel-background: #333333;--jse-panel-background-border: 1px solid #464646;--jse-panel-color: var(--jse-text-color);--jse-panel-color-readonly: #737373;--jse-panel-border: 1px solid #3c3c3c;--jse-panel-button-color-highlight: #e5e5e5;--jse-panel-button-background-highlight: #464646;--jse-navigation-bar-background: #656565;--jse-navigation-bar-background-highlight: #7e7e7e;--jse-navigation-bar-dropdown-color: var(--jse-text-color);--jse-context-menu-background: #4b4b4b;--jse-context-menu-background-highlight: #595959;--jse-context-menu-separator-color: #595959;--jse-context-menu-color: var(--jse-text-color);--jse-context-menu-pointer-background: #737373;--jse-context-menu-pointer-background-highlight: #818181;--jse-context-menu-pointer-color: var(--jse-context-menu-color);--jse-key-color: #9cdcfe;--jse-value-color: var(--jse-text-color);--jse-value-color-number: #b5cea8;--jse-value-color-boolean: #569cd6;--jse-value-color-null: #569cd6;--jse-value-color-string: #ce9178;--jse-value-color-url: #ce9178;--jse-delimiter-color: #949494;--jse-edit-outline: 2px solid var(--jse-text-color);--jse-selection-background-color: #464646;--jse-selection-background-inactive-color: #333333;--jse-hover-background-color: #343434;--jse-active-line-background-color: rgba(255, 255, 255, .06);--jse-search-match-background-color: #343434;--jse-collapsed-items-background-color: #333333;--jse-collapsed-items-selected-background-color: #565656;--jse-collapsed-items-link-color: #b2b2b2;--jse-collapsed-items-link-color-highlight: #ec8477;--jse-search-match-color: #724c27;--jse-search-match-outline: 1px solid #966535;--jse-search-match-active-color: #9f6c39;--jse-search-match-active-outline: 1px solid #bb7f43;--jse-tag-background: #444444;--jse-tag-color: #bdbdbd;--jse-table-header-background: #333333;--jse-table-header-background-highlight: #424242;--jse-table-row-odd-background: rgba(255, 255, 255, .1);--jse-input-background: #3d3d3d;--jse-input-border: var(--jse-main-border);--jse-button-background: #808080;--jse-button-background-highlight: #7a7a7a;--jse-button-color: #e0e0e0;--jse-button-secondary-background: #494949;--jse-button-secondary-background-highlight: #5d5d5d;--jse-button-secondary-background-disabled: #9d9d9d;--jse-button-secondary-color: var(--jse-text-color);--jse-a-color: #55abff;--jse-a-color-highlight: #4387c9;--jse-svelte-select-background: #3d3d3d;--jse-svelte-select-border: 1px solid #4f4f4f;--list-background: #3d3d3d;--item-hover-bg: #505050;--multi-item-bg: #5b5b5b;--input-color: #d4d4d4;--multi-clear-bg: #8a8a8a;--multi-item-clear-icon-color: #d4d4d4;--multi-item-outline: 1px solid #696969;--list-shadow: 0 2px 8px 0 rgba(0, 0, 0, .4);--jse-color-picker-background: #656565;--jse-color-picker-border-box-shadow: #8c8c8c 0 0 0 1px}
@@ -1,2 +1 @@
[**AIO** Config Type](/configuration?configType=aio#configuration-types)
{props.children}
@@ -0,0 +1,10 @@
<DetailsAdmo type="warning" summary="Insecure Communication">
This method of exposing Discord IPC is **not secure**. There is no authentication used for the traffic relayed to/from the opened TCP port.
You should only use this method if you trust the network your machine is on. Additionally:
* **Do** use a firewall to limit source (IP) of incoming traffic to this TCP port
* **Do not** expose this port to the public internet
</DetailsAdmo>
@@ -1,3 +1,5 @@
[**ENV** Config Type](/configuration?configType=env#configuration-types)
:::note[Configuration Type]
This is configuration for the **ENV** [Config Type](/configuration?configType=env#configuration-types).
:::
{props.children}
@@ -1,3 +1 @@
[**File** Config Type](/configuration?configType=file#configuration-types)
{props.children}
@@ -0,0 +1,5 @@
import ShouldScrobble from "@site/src/components/snippets/_should-scrobble.mdx"
<DetailsAdmo type="note" summary="Should Scrobble Behavior">
<ShouldScrobble {...props}/>
</DetailsAdmo>
+116
View File
@@ -0,0 +1,116 @@
/**
* Inspired by typings from https://github.com/michal-worwag/hooks-ts/blob/main/packages/hooks-ts/src/useLocalStorage/useLocalStorage.ts
* and global updates/dedup from https://github.com/kaansey/react-localstorage-hook/blob/master/src/useLocalStorage/useLocalStorage.ts
*/
import { useState, useEffect, useCallback } from 'react';
import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
const localTypedStorageHook = <T>(key: string, initialValue: T, json: boolean = true): [T, (value: T) => void] => {
const [storedValue, setStoredValue] = useState<T>(() => {
const item = window.localStorage.getItem(key);
if (json) {
try {
return item ? (JSON.parse(item) as T) : initialValue;
} catch (error) {
console.error(error);
return initialValue;
}
} else {
try {
if (null === item) {
return initialValue;
}
if (item === 'true') {
return true as T;
}
if (item === 'false') {
return false as T;
}
if (isNumeric(item)) {
if (item.includes('.')) {
return parseFloat(item) as T;
}
return parseInt(item) as T;
}
return item as T;
} catch (error) {
console.error(error);
return initialValue;
}
}
});
const updateValue = useCallback(
newValue => {
setStoredValue(() => {
if(json) {
localStorage.setItem(key, JSON.stringify(newValue))
} else {
localStorage.setItem(key, newValue)
}
return newValue
})
},
[key]
);
useEffect(() => {
const onStorage = (event: any) => {
if (event.storageArea === localStorage && event.key === key) {
setStoredValue(
event.newValue === null ? initialValue : event.newValue
)
}
}
window.addEventListener('storage', onStorage)
return () => window.removeEventListener('storage', onStorage)
});
return [storedValue, updateValue];
}
const isNumeric = (num: any) => (typeof(num) === 'number' || typeof(num) === "string" && num.trim() !== '') && !isNaN(num as number);
const createTypedLocalStorageHook = <T>(key: string, defaultValue: T, json?: boolean) => {
const updates: Array<any> = []
return () => {
const [value, setValue] = localTypedStorageHook<T>(key, defaultValue, json)
const updateValue = useCallback((newValue: T) => {
for (const update of updates) {
update(newValue)
}
}, [])
useEffect(() => {
updates.push(setValue)
return () => {
updates.splice(updates.indexOf(setValue), 1)
}
}, [setValue])
return [value, updateValue]
}
}
const hookInstances: Record<string, any> = {}
export const useTypedLocalStorage = <T>(key: string, defaultValue: T, json?: boolean): [T, (value: T) => void] => {
if (key in hookInstances) {
return hookInstances[key]()
}
// prevents usage during server static rendering
if(!ExecutionEnvironment.canUseDOM) {
return [defaultValue, () => null];
}
hookInstances[key] = createTypedLocalStorageHook(key, defaultValue, json)
return hookInstances[key]()
}

Some files were not shown because too many files have changed in this diff Show More