try overridding sharp to fix node-gyp rebuild issue

chore(release): Bump version for release
feat: Better validatation for normalized config urls
2026-09-03 05:10:00 +03:00 · 2026-08-12 17:19:14 +00:00 · 2026-08-12 16:40:23 +00:00 · 2026-08-12 16:32:42 +00:00 · 2026-08-12 13:27:10 +00:00 · 2026-08-11 20:37:24 +00:00
603 changed files with 45790 additions and 16593 deletions
@@ -30,7 +30,9 @@
 				"dbaeumer.vscode-eslint",
 				"unifiedjs.vscode-mdx",
 				"bradlc.vscode-tailwindcss",
-				"TakumiI.markdowntable"
+				"TakumiI.markdowntable",
+				"YoavBls.pretty-ts-errors",
+				"bowlerr.sqlite-intelliview-vscode"
 			]
 		}
 	},
@@ -31,4 +31,5 @@ tmp-*
 .env
 *.env
 .storybook
-.stories
+.stories
+**/lexicons/**/*.json
@@ -1,6 +1,6 @@
 ## Checklist before requesting a review

- [ ] I have read the [contributing guidelines.](../CONTRIBUTING.md)
+- [ ] I have read the [contributing guidelines.](../blob/master/CONTRIBUTING.md)

 ## Type of change

@@ -39,9 +39,8 @@ jobs:
        working-directory: ./docsite

      - name: Replace canonical
-        working-directory: ./docsite/build
-        # https://stackoverflow.com/a/74211242/1469797
-        run: grep '<link data-rh="true" rel="canonical" href="https://foxxmd.github.io' . -lr | xargs sed -i 's/<link data-rh="true" rel="canonical" href="https:\/\/foxxmd.github.io\/docs/<link data-rh="true" rel="canonical" href="https:\/\/docs.multi-scrobbler.app/g'
+        working-directory: ./docsite
+        run: node --experimental-strip-types canonical-replace.ts ./build

      # Popular action to deploy to GitHub Pages:
      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
@@ -18,11 +18,16 @@ jobs:
    name: Tests / Build / Sanity Run
    runs-on: ubuntu-latest
    steps:
-      - name: Check out the repo
+      - name: Check out the repo (gha)
+        if: ${{ !env.ACT }}
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd #v6.0.2
        with:
          ref: ${{ inputs.ref }}
          persist-credentials: false
+
+      - name: Check out the repo (act)
+        if: ${{ env.ACT }}
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd #v6.0.2
      - name: Use Node.js
        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f #6.3.0
        with:
@@ -55,7 +60,7 @@ jobs:
        run: |
          set +e
          export NODE_ENV=production
-          timeout --preserve-status 10s node node_modules/.bin/tsx src/backend/index.ts
+          timeout --preserve-status 10s node src/backend/index.ts
          exitcode="$?"
          if [[ "$exitcode" -eq 143 ]] || [[ "$exitcode" -eq 137 ]]; then
            echo "App stayed up long enough and exited with expected status"
@@ -151,4 +151,12 @@ tmp-*

 *storybook.log
 storybook-static
-lib
+
+*.db
+*.db*
+
+**/lexicons/**/*.json
+
+bun.lock
+.DS_Store
+**/.DS_Store
@@ -1,7 +1,6 @@
 {
  "reporter": "dot",
  "extension": "ts",
-  "import": "tsx/esm",
  "spec": "./src/backend/tests/**/*.test.ts",
  "file": [
    "./src/backend/tests/setup.ts"
@@ -12,12 +12,14 @@ export default defineMain({
 //    "@storybook/addon-vitest",
    "@storybook/addon-a11y",
    "@storybook/addon-docs",
+    'storybook-addon-remix-react-router'
 //    "@storybook/addon-onboarding"
  ],
  features: {
    // https://github.com/storybookjs/storybook/discussions/33279
    sidebarOnboardingChecklist: false,
  },
+   staticDirs: ['../public'],
  "framework": "@storybook/react-vite",
    viteFinal: async (config) => {
    return mergeConfig(config, {
@@ -2,5 +2,5 @@ import { addons } from 'storybook/manager-api';
 import { themes } from 'storybook/theming';
 
 addons.setConfig({
-  theme: themes.dark,
+  theme: themes.normal,
 });
@@ -3,8 +3,17 @@ import addonA11y from "@storybook/addon-a11y";
 import { definePreview } from "@storybook/react-vite";

 import { themes } from 'storybook/theming';
+import { initialize, mswLoader, getWorker } from 'msw-storybook-addon';
+
+// https://github.com/mswjs/msw-storybook-addon/issues/82#issuecomment-3894302575
+try {
+  getWorker();
+} catch (_) {
+  initialize();
+}

 export default definePreview({
+  loaders: [mswLoader],
  parameters: {
    controls: {
      matchers: {
@@ -20,7 +29,7 @@ export default definePreview({
      test: 'todo'
    },
    docs: {
-      theme: themes.dark,
+      theme: themes.normal,
    },
  },

@@ -0,0 +1,6 @@
+{
+    "recommendations": [
+        "sanjulaganepola.github-local-actions",
+        "github.vscode-github-actions"
+    ]
+}
@@ -1,13 +1,44 @@
 {
    "version": "0.2.0",
    "configurations": [
+        {
+            "name": "Debug Zod Conversion",
+            "type": "node",
+            "request": "launch",
+            // Debug app in VSCode
+            "program": "${workspaceFolder}/ts-zod.ts",
+            "args": [
+                "${file}"
+            ],
+            "runtimeExecutable": "node",
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen",
+            "skipFiles": [
+                "<node_internals>/**",
+                // Ignore all dependencies (optional)
+                "${workspaceFolder}/node_modules/**",
+            ],
+        },
+        {
+            "name": "Run Canonical Replace",
+            "program": "${workspaceFolder}/docsite/canonical-replace.ts",
+            "runtimeArgs": ["--experimental-strip-types"],
+            "args": [
+                "${workspaceFolder}/docsite/build"
+            ],
+            "request": "launch",
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "type": "node"
+        },
        {
            "name": "dev",
            "type": "node",
            "request": "launch",
            // Debug app in VSCode
            "program": "${workspaceFolder}/src/backend/index.ts",
-            "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
+            "runtimeExecutable": "node",
            "console": "integratedTerminal",
            "internalConsoleOptions": "neverOpen",
            "skipFiles": [
@@ -22,7 +53,7 @@
            "request": "launch",
            // Debug app in VSCode
            "program": "${workspaceFolder}/src/backend/index.ts",
-            "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
+            "runtimeExecutable": "node",
            "console": "integratedTerminal",
            "envFile": "${workspaceFolder}/.env",
            "env": {
@@ -35,28 +66,13 @@
                "${workspaceFolder}/node_modules/**",
            ],
        },
-        {
-            "name": "tsx",
-            "type": "node",
-            "request": "launch",
-            // Debug current file in VSCode
-            "program": "${file}",
-            "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
-            "console": "integratedTerminal",
-            "internalConsoleOptions": "neverOpen",
-            "skipFiles": [
-                "<node_internals>/**",
-                // Ignore all dependencies (optional)
-                "${workspaceFolder}/node_modules/**",
-            ],
-        },
        {
            "name": "schema",
            "type": "node",
            "request": "launch",
            // Debug app in VSCode
-            "program": "${workspaceFolder}/src/backend/utils/SchemaStaticUtil.ts",
-            "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
+            "program": "${workspaceFolder}/src/backend/utils/SchemaDocsStaticUtils.ts",
+            "runtimeExecutable": "node",
            "console": "integratedTerminal",
            "internalConsoleOptions": "neverOpen",
            "skipFiles": [
@@ -83,7 +99,7 @@
                "--recursive",
                "${workspaceFolder}/src/backend/tests/**/*.test.ts"
            ],
-            "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
+            "runtimeExecutable": "node",
            "internalConsoleOptions": "openOnSessionStart",
            "name": "Mocha Tests",
            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
@@ -107,7 +123,7 @@
                "--config", "${workspaceRoot}/.mocharc.json",
                "${file}"
            ],
-            "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
+            "runtimeExecutable": "node",
            "internalConsoleOptions": "openOnSessionStart",
            "name": "Mocha Test on File",
            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
@@ -1,5 +1,4 @@
 {
-    "mochaExplorer.require": "tsx/esm",
    "mochaExplorer.timeout": 1200000,
    "mochaExplorer.exit": true,
    "search.exclude": {
@@ -11,7 +10,9 @@
        "docsite/**"
    ],
    "files.associations": {
-        "*.css": "tailwindcss"
+        "*.css": "tailwindcss",
+        "**/config/*.json": "jsonc"
    },
-    "tailwindCSS.experimental.configFile": "src/client/index.css"
+    "tailwindCSS.experimental.configFile": "src/client/index.css",
+    
 }
@@ -56,6 +56,7 @@ RUN npm install -g concurrently
 ARG data_dir=/config
 VOLUME $data_dir
 ENV CONFIG_DIR=$data_dir
+ENV DATA_DIR=$data_dir

 COPY docker/root /

@@ -114,10 +115,10 @@ 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 \
+    ## peerDependency of validbot and can(?) be removed for production
+    && rm -r node_modules/typescript \
    && npx @usex/prune-mod -w \
    && rm -rf /root/.cache

@@ -12,6 +12,7 @@ alt="multi-scrobbler logo" width="180" height="180">
 A dockerized app that monitors your music listening activity from *everywhere* and scrobbles it *anywhere*.

 * Supports scrobbling from many [**Sources**](https://docs.multi-scrobbler.app/configuration/sources)
+    * [Apple Music](https://docs.multi-scrobbler.app/configuration/sources/applemusic/?configType=file)
    * [Azuracast](https://docs.multi-scrobbler.app/configuration/sources/azuracast)
    * [Deezer](https://docs.multi-scrobbler.app/configuration/sources/deezer)
    * [Google Cast (Chromecast)](https://docs.multi-scrobbler.app/configuration/sources/google-cast)
@@ -0,0 +1,29 @@
+[
+  {
+    "id": "myAppleMusic",
+    "name": "My Apple Music",
+    "enable": true,
+    "clients": [],
+    "data": {
+      // either key or token needs to be provided
+      "key": {
+        "id": "2HPSNJZ88N",
+        "teamId": "SN6YASW8G4",
+        "p8": "-----BEGIN PRIVATE KEY-----\nMIGTAgEAMBMGByqGSM49AgEG...-----END PRIVATE KEY-----"
+      },
+      "token": "your-jwt-token-here",
+      "mediaUserToken": "your-media-user-token-here",
+
+      // optional: Origin header for API requests (required when using a browser token)
+      "origin": "https://music.apple.com",
+
+      // optional: polling interval in seconds (default 60)
+      "interval": 60
+    },
+    "options": {
+      "logDiff": true,
+      "recoverUnchangedTopHistory": true,
+      "normalizeAlbum": true
+    }
+  }
+]
@@ -2,7 +2,8 @@
  {
    "type": "azuracast",
    "enable": true,
-    "name": "azura",
+    "name": "Cool Station",
+    "id": "myAzura",
    "data": {
      "url": "ws://192.168.0.101",
      "station": "my-station-name",
@@ -1,6 +1,7 @@
 [
  {
-    "name": "MyCast",
+    "name": "My Cast",
+    "id": "myCast",
    "data": {
      "blacklistedDevices": [],
      "whitelistedDevices": [],
@@ -22,7 +22,8 @@
      "type": "spotify",
      "enable": true,
      "clients": ["myConfig"],
-      "name": "mySpotifySource",
+      "name": "Cool Spotify Name",
+      "id": "mySpotifyId",
      "data": {
        "clientId": "a89cba1569901a0671d5a9875fed4be1",
        "clientSecret": "ec42e09d5ae0ee0f0816ca151008412a",
@@ -34,7 +35,8 @@
    {
      "type": "maloja",
      "enable": true,
-      "name": "myConfig",
+      "name": "Foxx Maloja",
+      "id": "myMalojaId",
      "data": {
        "url": "http://localhost:42010",
        "apiKey": "myMalojaKey"
@@ -1,6 +1,7 @@
 [
  {
-    "name": "DeezerARL",
+    "name": "Family Account",
+    "id": "myDeezerId",
    "enable": true,
    "clients": [],
    "data": {
@@ -1,7 +1,8 @@
 [
    {
-      "name": "MS",
+      "name": "Desktop",
      "enable": true,
+      "id": "myDiscordLocal",
      "data": {
        "applicationId": "8190211179716453570",
        "ipcLocations": ["192.168.0.105:6655"]
@@ -1,11 +1,11 @@
 [
-    {
-      "name": "MS",
-      "enable": true,
-      "data": {
-        "token": "Ma7XBvzRERK3gQdkX4dkb3OQ.6aaGmJ.rvFiiVrzG4VXHHL3LyhZYhpWdG3Ph_if9aKz5E",
-        "applicationId": "8190211179716453570"
-      }
+  {
+    "name": "Discord",
+    "enable": true,
+    "id": "myDiscordRemote",
+    "data": {
+      "token": "Ma7XBvzRERK3gQdkX4dkb3OQ.6aaGmJ.rvFiiVrzG4VXHHL3LyhZYhpWdG3Ph_if9aKz5E",
+      "applicationId": "8190211179716453570"
    }
-  ]
-  
+  }
+]
@@ -1,7 +1,8 @@
 [
  {
-    "name": "myLfm",
+    "name": "LFM For App",
    "enable": true,
+    "id": "myLfmApp",
    "data": {
      "slug": "mySlug"
    }
@@ -1,6 +1,7 @@
 [
  {
-    "name": "myLz",
+    "name": "LZ for Navidrome",
+    "id": "myLzNavidrome",
    "enable": true,
    "data": {
      "token": "myToken"
@@ -1,7 +1,8 @@
 [
    {
-      "name": "myIcy",
+      "name": "Station 1",
      "enable": true,
+      "id": "myIceStation1",
      "data": {
        "url": "http://myIcecast.com/radio"
      }
@@ -1,7 +1,8 @@
 [
  {
-    "name": "MyJellyfin",
+    "name": "Cool JF Server",
    "enable": true,
+    "id": "myJellyfin",
    "clients": [],
    "data": {
      "url": "http://localhost:8096",
@@ -1,6 +1,7 @@
 [
  {
-    "name": "MyJriver",
+    "name": "My JRiver Server",
+    "id": "myRiver",
    "enable": true,
    "data": {
      "url": "0.0.0.0",
@@ -1,6 +1,7 @@
 [
  {
-    "name": "MyKodi",
+    "name": "My Kodi Server",
+    "id": "myKodi",
    "enable": true,
    "data": {
      "url": "http://localhost:8080/jsonrpc",
@@ -1,6 +1,7 @@
 [
-      {
-    "name": "koito-client",
+  {
+    "name": "Koito Client A",
+    "id": "myKoitoClient",
    "configureAs": "client",
    "data": {
      "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
@@ -9,7 +10,8 @@
    }
  },
  {
-    "name": "koito-source",
+    "name": "Koito Source B",
+    "id": "myKoitoSource",
    "configureAs": "source",
    "data": {
      "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
@@ -1,6 +1,7 @@
 [
  {
-    "name": "myLastFmClient",
+    "name": "Foxx LFM Client",
+    "id": "myLastFmClient",
    "enable": true,
    "configureAs": "client",
    "data": {
@@ -10,7 +11,8 @@
    }
  },
  {
-    "name": "myLastFmSource",
+    "name": "Foxx LFM Source",
+    "id": "myLastFmSource",
    "enable": true,
    "configureAs": "source",
    "data": {
@@ -1,6 +1,7 @@
 [
  {
-    "name": "myLibreFmClient",
+    "name": "Foxx Libre Client",
+    "id": "myLibreFmClient",
    "enable": true,
    "configureAs": "client",
    "data": {
@@ -10,7 +11,8 @@
    }
  },
  {
-    "name": "myLibreFmSource",
+    "name": "Foxx Libre Source",
+    "id": "myLibreFmSource",
    "enable": true,
    "configureAs": "source",
    "data": {
@@ -1,6 +1,7 @@
 [
  {
-    "name": "brainzClient",
+    "name": "Foxx LZ Client",
+    "id": "brainzClient",
    "enable": true,
    "configureAs": "client",
    "data": {
@@ -10,7 +11,8 @@
    }
  },
  {
-    "name": "brainzSource",
+    "name": "Foxx LZ Source",
+    "id": "brainzSource",
    "enable": true,
    "configureAs": "source",
    "data": {
@@ -1,6 +1,7 @@
 [
  {
-    "name": "myMaloja-client",
+    "name": "Maloja Client",
+    "id": "myMalojaClient",
    "enable": true,
    "configureAs": "client",
    "data": {
@@ -9,7 +10,8 @@
    }
  },
    {
-    "name": "myMaloja-source",
+    "name": "Maloja Source",
+    "id": "myMalojaSource",
    "enable": true,
    "configureAs": "source",
    "data": {
@@ -1,6 +1,7 @@
 [
  {
-    "name": "MyMopidy",
+    "name": "Mopidy Desktop",
+    "id": "MyMopidy",
    "enable": true,
    "data": {
      "url": "localhost",
@@ -1,7 +1,8 @@
 [
  {
    "enable": true,
-    "name": "MyMPD",
+    "id": "myMPD",
+    "name": "Desktop",
    "data": {
      "url": "192.168.0.100:6600",
      "password": "MY_PASSWORD"
@@ -1,6 +1,7 @@
 [
  {
-    "name": "ubuntu",
+    "name": "Desktop",
+    "id": "myMprisUbuntu",
    "enable": true,
    "data": {
      "whitelist": ["vlc", "mpd"],
@@ -1,6 +1,7 @@
 [
  {
-    "name": "myYamaha",
+    "name": "Livingroom Reciever",
+    "id": "myYamaha",
    "enable": true,
    "data": {
      "url": "192.168.0.101"
@@ -2,7 +2,8 @@
  {
    "type": "musikcube",
    "enable": true,
-    "name": "musikcube",
+    "name": "Desktop",
+    "id": "myMusikcube",
    "data": {
      "url": "ws://localhost:7905",
      "password": "MY_PASSWORD"
@@ -1,6 +1,7 @@
 [
  {
-    "name": "MyPlexApi",
+    "name": "Foxx Plex",
+    "id": "MyPlexApi",
    "enable": true,
    "clients": [],
    "data": {
@@ -1,17 +1,19 @@
 [
    {
-    "name": "myRockskyClient",
+    "id": "myRockskyClient",
+    "name": "FoxxMD Rocksky Client",
    "configureAs": "client",
    "data": {
-      "key": "7cdr86vis3mpq5b1pi01md0hkm7ykzzxjy81r",
+      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkaWQiOiJkaWQ6cGxjOng0NjVwZmtyeW5zaDZ...",
      "handle": "alice.bsky.social"
    }
  },
  {
-    "name": "myRockskySource",
+    "id": "myRockskySource",
+    "name": "FoxxMD Rocksky Source",
    "configureAs": "source",
    "data": {
-      "key": "e4xwktm7jxm607x8el1fcda30eu14dzb64h3j",
+      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkaWQiOiJkaWQ6cGxjOng0NjVwZmtyeW5zaDZ...",
      "handle": "alice.bsky.social"
    }
  }
@@ -1,7 +1,8 @@
 [
  {
    "enable": true,
-    "name": "MySonos",
+    "id": "MySonos",
+    "name": "Boom 2",
    "data": {
      "host": "192.168.0.150",
      "devicesAllow": ["move","beam"],
@@ -1,6 +1,7 @@
 [
  {
-    "name": "MySpotify",
+    "id": "MySpotify",
+    "name": "Foxx Spotify",
    "enable": true,
    "clients": [],
    "data": {
@@ -1,12 +1,14 @@
 [
  {
-    "name": "MySubsonic",
+    "id": "mySubsonic",
+    "name": "Airsonic Server",
    "enable": true,
    "data": {
      "url": "http://localhost:4040/airsonic",
      "user": "yourUser",
      "password": "yourPassword",
-      "usersAllow": ["yourUser"]
+      "usersAllow": ["yourUser"],
+      "detectStaleNowPlayingFromMinutesAgo": true
    }
  }
 ]
@@ -1,6 +1,7 @@
 [
    {
-        "name": "myTeal",
+        "id": "myTealClient",
+        "name": "Foxx Teal Client",
        "configureAs": "client",
        "data": {
            "identifier": "alice.bsky.social",
@@ -8,7 +9,8 @@
        }
    },
        {
-        "name": "myTealSource",
+        "id": "myTealSource",
+        "name": "Foxx Teal Source",
        "configureAs": "source",
        "data": {
            "identifier": "alice.bsky.social",
@@ -1,7 +1,8 @@
 [
  {
    "enable": true,
-    "name": "MyVlc",
+    "id": "myVlc",
+    "name": "Desktop",
    "data": {
      "url": "localhost:8080",
      "password": "changeme"
@@ -1,6 +1,7 @@
 [
  {
-    "name": "MyWebScrobbler",
+    "id": "MyWebScrobbler",
+    "name": "Firefox Laptop",
    "data": {
      "slug": "MyOptionalSlug",
      "whitelist": [],
@@ -1,5 +1,6 @@
 [
  {
+    "id": "myYandex",
    "name": "Yandex Music",
    "type": "ymbridge",
    "data": {
@@ -1,6 +1,7 @@
 [
  {
-    "name": "MyYTMusic",
+    "id": "myYtMusic",
+    "name": "Foxx YT Music",
    "enable": true,
    "clients": [],
    "data": {
@@ -1,33 +1,19 @@
 #!/usr/bin/with-contenv bash

-# used https://github.com/linuxserver/docker-plex as a template
-
-POPULATE_EXAMPLES=false
-
 echo "-------------------------------------"
-echo -e "Setting up multi-scrobbler config directory based on CONFIG_DIR env: ${CONFIG_DIR}\n"
+echo -e "Verifying multi-scrobbler directory permissions based on CONFIG_DIR env: ${CONFIG_DIR} and DATA_DIR env: ${DATA_DIR}\n"

-# make config folder if it does not exist
-if [ ! -d "${CONFIG_DIR}" ]; then
-  echo "Directory does not exist! Creating..."
-  POPULATE_EXAMPLES=true
-  mkdir -p "${CONFIG_DIR}"
-else
-  if [ "$(ls -A ${CONFIG_DIR})" ]; then
-       echo "Directory is not empty, not creating examples."
-    else
-      POPULATE_EXAMPLES=true
-    fi
+if [ -d "${CONFIG_DIR}" ]; then
+  echo "chown'ing config directory to ensure correct permissions."
+  chown -R abc:abc "${CONFIG_DIR}"
+  echo "Done!"
 fi

-# add example configs
-if [ "$POPULATE_EXAMPLES" = true ]; then
-  echo "Directory is empty, adding examples..."
-  cp -r /app/config/. "${CONFIG_DIR}"/
+if [ -d "${DATA_DIR}" ]; then
+  echo "chown'ing data directory to ensure correct permissions."
+  chown -R abc:abc "${DATA_DIR}"
+  echo "Done!"
 fi

-# permissions
-echo "chown'ing directory to ensure correct permissions."
-chown -R abc:abc "${CONFIG_DIR}"
 echo "Done!"
 echo -e "-------------------------------------\n"
@@ -7,4 +7,4 @@ echo -e "\nmulti-scrobbler is starting!"
 export NODE_ENV=production
 cd /app || exit
 exec \
-	  s6-setuidgid abc /usr/bin/node $NODE_ARGS /app/node_modules/.bin/tsx /app/src/backend/index.ts
+	  s6-setuidgid abc /usr/bin/node $NODE_ARGS /app/src/backend/index.ts
@@ -18,3 +18,4 @@
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+lib
@@ -0,0 +1,42 @@
+
+import fs from 'node:fs/promises';
+import path from 'node:path';
+
+var args = process.argv.slice(2);
+
+const linkRegex = new RegExp(/<link data-rh="true" rel="\w+"\shref="(https:\/\/foxxmd\.github\.io\/multi-scrobbler)/g,);
+const replacement = process.env.CANONICAL_HREF ?? 'https://docs.multi-scrobbler.app';
+
+/**
+ * Replace canonical and alternative <link> nodes with the "real" domain of the site
+ * so that SEO (google) chooses the correct domain when showing search results
+ * 
+ */
+
+(async function () {
+
+    if(replacement === undefined || replacement === '') {
+        console.warn('No replacement value found in process.env.CANONICAL_HREF');
+        return;
+    }
+
+    const buildDir = path.resolve(args[0]);
+    console.log(`Reading dir recursively ${buildDir}`);
+    const files = (await fs.readdir(buildDir, { recursive: true })).filter(x => x.includes('.html'));
+    console.log(`Found ${files.length} files with .html extensions`);
+    let modifications = 0;
+
+    await Promise.all(files.map(async (x) => {
+            const filePath = path.resolve(path.join(buildDir, x));
+            //console.log(`Replacing at ${filePath}`);
+            await fs.writeFile(filePath, (await fs.readFile(filePath)).toString().replace(linkRegex, (match, capture, offset, string, groups) => {
+                // this may not be fully accurate since we're mutating concurrently/async
+                // but its a good enough signal for logging to tell if replacements happened
+                modifications++;
+                return match.replace(capture, replacement);
+            }));
+    }));
+
+    console.log(`Done with ${modifications} replacements`);
+
+}());
@@ -0,0 +1,177 @@
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs groupId="configType" queryString>
+<TabItem value="file" label="File">
+
+Using [File Config](/configuration/?configType=file#configuration-types)
+
+```json5 title="CONFIG_DIR/jellyin.json"
+[
+  {
+    "id": "fredJf",
+    "name": "Freds Jellyfin",
+    "clients": ["fredLFM"],
+    "data": {
+      "url": "https://jellyfin.fred.com",
+      "user": "Fred",
+      "apiKey": "c9fae8756fbf481ebd9c5bb56bd6540c"
+    }
+  },
+  {
+    "id": "maryJf",
+    "name": "Marys Jellyfin",
+    "clients": ["maryLFM"],
+    "data": {
+      "url": "https://jellyfin.mary.com",
+      "user": "Mary",
+      "apiKey": "26fe9c5dc6374542adc4f4d5e8352838"
+    }
+  }
+]
+```
+
+```json5 title="CONFIG_DIR/plex.json"
+[
+  {
+    "id": "foxxPlex",
+    "name": "Foxx Plex",
+    "clients": ["foxxKoi"],
+    "data": {
+      "token": "JtRnwQWD__XMJF8sT3jc",
+      "url": "192.168.0.233:32400"
+    }
+  }
+]
+```
+
+```json5 title="CONFIG_DIR/lastfm.json"
+[
+  {
+    "id": "maryLFM",
+    "name": "Marys Lastfm",
+    "configureAs": "client",
+    "data": {
+      "apiKey": "maryApiKey",
+      "secret": "marySecret",
+      "redirectUri": "http://localhost:9078/lastfm/callback"
+    }
+  },
+  {
+    "id": "fredLFM",
+    "name": "Freds Lastfm",
+    "configureAs": "client",
+    "data": {
+      "apiKey": "fredApiKey",
+      "secret": "fredSecret",
+      "redirectUri": "http://localhost:9078/lastfm/callback"
+    }
+  }
+]
+```
+
+```json5 title="CONFIG_DIR/koito.json"
+[
+  {
+    "id": "foxxKoi",
+    "name": "Foxx Koito",
+    "configureAs": "client",
+    "data": {
+      "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
+      "username": "admin",
+      "url": "http://192.168.0.100:4110"
+    }
+  }
+]
+```
+
+</TabItem>
+
+<TabItem value="aio" label="AIO">
+
+Using [AIO Config](/configuration/?configType=aio#configuration-types)
+
+```json5 title="CONFIG_DIR/config.json"
+{
+  "sources": [
+    {
+      "type": "jellyfin",
+      "id": "fredJf",
+      "name": "Freds Jellyfin",
+      "clients": [
+        "fredLFM"
+      ],
+      "data": {
+        "url": "https://jellyfin.fred.com",
+        "user": "Fred",
+        "apiKey": "c9fae8756fbf481ebd9c5bb56bd6540c"
+      }
+    },
+    {
+      "type": "jellyfin",
+      "id": "maryJf",
+      "name": "Marys Jellyfin",
+      "clients": [
+        "maryLFM"
+      ],
+      "data": {
+        "url": "https://jellyfin.mary.com",
+        "user": "Mary",
+        "apiKey": "26fe9c5dc6374542adc4f4d5e8352838"
+      }
+    },
+    {
+      "type": "plex",
+      "id": "foxxPlex",
+      "name": "Foxx Plex",
+      "clients": [
+        "foxxKoi"
+      ],
+      "data": {
+        "token": "JtRnwQWD__XMJF8sT3jc",
+        "url": "192.168.0.233:32400",
+        "usersallow": [
+          "foxx"
+        ]
+      }
+    }
+  ],
+  "clients": [
+    {
+      "type": "lastfm",
+      "id": "maryLFM",
+      "name": "Marys Lastfm",
+      "configureAs": "client",
+      "data": {
+        "apiKey": "maryApiKey",
+        "secret": "marySecret",
+        "redirectUri": "http://localhost:9078/lastfm/callback"
+      }
+    },
+    {
+      "type": "lastfm",
+      "id": "fredLFM",
+      "name": "Freds Lastfm",
+      "configureAs": "client",
+      "data": {
+        "apiKey": "fredApiKey",
+        "secret": "fredSecret",
+        "redirectUri": "http://localhost:9078/lastfm/callback"
+      }
+    },
+    {
+      "type": "koito",
+      "id": "foxxKoi",
+      "name": "Foxx Koito",
+      "configureAs": "client",
+      "data": {
+        "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
+        "username": "admin",
+        "url": "http://192.168.0.100:4110"
+      }
+    }
+  ]
+}
+```
+</TabItem>
+</Tabs>
@@ -0,0 +1,196 @@
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs groupId="configType" queryString>
+<TabItem value="env" label="ENV">
+
+Using [ENV Config](/configuration/?configType=env#configuration-types)
+
+```yaml title="compose.yaml"
+services:
+  multi-scrobbler:
+    image: foxxmd/multi-scrobbler
+    container_name: multi-scrobbler
+    environment:
+      - TZ=Etc/GMT # Specify timezone from TZ Database name found here https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+      # spotify
+      - SPOTIFY_ID=foxxSpotify
+      - SPOTIFY_CLIENT_ID=H2UvGv8okrFlv2OUoc1lAtK7Xe5EGDgs
+      - SPOTIFY_CLIENT_SECRET=HvoFE5Ce2hdblNE6vaFBEx6dRVcDdo43
+      - SPOTIFY_REDIRECT_URI=https://multiscrobbler.example.com/callback
+
+      # navidrome listenbrainz endpoint
+      - LZE_ID=myLzNavidrome
+      - LZE_TOKEN=myToken
+
+      # plex
+      - PLEX_ID=foxxPlex
+      - PLEX_URL=192.168.0.233:32400
+      - PLEX_TOKEN=JtRnwQWD__XMJF8sT3jc
+      - PLEX_USERS_ALLOW=foxx
+      - PLEX_LIBRARIES_ALLOW=oldies
+
+      # lastfm
+      - LASTFM_ID=myLFM
+      - LASTFM_API_KEY=myApiKey
+      - LASTFM_SECRET=mySecret
+      - LASTFM_REDIRECT_URI=https://multiscrobbler.example.com/lastfm/callback
+
+      # koito
+      - KOITO_ID=foxxKoi
+      - KOITO_TOKEN=029b081ba-9156-4pe7-88e5-3be671f5ea2b
+      - KOITO_USER=admin
+      - KOITO_URL=http://192.168.0.100:4110
+
+    volumes:
+      - "./config:/config"
+    ports:
+      - "9078:9078"
+    restart: unless-stopped
+```
+
+</TabItem>
+<TabItem value="file" label="File">
+
+Using [File Config](/configuration/?configType=file#configuration-types)
+
+```json5 title="CONFIG_DIR/spotify.json"
+[
+  {
+    "id": "foxxSpotify",
+    "name": "Foxx Spotify",
+    "data": {
+      "clientId": "a89cba1569901a0671d5a9875fed4be1",
+      "clientSecret": "ec42e09d5ae0ee0f0816ca151008412a",
+      "redirectUri": "http://localhost:9078/callback",
+      "interval": 60
+    }
+  }
+]
+```
+
+```json5 title="CONFIG_DIR/endpointlz.json"
+[
+  {
+    "id": "myLzNavidrome",
+    "name": "LZ for Navidrome",
+    "data": {
+      "token": "myToken"
+    }
+  }
+]
+```
+
+```json5 title="CONFIG_DIR/plex.json"
+[
+  {
+    "id": "foxxPlex",
+    "name": "Foxx Plex",
+    "data": {
+      "token": "JtRnwQWD__XMJF8sT3jc",
+      "url": "192.168.0.233:32400",
+      "usersallow": ["foxx"],
+      "librariesAllow": ["oldies"],
+    }
+  }
+]
+```
+
+```json5 title="CONFIG_DIR/lastfm.json"
+[
+  {
+    "id": "myLFM",
+    "name": "Old Lastfm",
+    "configureAs": "client",
+    "data": {
+      "apiKey": "myApiKey",
+      "secret": "mySecret",
+      "redirectUri": "http://localhost:9078/lastfm/callback"
+    }
+  }
+]
+```
+
+```json5 title="CONFIG_DIR/koito.json"
+[
+  {
+    "id": "foxxKoi",
+    "name": "Foxx Koito",
+    "configureAs": "client",
+    "data": {
+      "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
+      "username": "admin",
+      "url": "http://192.168.0.100:4110"
+    }
+  }
+]
+```
+
+</TabItem>
+
+<TabItem value="aio" label="AIO">
+
+Using [AIO Config](/configuration/?configType=aio#configuration-types)
+
+```json5 title="CONFIG_DIR/config.json"
+{
+  "sources": [
+    {
+      "type": "spotify",
+      "id": "foxxSpotify",
+      "name": "Foxx Spotify",
+      "data": {
+        "clientId": "a89cba1569901a0671d5a9875fed4be1",
+        "clientSecret": "ec42e09d5ae0ee0f0816ca151008412a",
+        "redirectUri": "http://localhost:9078/callback",
+        "interval": 60
+      }
+    },
+    {
+      "type": "endpointlz",
+      "name": "LZ for Navidrome",
+      "id": "myLzNavidrome",
+      "data": {
+        "token": "myToken"
+      }
+    },
+    {
+      "type": "plex",
+      "id": "foxxPlex",
+      "name": "Foxx Plex",
+      "data": {
+        "token": "JtRnwQWD__XMJF8sT3jc",
+        "url": "192.168.0.233:32400",
+        "usersallow": ["foxx"],
+        "librariesAllow": ["oldies"]
+      }
+    }
+  ],
+  "clients": [
+    {
+      "type": "lastfm",
+      "id": "myLFM",
+      "name": "Old Lastfm",
+      "configureAs": "client",
+      "data": {
+        "apiKey": "myApiKey",
+        "secret": "mySecret",
+        "redirectUri": "http://localhost:9078/lastfm/callback"
+      }
+    },
+    {
+      "type": "koito",
+      "id": "foxxKoi",
+      "name": "Foxx Koito",
+      "configureAs": "client",
+      "data": {
+        "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
+        "username": "admin",
+        "url": "http://192.168.0.100:4110"
+      }
+    }
+  ]
+}
+```
+</TabItem>
+</Tabs>
@@ -0,0 +1,226 @@
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+<Tabs groupId="configType" queryString>
+<TabItem value="env" label="ENV">
+
+Using [ENV Config](/configuration/?configType=env#configuration-types)
+
+```yaml title="compose.yaml"
+services:
+  multi-scrobbler:
+    image: foxxmd/multi-scrobbler
+    container_name: multi-scrobbler
+    environment:
+      - TZ=Etc/GMT # Specify timezone from TZ Database name found here https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+
+      # required setup for musicbrainz
+      - MB_CONTACT=contact@mydomain.com # a real email
+       # searches with sensible release sorting with the searchOrder
+       # isrc => basic => artist (native mode)
+      - MB_PRESETS=default,sensible,native
+
+      # spotify
+      - SPOTIFY_ID=foxxSpotify
+      - SPOTIFY_CLIENT_ID=H2UvGv8okrFlv2OUoc1lAtK7Xe5EGDgs
+      - SPOTIFY_CLIENT_SECRET=HvoFE5Ce2hdblNE6vaFBEx6dRVcDdo43
+      - SPOTIFY_REDIRECT_URI=https://multiscrobbler.example.com/callback
+
+      # navidrome listenbrainz endpoint
+      - LZE_ID=myLzNavidrome
+      - LZE_TOKEN=myToken
+      # applies musicbrainz Stage to preTransform of navidrome source
+      - LZE_TRANSFORMS=musicbrainz
+
+      # lastfm
+      - LASTFM_ID=myLFM
+      - LASTFM_API_KEY=myApiKey
+      - LASTFM_SECRET=mySecret
+      - LASTFM_REDIRECT_URI=https://multiscrobbler.example.com/lastfm/callback
+
+    volumes:
+      - "./config:/config"
+    ports:
+      - "9078:9078"
+    restart: unless-stopped
+```
+
+</TabItem>
+<TabItem value="file" label="File">
+
+Using [File Config](/configuration/?configType=file#configuration-types)
+
+For non-ENV config, [Musicbrainz Transformer](/configuration/transforms/musicbrainz/#api-setup) must be setup using the [AIO Config](/configuration/?configType=aio#configuration-types) `config.json` file. This configuration uses the [sensible defaults](/configuration/transforms/musicbrainz/#sensible-default) in the `defaults` property. This is a suggestion and can be removed if not desired.
+
+```json5 title="CONFIG_DIR/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"
+        ]
+      }
+    }
+  ]
+}
+```
+
+```json5 title="CONFIG_DIR/spotify.json"
+[
+  {
+    "id": "foxxSpotify",
+    "name": "Foxx Spotify",
+    "data": {
+      "clientId": "a89cba1569901a0671d5a9875fed4be1",
+      "clientSecret": "ec42e09d5ae0ee0f0816ca151008412a",
+      "redirectUri": "http://localhost:9078/callback",
+      "interval": 60
+    }
+  }
+]
+```
+
+```json5 title="CONFIG_DIR/endpointlz.json"
+[
+  {
+    "id": "myLzNavidrome",
+    "name": "LZ for Navidrome",
+    "data": {
+      "token": "myToken"
+    },
+    "options": {
+      "playTransform": {
+        "preCompare": [
+          {
+            "type": "musicbrainz",
+            "name": "MyMB"
+          }
+        ]
+      }
+    }
+  }
+]
+```
+
+
+```json5 title="CONFIG_DIR/lastfm.json"
+[
+  {
+    "id": "myLFM",
+    "name": "Old Lastfm",
+    "configureAs": "client",
+    "data": {
+      "apiKey": "myApiKey",
+      "secret": "mySecret",
+      "redirectUri": "http://localhost:9078/lastfm/callback"
+    }
+  }
+]
+```
+
+</TabItem>
+
+<TabItem value="aio" label="AIO">
+
+Using [AIO Config](/configuration/?configType=aio#configuration-types)
+
+This configuration uses the [sensible defaults](/configuration/transforms/musicbrainz/#sensible-default) in the `defaults` property. This is a suggestion and can be removed if not desired.
+
+```json5 title="CONFIG_DIR/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"
+        ]
+      }
+    }
+  ],
+  "sources": [
+    {
+      "type": "spotify",
+      "id": "foxxSpotify",
+      "name": "Foxx Spotify",
+      "data": {
+        "clientId": "a89cba1569901a0671d5a9875fed4be1",
+        "clientSecret": "ec42e09d5ae0ee0f0816ca151008412a",
+        "redirectUri": "http://localhost:9078/callback",
+        "interval": 60
+      }
+    },
+    {
+      "type": "endpointlz",
+      "name": "LZ for Navidrome",
+      "id": "myLzNavidrome",
+      "data": {
+        "token": "myToken"
+      },
+      "options": {
+        "playTransform": {
+          "preCompare": [
+            {
+              "type": "musicbrainz",
+              "name": "MyMB"
+            }
+          ]
+        }
+      }
+    }
+  ],
+  "clients": [
+    {
+      "type": "lastfm",
+      "id": "myLFM",
+      "name": "Old Lastfm",
+      "configureAs": "client",
+      "data": {
+        "apiKey": "myApiKey",
+        "secret": "mySecret",
+        "redirectUri": "http://localhost:9078/lastfm/callback"
+      }
+    }
+  ]
+}
+```
+</TabItem>
+</Tabs>
@@ -0,0 +1,12 @@
+| Environmental Variable             | Type                       | Default               | Description                             |
+| ---------------------------------- | -------------------------- | --------------------- | --------------------------------------- |
+| _**`DISCORD_ID`**_                 | string                     |                       | A globally unique ID EX `myComponentId` |
+| `DISCORD_NAME`                     | string                     | Value of `DISCORD_ID` | A vanity name EX `My Cool Component`    |
+| `DISCORD_ENABLE`                   | boolean                    | true                  | Should this component be used?          |
+| `DISCORD_TOKEN`                    | string                     |                       |                                         |
+| `DISCORD_ARTWORK`                  | boolean OR string OR array |                       |                                         |
+| `DISCORD_APPLICATION_ID`           | string                     |                       |                                         |
+| `DISCORD_IPC_LOCATIONS`            | string                     |                       |                                         |
+| `DISCORD_ARTWORK_DEFAULT_URL`      | string                     |                       |                                         |
+| `DISCORD_STATUS_OVERRIDE_ALLOW`    | string                     |                       |                                         |
+| `DISCORD_LISTENING_ACTIVITY_ALLOW` | string                     |                       |                                         |
@@ -0,0 +1,8 @@
+| Environmental Variable | Type    | Default             | Description                             |
+| ---------------------- | ------- | ------------------- | --------------------------------------- |
+| _**`KOITO_ID`**_       | string  |                     | A globally unique ID EX `myComponentId` |
+| `KOITO_NAME`           | string  | Value of `KOITO_ID` | A vanity name EX `My Cool Component`    |
+| `KOITO_ENABLE`         | boolean | true                | Should this component be used?          |
+| _**`KOITO_URL`**_      | string  |                     | URL for the Koito server                |
+| _**`KOITO_TOKEN`**_    | string  |                     | User token for the user to scrobble for |
+| _**`KOITO_USER`**_     | string  |                     | Username of the user to scrobble for    |
@@ -0,0 +1,9 @@
+| Environmental Variable | Type    | Default                               | Description                                             |
+| ---------------------- | ------- | ------------------------------------- | ------------------------------------------------------- |
+| _**`LASTFM_ID`**_      | string  |                                       | A globally unique ID EX `myComponentId`                 |
+| `LASTFM_NAME`          | string  | Value of `LASTFM_ID`                  | A vanity name EX `My Cool Component`                    |
+| `LASTFM_ENABLE`        | boolean | true                                  | Should this component be used?                          |
+| _**`LASTFM_API_KEY`**_ | string  |                                       | API Key generated from Last.fm/Libre.fm account         |
+| _**`LASTFM_SECRET`**_  | string  |                                       | Secret generated from Last.fm/Libre.fm account          |
+| `LASTFM_REDIRECT_URI`  | string  | http://localhost:9078/lastfm/callback | Optional URI to use for callback.                       |
+| `LASTFM_SESSION`       | string  |                                       | Optional session id returned from a completed auth flow |
@@ -0,0 +1,10 @@
+| Environmental Variable | Type    | Default                                | Description                                                    |
+| ---------------------- | ------- | -------------------------------------- | -------------------------------------------------------------- |
+| _**`LIBREFM_ID`**_     | string  |                                        | A globally unique ID EX `myComponentId`                        |
+| `LIBREFM_NAME`         | string  | Value of `LIBREFM_ID`                  | A vanity name EX `My Cool Component`                           |
+| `LIBREFM_ENABLE`       | boolean | true                                   | Should this component be used?                                 |
+| `LIBREFM_API_KEY`      | string  |                                        | Optional Secret for Libre.fm account                           |
+| `LIBREFM_SECRET`       | string  |                                        | Optional Secret for Libre.fm account                           |
+| `LIBREFM_REDIRECT_URI` | string  | http://localhost:9078/librefm/callback | Optional URI to use for callback.                              |
+| `LIBREFM_SESSION`      | string  |                                        | Optional session id returned from a completed auth flow        |
+| `LIBREFM_URLBASE`      | string  | https://libre.fm/2.0/                  | (Optional) The host and path prefix for your Libre.fm instance |
@@ -0,0 +1,8 @@
+| Environmental Variable | Type    | Default                       | Description                                               |
+| ---------------------- | ------- | ----------------------------- | --------------------------------------------------------- |
+| _**`LZ_ID`**_          | string  |                               | A globally unique ID EX `myComponentId`                   |
+| `LZ_NAME`              | string  | Value of `LZ_ID`              | A vanity name EX `My Cool Component`                      |
+| `LZ_ENABLE`            | boolean | true                          | Should this component be used?                            |
+| `LZ_URL`               | string  | https://api.listenbrainz.org/ | URL for the ListenBrainz server, if not using the default |
+| _**`LZ_TOKEN`**_       | string  |                               | User token for the user to scrobble for                   |
+| _**`LZ_USER`**_        | string  |                               | Username of the user to scrobble for                      |
@@ -0,0 +1,7 @@
+| Environmental Variable | Type    | Default              | Description                             |
+| ---------------------- | ------- | -------------------- | --------------------------------------- |
+| _**`MALOJA_ID`**_      | string  |                      | A globally unique ID EX `myComponentId` |
+| `MALOJA_NAME`          | string  | Value of `MALOJA_ID` | A vanity name EX `My Cool Component`    |
+| `MALOJA_ENABLE`        | boolean | true                 | Should this component be used?          |
+| _**`MALOJA_URL`**_     | string  |                      | URL for maloja server                   |
+| _**`MALOJA_API_KEY`**_ | string  |                      | API Key for Maloja server               |
@@ -0,0 +1,8 @@
+| Environmental Variable | Type    | Default               | Description                                                                                                                                      |
+| ---------------------- | ------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
+| _**`ROCKSKY_ID`**_     | string  |                       | A globally unique ID EX `myComponentId`                                                                                                          |
+| `ROCKSKY_NAME`         | string  | Value of `ROCKSKY_ID` | A vanity name EX `My Cool Component`                                                                                                             |
+| `ROCKSKY_ENABLE`       | boolean | true                  | Should this component be used?                                                                                                                   |
+| `ROCKSKY_KEY`          | string  |                       | API Key generated from [API Applications](https://docs.rocksky.app/migrating-from-listenbrainz-to-rocksky-1040189m0) in Rocksky for your account |
+| `ROCKSKY_TOKEN`        | string  |                       | Access Token generated from https://rocksky.app/access-tokens in Rocksky for your account                                                        |
+| _**`ROCKSKY_HANDLE`**_ | string  |                       | The **fully-qualified** handle for your ATPRoto/Bluesky account                                                                                  |
@@ -0,0 +1,7 @@
+| Environmental Variable    | Type    | Default              | Description                                                                                   |
+| ------------------------- | ------- | -------------------- | --------------------------------------------------------------------------------------------- |
+| _**`TEALFM_ID`**_         | string  |                      | A globally unique ID EX `myComponentId`                                                       |
+| `TEALFM_NAME`             | string  | Value of `TEALFM_ID` | A vanity name EX `My Cool Component`                                                          |
+| `TEALFM_ENABLE`           | boolean | true                 | Should this component be used?                                                                |
+| _**`TEALFM_IDENTIFIER`**_ | string  |                      | Identify the account to login as                                                              |
+| _**`TEALFM_APP_PW`**_     | string  |                      | The [App Password](https://atproto.com/specs/xrpc#app-passwords) you created for your account |
@@ -17,10 +17,10 @@ A **Client** is an application that stores the historical information about what
 | [Last.fm](/configuration/clients/lastfm)            | ✅          |
 | [Libre.fm](/configuration/clients/librefm)          | ✅          |
 | [Listenbrainz](/configuration/clients/listenbrainz) | ✅          |
-| [Koito](/configuration/clients/koito)               | ❌          |
+| [Koito](/configuration/clients/koito)               | ✅          |
 | [Maloja](/configuration/clients/maloja)             | ❌          |
 | [Rocksky](/configuration/clients/rocksky)           | ❌          |
-| [Teal.fm](/configuration/clients/tealfm)            | ❌          |
+| [Teal.fm](/configuration/clients/tealfm)            | ✅          |

 ## Features

@@ -557,10 +557,12 @@ Remember, this URL need to be accessible on the public internet.
 ## 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. |
+        | Environmental Variable         | Type              | Default               | Description                                                                                                      |
+        | :----------------------------- | ----------------- | --------------------- | :--------------------------------------------------------------------------------------------------------------- |
+        | _**`DISCORD_ID`**_             | string            |                       | A globally unique ID EX `myComponentId`                                                                          |
+        | `DISCORD_NAME`                 | string            | Value of `DISCORD_ID` | A vanity name EX `My Cool Component`                                                                             |
+        | _**`DISCORD_APPLICATION_ID`**_ | string            |                       | Application ID                                                                                                   |
+        | `DISCORD_IPC_LOCATIONS`        | string            |                       | A commera-separated list of `host:port` network locations or file paths to unix socket for Discord               |
+        | `DISCORD_ARTWORK`              | boolean           |                       | A boolean indicating if external artwork URLs should be used. Or a comma-separated list of allowed domains       |
+        | `DISCORD_ARTWORK_DEFAULT_URL`  | string or boolean |                       | 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>
@@ -22,7 +22,7 @@ Check the [main Discord docs page](/configuration/clients/discord) for a compari

 <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.
+Multi-scrobbler does its utmost 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.

@@ -323,12 +323,14 @@ The order in which multi-scrobbler determines what image to use is the same as t
 ## 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. |
+        | Environmental Variable             | Type              | Default               | Description                                                                                                       |
+        | :--------------------------------- | ----------------- | --------------------- | :---------------------------------------------------------------------------------------------------------------- |
+        | _**`DISCORD_ID`**_                 | string            |                       | A globally unique ID EX `myComponentId`                                                                           |
+        | `DISCORD_NAME`                     | string            | Value of `DISCORD_ID` | A vanity name EX `My Cool Component`                                                                              |
+        | _**`DISCORD_TOKEN`**_              | string            |                       | User Token acquired from an active Discord sessions                                                               |
+        | `DISCORD_APPLICATION_ID`           | string            |                       | Application ID used to display album art                                                                          |
+        | `DISCORD_ARTWORK`                  | boolean           |                       | A boolean indicating if external artwork URLs should be used. Or a comma-separated list of allowed domains        |
+        | `DISCORD_ARTWORK_DEFAULT_URL`      | string or boolean |                       | 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`    | string            | `online,idle,dnd`     | A comma-separated list of statuses are allowed to have presence.                                                  |
+        | `DISCORD_LISTENING_ACTIVITY_ALLOW` | string            |                       | A commera-seperated list of listening activity names MS **is allowed** to broadcast presence at the same time as. |
 </Config>
@@ -8,6 +8,7 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import CodeBlock from '@theme/CodeBlock';
 import JsonConfig from '!!raw-loader!@site/../config/koito.json.example';
+import ENVConfig from "@site/docs/configuration/clients/_env_configs/_koito.md"

 :::tip[Other Uses]

@@ -51,10 +52,6 @@ For Koito versions `<=0.1.7`, you must have the environment variable `KOITO_ALLO

 ## Configuration

-<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 |
+<Config config="KoitoClientConfig" fileContent={JsonConfig} client ambiguous name="koito">
+<ENVConfig/>
 </Config>
@@ -8,6 +8,7 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import CodeBlock from '@theme/CodeBlock';
 import JsonConfig from '!!raw-loader!@site/../config/lastfm.json.example';
+import ENVConfig from "@site/docs/configuration/clients/_env_configs/_lastfm.md"

 :::tip[Other Users]

@@ -16,6 +17,20 @@ import JsonConfig from '!!raw-loader!@site/../config/lastfm.json.example';

 :::

+<DetailsAdmo type="warning" summary="Limits for Old Scrobbles">
+
+Last.fm will not accept scrobbles that are timestamped as **older than 2 weeks** from the current time.
+
+This is not officially documented but has been confirmed by multiple people/mods in the last.fm support forums: [[1]](https://support.last.fm/t/importing-listening-history-spotify-apple-music-and-itunes-wmp/1424/3) [[2]](https://support.last.fm/t/suggestion-allow-last-fm-pro-members-to-use-the-api-to-submit-scrobbles-older-than-2-weeks/69190/2) [[3]](https://support.last.fm/t/how-to-scrobble-complete-spotify-history/44558)
+
+Multi-scrobbler can queue scrobbles for you if the Last.fm service is unavailable, or if there is an issue with a specific scrobble. However, you are responsible for making sure these scrobbles are eventually sent to Last.fm (by retrying in the UI or retarting Last.fm client in UI) before the two week window has passed or else they will not be scrobblable *at all* unless the timestamp is changed.
+
+A future update to Multi-scrobbler will enable editing of unsent scrobble data and modifying the timestamp from the UI.
+
+If you have issues with specific scrobbles not being sent and retries/restarts do not fix it, please make sure to [create a new issue](https://github.com/FoxxMD/multi-scrobbler/issues/new?template=01-bug-report.yml) in a timely manner so that it can be resolved before the window has passed.
+
+</DetailsAdmo>
+
 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)
@@ -48,11 +63,6 @@ The Redirect URL can be explicitly specified in the configuration below, or by u

 ## 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 |
-        | `LASTFM_SESSION`       | No        |                                         | Session id. Will be generated by authentication flow if not provided.         |
+<Config config="LastfmClientConfig" fileContent={JsonConfig} client ambiguous name="lastfm">
+<ENVConfig/>
 </Config>
@@ -8,6 +8,7 @@ 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';
+import ENVConfig from "@site/docs/configuration/clients/_env_configs/_librefm.md"

 :::tip[Other Users]

@@ -15,9 +16,9 @@ import JsonConfig from '!!raw-loader!@site/../config/librefm.json.example';

 :::

-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).
+To use the official [Libre.fm](https://libre.fm/) website you will need an account. Or, you can run your own GNU FM instance [using the 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.
+No API account, [API Key, or Secret](https://github.com/libre-fm/developer/wiki/Libre.fm-fundamentals#api-keys) is currently 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

@@ -53,13 +54,6 @@ 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>
+<Config config="LibrefmClientConfig" fileContent={JsonConfig} client ambiguous name="librefm">
+<ENVConfig/>
+</Config>
@@ -8,6 +8,7 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import CodeBlock from '@theme/CodeBlock';
 import JsonConfig from '!!raw-loader!@site/../config/listenbrainz.json.example';
+import ENVConfig from "@site/docs/configuration/clients/_env_configs/_listenbrainz.md"

 :::tip[Other Users]

@@ -22,10 +23,6 @@ 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 ambiguous name="listenbrainz">
+<ENVConfig/>
 </Config>
@@ -8,6 +8,7 @@ import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import CodeBlock from '@theme/CodeBlock';
 import JsonConfig from '!!raw-loader!@site/../config/maloja.json.example';
+import ENVConfig from "@site/docs/configuration/clients/_env_configs/_maloja.md"

 Setup a [Maloja server](https://github.com/krateng/maloja?tab=readme-ov-file#how-to-install) if you have not already done this.

@@ -37,9 +38,6 @@ Finally, add the Maloja server URL and API Key to the configuration type you cho

 ## Configuration

-<Config config="MalojaClientConfig" fileContent={JsonConfig} client name="maloja">
-        | Environmental Variable | Required? | Default | Description                   |
-        |------------------------|-----------|---------|-------------------------------|
-        | `MALOJA_URL`           | Yes       |         | Base URL of your installation |
-        | `MALOJA_API_KEY`       | Yes       |         | Api Key                       |
+<Config config="MalojaClientConfig" fileContent={JsonConfig} client ambiguous name="maloja">
+<ENVConfig/>
 </Config>
@@ -6,6 +6,7 @@ toc_max_heading_level: 5

 import Bluesky from "@site/src/components/snippets/_bluesky.mdx";
 import JsonConfig from '!!raw-loader!@site/../config/rocksky.json.example';
+import ENVConfig from "@site/docs/configuration/clients/_env_configs/_rocksky.md"

 :::tip[Other Uses]

@@ -13,7 +14,7 @@ To monitor and re-scrobble activity **from** Rocksky create a [Rocksky (Source)]

 :::

-[**Rocksky**](https://rocksky.app/) is music tracking and discovery platform built on the AT Protocol (Bluesky).
+[**Rocksky**](https://rocksky.app/) is music tracking and discovery platform built on the AT Protocol and your your [**Atmosphere Account**](https://atmosphereaccount.com/).

 <details>

@@ -23,13 +24,13 @@ To monitor and re-scrobble activity **from** Rocksky create a [Rocksky (Source)]

 </details>

-<DetailsAdmo type="warning" summary="Your Data Is Public">
+<DetailsAdmo type="important" 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>

-<DetailsAdmo type="warning" summary="No Scrobbling Guarantee">
+<DetailsAdmo type="important" 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.

@@ -41,22 +42,16 @@ If you need your scrobbles to be 100% captured then you should scrobble to an *a

 ## Setup

-You will need a [Bluesky](https://bsky.app/) account to use Rocksky.
+You will need an [**Atmosphere Account**](https://atmosphereaccount.com/) to use Rocksky.

-:::note 
-
-Usage is adapted from [Rocksky docs](https://docs.rocksky.app/migrating-to-rocksky-scrobble-api-957839m0) on [docs.rocksky.app](https://docs.rocksky.app)
-
-:::
-
-* Navigate to [rocksky.app](https://rocksky.app/) and sign up/logn using your Bluesky account
-* Then, navigate to the [RockSky developer dashboard](https://rocksky.app/apikeys) and obtain an API Key
+* Navigate to [rocksky.app](https://rocksky.app/) and sign up/logn using your Atmosphere Account
+* Then, navigate to the [Access Tokens](https://rocksky.app/access-tokens) in the Rocksky settings dropdown, and create a new token

 ## Configuration

 ### Handle

-The handle used with multi-scrobbler should be your **full** ATProto handle, including TLD.
+The handle used with multi-scrobbler should be your **full** [**Atmosphere Account**](https://atmosphereaccount.com/) handle, including TLD.

 * For regular Bluesky account this will be like: `alice.bsky.social`
 * For Bluesky accounts that [use their website as their account](https://bsky.social/about/blog/4-28-2023-domain-handle-tutorial) this is your domain: `mydomain.com`
@@ -64,9 +59,23 @@ 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">
-        | 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                                   |
+<DetailsAdmo type="warning" summary="API Applications Deprecated">
+
+In < 0.14.1, Multi-Scrobber used Rocksky's API Appication "API Key" for communication with a Listenbrainz-compatible API from Rocksky.
+
+Going forward, this should be replaced with the official guidance in the [Setup](#setup) section above: use an **Access Token**. This uses the native Rocksky API which has more functionality.
+
+If your configuration is using either
+
+* (File/AIO) `'key': ...`
+* (ENV) `ROCKSKY_KEY`
+
+you should redo the [Setup](#setup) section and modify your configuration to use an Access Token instead.
+
+Keys are now **deprecated** and functionality for them will be removed in a future version of Multi-Scrobbler. 
+
+</DetailsAdmo>
+
+<Config config="RockSkyClientConfig" fileContent={JsonConfig} client ambiguous name="rocksky">
+<ENVConfig/>
 </Config>
@@ -9,6 +9,7 @@ import TabItem from '@theme/TabItem';
 import CodeBlock from '@theme/CodeBlock';
 import JsonConfig from '!!raw-loader!@site/../config/tealfm.json.example';
 import Bluesky from "@site/src/components/snippets/_bluesky.mdx";
+import ENVConfig from "@site/docs/configuration/clients/_env_configs/_tealfm.md"

 :::tip[Other Uses]

@@ -16,7 +17,7 @@ To monitor and re-scrobble activity from a ATProto Profile create a [teal.fm (So

 :::

-[**teal.fm**](https://teal.fm/) is a social discovery and web viewing service for scrobbles stored/available on the ATProto network/your repository in a [PDS (Personal Data Server)](https://github.com/Bluesky-social/pds).
+[**teal.fm**](https://teal.fm/) is a social discovery and browsing app for scrobbles stored in your [**Atmosphere Account**](https://atmosphereaccount.com/).

 <details>

@@ -46,6 +47,13 @@ To view your teal.fm scrobble data you can:

 ## Setup

+
+:::note
+
+Multi-scrobbler will work with *any* Atmosphere Account, not just Bluesky. See [Configuration](#configuration) below for provider-agnostic config.
+
+:::
+
 #### Bluesky

 * Create a [Bluesky](https://bsky.app) account, if you don't already have one
@@ -57,10 +65,10 @@ To view your teal.fm scrobble data you can:

 ### Identifier

-The ATPRoto identifier used with multi-scrobbler should be either:
+The ATProto identifier used with multi-scrobbler should be either:

 * A valid [DID](https://atproto.com/specs/did#at-protocol-did-identifier-syntax), starting with `did:plc:...` or `did:web:...`
-* Your **full** ATProto handle, including TLD
+* Your **full** [Atmosphere Account](https://atmosphereaccount.com/) ATProto handle, including TLD

 If using a handle:

@@ -70,9 +78,6 @@ 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                                                       |
+<Config config="TealClientConfig" fileContent={JsonConfig} client ambiguous name="tealfm">
+<ENVConfig/>
 </Config>
@@ -13,7 +13,7 @@ import FileExample from "../../src/components/FileExample";
 import ScrobbleThreshold from "@site/src/components/snippets/_scrobble-threshold.mdx"

 import AIOConfig from '!!raw-loader!../../../config/config.json.example';
-import SpotifyConfig from '!!raw-loader!../../../config/spotify.json.example';
+import SingleConfig from '!!raw-loader!../../../config/jellyfin.json.example';

 :::tip

@@ -29,40 +29,35 @@ Check the [**FAQ**](../FAQ.md) if you have any issues after configuration!
 * client/source specific json config files
 * an all-in-one json config file

-**MS will parse configuration from all configuration types.** You can mix and match configurations but it is generally better to stick to one or the other.
+**MS will parse configuration from all configuration types.** You can mix and match configurations but it is generally better to stick to one type.

 <Tabs groupId="configType" queryString>
    <TabItem value="env" label="ENV">
-        MS will parse environmental variables present in the OS/container when it is run. **This method means MS does not require files to run.**
+        MS will parse environmental variables present in the OS/container when it is run.
+        
+        This method means MS **does not require config files** but it will still create and use data files in the [local](/installation/#config-and-data-directories) or [docker](/installation/?dockerSetting=storage#recommended-settings) data directory.

        <details>
          <summary>Use ENV-based configuration if...</summary>

-          * You are the only person for whom MS is scrobbling for
-          * You have a very simple setup for MS such as one scrobble [Client](/configuration/clients) and one [Source](/configuration/sources) IE Plex -> Maloja
+          * You are the only person for whom MS is scrobbling for or
+          * You have a very simple setup for MS such as one scrobble [Client](/configuration/clients) and one [Source](/configuration/sources) IE Jellyfin -> Koito, or
+          * You are not comfortable editing JSON files

        </details>

        <details>
          <summary>Config Example</summary>

-          For Docker container...
-
-          ```shell
-          docker run -e "SPOTIFY_CLIENT_ID=yourId" -e "SPOTIFY_CLIENT_SECRET=yourSecret" ...
-          ```
-
-          For Docker Compose
-
          ```yaml title="docker-compose.yml"
          services:
              multi-scrobbler:
                  image: foxxmd/multi-scrobbler
                  environment:
-                      - SPOTIFY_CLIENT_ID=yourId
-                      - SPOTIFY_CLIENT_SECRET=yourSecret
-                      - MALOJA_URL=http://domain.tld:42010
-                      - MALOJA_API_KEY=1234
+                      - JELLYFIN_URL=192.168.0.110:8096
+                      - JELLYFIN_APIKEY=c9fae8756fbf481ebd9c5bb56b
+                      - JELLYFIN_USER=MyUser
+                      - JELLYFIN_ID=myJellyin
                      # ...
                  # ...
          ```
@@ -77,77 +72,114 @@ Check the [**FAQ**](../FAQ.md) if you have any issues after configuration!
    <TabItem value="file" label="File">
        MS will parse configuration files located in the directory specified by the `CONFIG_DIR` environmental variable. This variable defaults to:

-        * Local installation -> `PROJECT_DIR/config`
-        * Docker -> `/config` (in the container) -- see the [install docs](../installation/installation.mdx#docker) for how to configure this correctly
+        * Local installation -> See [Config and Data Directories](/installation/#config-and-data-directories)
+        * Docker -> `/config` (in the container) -- see the [**Storage** tab in the Docker installation docs](/installation/?dockerSetting=storage#recommended-settings) for how to configure this correctly

        <details>

            <summary>Use File-based configuration if...</summary>

-            * You have many [Sources](/configuration/sources)
-            * You have many of each type of **Source** you want to scrobble from IE 2x Plex accounts, 3x Spotify accounts, 1x
-            Funkwhale...
-            * You have more than one scrobble **Client** you want to scrobble to IE multiple Maloja servers
-            * You want only to scrobble to specific **Clients**
+            * You are comfortable editing JSON files
+            * You have more than one of the same type of **Source/Client** you want to use EX 2x Last.fm accounts, 3x Jellyfin accounts
+            * You want activity from specific **Sources** to scrobble to specific **Clients**
            * You need to setup more advanced configuration for a Source/Client
-              * Most Source/Clients only support basic configuration through ENV, all configuration is possible using File/AIO
+              * Most Source/Clients only support basic configuration through ENV, more configuration is possible using File. AIO enables complete configuration.

        </details>

        :::tip
            * There are **example configurations** for all Source/Client types and AIO config located in the [`/config`](https://github.com/FoxxMD/multi-scrobbler/tree/master/config) directory of this project. These can be used as-is by renaming them to `.json`.
-            * For docker installations these examples are copied to your configuration directory on first-time use.
+              * These are the same examples you will find in the **Configuration** section of each Source/Client
            * There is also a [**kitchensink example**](/configuration/kitchensink) that provides examples of using all sources/clients in a complex configuration.
        :::

-        Each file is named by the **type** of the Client/Source found in below sections. Each file as an **array** of that type of Client/Source.
+        Each config file is named after the **type** of the Client/Source. Within each file, a JSON **array** defines all of the instances for that type of Client/Source.

        Example directory structure:

        ```
        /CONFIG_DIR
-            plex.json
-            spotify.json
-            maloja.json
+            jellyfin.json
+            lastfm.json
+            koito.json
        ```

        <details>
            <summary>Config Example</summary>

-            <CodeBlock title="CONFIG_DIR/spotify.json" language="json5">{SpotifyConfig}</CodeBlock>
+            ```yaml title="jellyfin.json"
+            [
+              {
+                "name": "Foxx JF Server",
+                "id": "foxxJf",
+                "data": {
+                  "url": "http://localhost:8096",
+                  "user": "FoxxMD",
+                  "apiKey": "c9fae8756fbf481ebd9c5bb56bd6540c"
+                }
+              }
+            ]
+            ```

        </details>
+        <details>
+            <summary>Multiple of Same Config Example</summary>
+
+            ```yaml title="jellyfin.json"
+            [
+              {
+                "name": "Foxx JF Server",
+                "id": "foxxJf",
+                "data": {
+                  "url": "http://localhost:8096",
+                  "user": "FoxxMD",
+                  "apiKey": "c9fae8756fbf481ebd9c5bb56bd6540c"
+                }
+              },
+              // highlight-start
+              {
+                "name": "Foo's JF Server",
+                "id": "fooJf",
+                "data": {
+                  "url": "http://192.168.0.150:8096",
+                  "user": "foo",
+                  "apiKey": "9c5bb56bd6540c756fbf481ebd9c5c40"
+                }
+              }
+              // highlight-end
+            ]
+            ```
+
+        </details>
+
+        You can find an example of the file name that should be used under the **File** Configuration for each Source/Client. Note: this is the same value that is used for `type` in AIO configs.
    </TabItem>
    <TabItem value="aio" label="File AIO">
-        MS will parse an **all-in-one** configuration file located in the directory specified by the `CONFIG_DIR` environmental variable. This variable defaults to:
+        MS will parse an **all-in-one** configuration file (`config.json`) located in the directory specified by the `CONFIG_DIR` environmental variable. The file's location defaults to:

-        * Local installation -> `PROJECT_DIR/config/config.json`
-        * Docker -> `/config/config.json` (in the container) -- see the [install docs](../installation/installation.mdx#docker) for how to configure this correctly
+        * Local installation -> See [Config and Data Directories](/installation/#config-and-data-directories)
+        * Docker -> `/config/config.json` (in the container) -- see the [**Storage** tab in the Docker installation docs](/installation/?dockerSetting=storage#recommended-settings) for how to configure this correctly

        <details>

            <summary>Use AIO-based configuration if...</summary>

-            * You have many [Sources](/configuration/sources)
-            * You have many of each type of **Source** you want to scrobble from IE 2x Plex accounts, 3x Spotify accounts, 1x
-            Funkwhale...
-            * You have more than one scrobble **Client** you want to scrobble to IE multiple Maloja servers
-            * You want only to scrobble to specific **Clients**
-            * You need to setup [monitoring/webhooks](#monitoring)
-            * You want to setup defaults for all Sources/Clients
+            * ...All of the reasons listed in [File](./?configType=file#configuration-types)
+            * You want to setup [monitoring/webhooks](#monitoring), default settings for all Sources/Clients, or global config options
+            * You want to use [Transformers](/configuration/transforms) (other than what is provided for [Musicbrainz ENV](/configuration/transforms/musicbrainz/#env-configuration))
+            * You want complete control over all potential MS configuration

        </details>

-        **The AIO config also enables setting default options for sources/clients as well as global options for MS itself.**
-
        :::tip
-            * An example AIO config files can be found in the project directory at [`/config/config.json.example`](https://github.com/FoxxMD/multi-scrobbler/tree/master/config/config.json.example)
-            * For docker installations this example is copied to your configuration directory on first-time use.
-            * There is also a [**kitchensink example**](/configuration/kitchensink) that provides examples of using all sources/clients in a complex configuration.
+            * **AIO config is the "complete" way to configure MS.**
+              * All settings available in File/ENV are available in AIO and AIO has *more* exclusive settings.
+              * AIO enables configuring **default settings** for all Sources/Clients
+            * There is a [**kitchensink example**](/configuration/kitchensink) that provides examples of using all sources/clients in a complex configuration.
+            * Use the [**Config Playground**](/playground) to explore the entire config schema with an editable example
+              * The example used can also be found in the repo directory at [`/config/config.json.example`](https://github.com/FoxxMD/multi-scrobbler/tree/master/config/config.json.example) in the example below
        :::

-        [**Explore the schema for this configuration, along with an example generator and validator, here**](https://json-schema.app/view/%23?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fmaster%2Fsrc%2Fbackend%2Fcommon%2Fschema%2Faio.json)
-
        <details>

            <summary>Config Example</summary>
@@ -155,6 +187,32 @@ Check the [**FAQ**](../FAQ.md) if you have any issues after configuration!
            <CodeBlock title="CONFIG_DIR/config.json" language="json5">{AIOConfig}</CodeBlock>

        </details>
+
+        <DetailsAdmo type="important" summary="Source/Client AIO Configs require a 'type' property">
+
+        Compared to their [File](./?configType=file#configuration-types) equivalent, Sources/Clients configured using AIO require an additional `type` property.
+
+        ```yaml title="config.json"
+        {
+          "sources": [
+            {
+              "name": "Foxx JF Server",
+              // highlight-start
+              "type: "jellyfin",
+              // highlight-end
+              "id": "foxxJf",
+              "data": {
+                "url": "http://localhost:8096",
+                "user": "FoxxMD",
+                "apiKey": "c9fae8756fbf481ebd9c5bb56bd6540c"
+              }
+            }
+          ]
+        }
+        ```
+
+        You can find an example of the required `type` value by referring to the **AIO** tab in each Source/Client's Configuration section example. This is the same value that is used as the name of individual [File](./?configType=file#configuration-types) config files.
+        </DetailsAdmo>
    </TabItem>
 </Tabs>

@@ -245,13 +303,10 @@ WARN : [App] [Sources] [spotify Secrets] Matched: None | Unmatched: SPOTIFY_SECR

 </DetailsAdmo>

-## Application Options

-These options affect multi-scrobbler's behavior and are not specific to any source/client.
+## Base URL

-### Base URL
-
-Defines the URL that is used to generate default redirect URLs for authentication on [spotify](/configuration/sources/spotify) and [lastfm](/configuration/clients/lastfm) -- as well as some logging hints.
+Defines the URL that is used to generate default redirect URLs for authentication for services like [spotify](/configuration/sources/spotify) and [lastfm](/configuration/clients/lastfm) -- as well as some logging hints.

 * Default => `http://localhost:9078`
 * Set with [ENV](./?configType=env#configuration-types) `BASE_URL` or `baseUrl` [all-in-one configuration](./?configType=aio#configuration-types)
@@ -280,79 +335,51 @@ Useful when running with [docker](../installation/installation.mdx#docker) so th

 </details>

-### Caching
+## Caching

-Multi-scrobbler caches some activities to persist important data across restarts, reduce external API calls, and make some actions faster.
+Multi-scrobbler implements caching to reduce external API calls and make some actions faster.

-All of the activities below are **always** cached **in-memory** with an optional, configurable [**secondary** store](#secondary-caching-configuration) for persistence.
+A default **in-memory** cache store is used so that you always benefit from some caching. An optional, [**secondary** store](#secondary-caching) can be configured for greater caching capabilities.

-<Tabs groupId="cachedThings" queryString>
-<TabItem value="scrobbles" label="Scrobbles">
-
-**Queued** and **Failed** Scrobbles are cached so that any un-scrobbled data you have is persisted across restarts of multi-scrobbler.
-
-:::tip
-
-By default, this data use a [Secondary](#secondary-caching-configuration) [File](./?cacheType=file#secondary-caching-configuration) store, configured for you automatically.
-
-If you have configured a [persisted volume/bind mount](/installation?dockerSetting=storage#recommended-settings) for configuration (`/config` is mounted in [docker compose](/quickstart#create-docker-compose-file)) then you are already done. If you are not persisting this directory then you should consider setting up [Valkey Cache](./?cacheType=valkey#secondary-caching-configuration) for this.
-
-:::
-
-##### Configuration
-
-Use any [Secondary Cache](#secondary-caching-configuration), the config examples below show the default values:
-
-<Tabs>
-<TabItem value="env" label="ENV">
-
-| Environmental Variable | Required? | Default   | Description           |
-| :--------------------- | --------- | --------- | --------------------- |
-| `CACHE_SCROBBLE`       | No        | `file`    | The cache type to use |
-| `CACHE_SCROBBLE_CONN`  | No        | `/config` |                       |
+<DetailsAdmo type="note" summary="What is Cached?">

+<Tabs groupId="cachedThings">
+<TabItem value="auth" label="Auth Data">
+Authentication sessions/tokens/etc... are cached for quicker requests and for persistence across restarts.
 </TabItem>
-
-<TabItem value="aio" label="AIO">
-
-```json5 title="config.json"
-{
-    "cache": {
-        "scrobble": {
-            "provider": "file",
-            "connection": "/config"
-        }
-    },
-    // ...
-}
-```
+<TabItem value="transform" label="Scrobble Transforms">
+The results of [transform rules](/configuration/transforms) are cached so that if a scrobble with identical data (track/artists/album) is identified and it has the same set of transform rules then the cached transform results can be applied.
+</TabItem>
+<TabItem value="metadata" label="Transform API Calls">
+API Calls to external (metadata) services used to [Enhance Scrobbles](/configuration/transforms), like calls to [Musicbrainz](/configuration/transforms/musicbrainz), can be cached to avoid duplicate calls and speed up scrobble transformations.
 </TabItem>
 </Tabs>

-</TabItem>
-<TabItem value="auth" label="Auth Data">
+</DetailsAdmo>

-Authentication sessions/tokens/etc... are cached for quicker requests and for persistence across restarts.
+<DetailsAdmo type="important" summary="Auth Cache Configuration">

-:::tip
+Auth caching defaults to a **file** that is stored in the `DATA_DIR` directory using the pre-defined file name `ms-auth.cache`.

-By default, this data use a [Secondary](#secondary-caching-configuration) [File](./?cacheType=file#secondary-caching-configuration) store, configured for you automatically.
+This provides automatic persistence across restarts for long-lived auth data/credentials if you have configured a [persisted volume/bind mount](/installation?dockerSetting=storage#recommended-settings) for configuration (`/config` is mounted in [docker compose](/quickstart#create-docker-compose-file)).

-If you have configured a [persisted volume/bind mount](/installation?dockerSetting=storage#recommended-settings) for configuration (`/config` is mounted in [docker compose](/quickstart#create-docker-compose-file)) then you are already done. If you are not persisting this directory then you should consider setting up [Valkey Cache](./?cacheType=valkey#secondary-caching-configuration) for this.
+If you wish to use the [secondary store](#secondary-caching) for caching Auth you must explicitly configure it. This is because valkey can potentially be *ephemeral* if you do not provide a volume for its data directory.

-:::
+To explicitly configure auth to use the secondary store:

-##### Configuration
-
-Use any [Secondary Cache](#secondary-caching-configuration), the config examples below show the default values:
-
-<Tabs>
+<Tabs groupId="configType" queryString>
 <TabItem value="env" label="ENV">

-| Environmental Variable | Required? | Default   | Description           |
-| :--------------------- | --------- | --------- | --------------------- |
-| `CACHE_AUTH`           | No        | `file`    | The cache type to use |
-| `CACHE_AUTH_CONN`      | No        | `/config` |                       |
+```yaml title="compose.yaml"
+services:
+  multi-scrobbler:
+  # ...
+  environment:
+  // highlight-start
+    - CACHE_AUTH=valkey
+  // highlight-end
+    # ...
+```

 </TabItem>

@@ -362,8 +389,7 @@ Use any [Secondary Cache](#secondary-caching-configuration), the config examples
 {
    "cache": {
        "auth": {
-            "provider": "file",
-            "connection": "/config"
+            "provider": "valkey"
        }
    },
    // ...
@@ -372,93 +398,19 @@ Use any [Secondary Cache](#secondary-caching-configuration), the config examples
 </TabItem>
 </Tabs>

-</TabItem>
-<TabItem value="metadata" label="Transform API Calls">
+</DetailsAdmo>

-API Calls to external (metadata) services used to [Enhance Scrobbles](/configuration/transforms), like calls to [Musicbrainz](/configuration/transforms/musicbrainz), can be cached to avoid duplicate calls and speed up scrobble transformations.
+### Secondary Caching Store {#secondary-caching}

-By default, these calls are only cached in memory. If you wish for cached calls to be persisted across restarts then setup [Valkey Cache](./?cacheType=valkey#secondary-caching-configuration).
+Using a secondary store enables:

-##### Configuration
+* persistence of cached data across restarts
+* a larger store (more data is saved)
+* a longer time-to-live in the store (cached data is fetchable for a longer period)

-Use any [Secondary Cache](#secondary-caching-configuration), the config examples below show the default values:
+These benefits are particularly beneficial when using [transforms](/configuration/transforms) like Musicbrainz and it is **strongly recommended** for these scenarios.

-<Tabs>
-<TabItem value="env" label="ENV">
-
-| Environmental Variable | Required? | Default | Description           |
-| :--------------------- | --------- | ------- | --------------------- |
-| `CACHE_METADATA`       | No        |         | The cache type to use |
-| `CACHE_METADATA_CONN`  | No        |         |                       |
-
-</TabItem>
-
-<TabItem value="aio" label="AIO">
-
-```json5 title="config.json"
-{
-    "cache": {
-        "metadata": {
-            "provider": "valkey",
-            "connection": "yourConnectionStringHere"
-        }
-    },
-    // ...
-}
-```
-</TabItem>
-</Tabs>
-
-</TabItem>
-</Tabs>
-
-#### Secondary Caching Configuration
-
-The type of cache used, and its connection properties, can be configured through **ENV** or **AIO** config.
-
-<Tabs groupId="cacheType" queryString>
-
-<TabItem value="file" label="File">
-
-**File** cache is stored in the `CONFIG_DIR` directory using the pre-defined file name `ms-[cacheName].cache`.
-
-<Tabs groupId="configType" queryString>
-
-<TabItem value="env" label="ENV">
-
-Example
-
-| Environmental Variable | Required? | Default   | Description                                                  |
-| :--------------------- | --------- | --------- | ------------------------------------------------------------ |
-| `CACHE_SCROBBLE`       | No        | `file`    | The cache type to use                                        |
-| `CACHE_SCROBBLE_CONN`  | No        | `/config` | The directory, within the container, to store the cache file |
-
-</TabItem>
-
-<TabItem value="aio" label="AIO">
-
-Example
-
-```json5 title="config.json"
-{
-    "cache": {
-        "scrobble": {
-            "provider": "file",
-            "connection": "/config"
-        }
-    },
-    // ...
-}
-```
-
-</TabItem>
-
-</Tabs>
-</TabItem>
-
-<TabItem value="valkey" label="Valkey">
-
-[**Valkey**](https://valkey.io/) is an open-source fork of Redis.
+Currently, Multi-scrobbler only supports [**Valkey**](https://valkey.io/), an open-source fork of Redis, as a secondary store.

 <details>

@@ -466,11 +418,13 @@ Example

 A valkey container can be added to the [multi-scrobbler docker compose stack](/installation?runType=docker-compose#docker):

+<Tabs>
+<TabItem value="named" label="Named Volume">
+
 ```yaml title="docker-compose.yml"
 services:
  multi-scrobbler:
  # ...
-  # adding everything below
  // highlight-start
  valkey:
    image: valkey/valkey
@@ -483,6 +437,25 @@ volumes:
  // highlight-end
 ```

+</TabItem>
+<TabItem value="bind" label="Bind Mount">
+
+```yaml title="docker-compose.yml"
+services:
+  multi-scrobbler:
+  # ...
+  // highlight-start
+  valkey:
+    image: valkey/valkey
+    volumes:
+      - ./valkeyData:/data
+  // highlight-end
+```
+
+</TabItem>
+
+</Tabs>
+
 Use `redis://valkey:6379` as the connection string in the configurations below.

 </details>
@@ -497,12 +470,16 @@ redis://HOST_IP:HOST_PORT

 <TabItem value="env" label="ENV">

-Example
-
-| Environmental Variable | Required? | Default  | Description                                                         |
-| :--------------------- | --------- | -------- | ------------------------------------------------------------------- |
-| `CACHE_METADATA`       | Yes       | `valkey` | The cache type to use                                               |
-| `CACHE_METADATA_CONN`  | Yes       |          | The host/IP and port to connect to EX: `redis://192.168.0.120:6379` |
+```yaml title="compose.yaml"
+services:
+  multi-scrobbler:
+  # ...
+  environment:
+  // highlight-start
+    - CACHE_VALKEY=redis://192.168.0.120:6379
+  // highlight-end
+    # ...
+```

 </TabItem>

@@ -513,10 +490,7 @@ Example
 ```json5 title="config.json"
 {
    "cache": {
-        "metadata": {
-            "provider": "valkey",
-            "connection": "redis://192.168.0.120:6379"
-        }
+        "valkey": "redis://192.168.0.120:6379"
    },
    // ...
 }
@@ -525,11 +499,275 @@ Example
 </TabItem>

 </Tabs>
+
+## Database
+
+Multi-scrobbler depends on a SQLite database (`ms.db`) that is created on first run and stored in the [`CONFIG_DIR`](/installation/?dockerSetting=storage#recommended-settings). When upgrading Multi-scrobbler version, if there are any required database changes than this database is [automatically backed up and migrated.](/updating#database)
+
+The database stores *all* Plays for your Sources/Clients as well as metadata and debugging information to help troubleshoot issues. Each Play is associated with a Source/Config in the database based on your configuration.
+
+You **must set IDs for each Source/Client** so that the database can identify these even when the configuration is changed.
+
+### Retention
+
+<DetailsAdmo status="note" summary="How much storage does the database use?">
+
+The amount of data stored for each Play can widely vary based on a few factors:
+
+* how much data the Source service exposes
+* how many clients each Source is scrobble to (Plays are duplicated for each Client a Source sends a scrobble to)
+* if you are using any [Transforms](/configuration/transforms) the diff of each step is stored, along with any external request/response data (like [Musicbrainz queries](/configuration/transforms/musicbrainz))
+
+The [MS repository contains a benchmark](https://github.com/FoxxMD/multi-scrobbler/blob/master/src/backend/tests/database/drizzle.test.ts#L551) to measure an average database size in a few common scenarios.
+
+<Tabs groupId="dbSize">
+
+<TabItem label="Minimal" value="minimal">
+
+Assuming your Sources send a minimal amount of data or you have compacted all plays:
+
+| Play Count | DB Size  |
+| ---------- | -------- |
+| 100        | `160kb`  |
+| 1000       | `1MB`    |
+| 10k        | `10.2MB` |
+
+</TabItem>
+
+<TabItem label="With Original Input" value="input">
+
+Assuming your Sources have a non-trivial amount of input data (like Spotify or Listenbrainz) that is not compacted:
+
+| Play Count | DB Size  |
+| ---------- | -------- |
+| 100        | `356kb`  |
+| 1000       | `3MB`    |
+| 10k        | `29.6MB` |
+
+</TabItem>
+
+<TabItem label="All Debug Deta" value="all">
+
+Assuming your Sources/Clients:
+
+* have a non-trivial amount of input data (like Spotify or Listenbrainz)
+* and has many [Transforms](/configuration/transforms) steps that include requests
+* nothing is compacted
+
+| Play Count | DB Size  |
+| ---------- | -------- |
+| 100        | `684kb`  |
+| 1000       | `6.28MB` |
+| 10k        | `61.3MB` |
+
 </TabItem>

 </Tabs>

-### Debug Mode
+</DetailsAdmo>
+
+A retention policy can be configured to delete Plays, or unused debug data, from the database after a certain amount of time. If no configuration is provided then a default policy is used that should be reasonable for most users.
+
+<Tabs groupId="policy" queryString>
+
+<TabItem label="Compaction" value="compaction">
+
+The **Compaction** Retention Policy is used to delete different types of debug data from your stored Plays.
+
+This is a useful way to reduce used storage space when you are not having problems with your Plays, or iterating on a configuration, that requires referencing all this extra data.
+
+There are two types of data that can be compacted (deleted from the Play):
+
+* `input` - this is the untouched data retrieved by Multi-scrobbler, from a Source, and used to generate a Play/scrobble. This can be used to reconstruct and replay a Play, when used from troubleshooting or reporting an issue
+* `transform` - this is all of the steps generated by [transforms](/configuration/transforms), the diff of the Play resulting from the step, and any request/responses used to complete the step
+
+:::note[Defaults]
+
+When no Compact configuration is provided, Multi-scrobbler uses this policy:
+
+* Compact (delete) `input` and `transform` data on all Plays after 3 days
+
+:::
+
+#### Configuring Compaction Policy
+
+<details>
+
+<summary>Details</summary>
+
+Each value in the configuration properties below can be either
+
+* a number of seconds EX `3600` = 10 minutes
+* a unit of a common duration with the pattern `X unit` EX
+  * `30 minutes`
+  * `5 hours`
+  * `2 days`
+
+<Tabs groupId="configType" queryString>
+
+<TabItem value="env" label="ENV">
+
+* `COMPACT_PROPERTIES` - which properties to compact
+* `RETENTION_COMPACT_AFTER` - Default to use for all Plays
+* `RETENTION_COMPACT_COMPLETED_AFTER` - Compact only completed Plays after...
+* `RETENTION_COMPACT_FAILED_AFTER` - Compact only failed Plays after...
+* `RETENTION_COMPACT_DUPED_AFTER` - Compact only duped/discard Plays after...
+
+Example
+
+```ini
+# only delete input when compacting
+COMPACT_PROPERTIES=input
+# compact all plays after 3 days 
+RETENTION_COMPACT_AFTER=3 days
+# specifically compact completed plays after 30 minutes
+RETENTION_COMPACT_COMPLETED_AFTER=30 minutes
+```
+
+</TabItem>
+<TabItem value="aio" label="AIO">
+
+Compacting all Play types and deleting both input and transform: 
+
+```json title="config.json"
+{
+  "database": {
+    "retention": {
+      "compactAfter": "3 days",
+      "compact": [
+        "input",
+        "transform"
+      ]
+    }
+  }
+}
+```
+
+* Delete only input during compacting
+* Compact all after 3 days except completed which compacts after 30 minutes
+
+```json title="config.json"
+{
+  "database": {
+    "retention": {
+      "compactAfter": {
+        "completed": "30 minutes",
+        "duped": "3 days",
+        "failed": "3 days"
+      },
+      "compact": [
+        "input"
+      ]
+    }
+  }
+}
+```
+
+</TabItem>
+</Tabs>
+
+</details>
+
+</TabItem>
+
+<TabItem label="Deletion" value="deletion">
+
+The **Deletion** Retention Policy is used to delete different types of stored Plays from Multi-scrobbler database.
+
+**This does not delete Plays from your Clients.** It's only deleting the "in-flight" data MS used to create the scrobble that was eventually sent to your clients.
+
+:::warning[Plays Should be Ephemeral]
+
+**Multi-Scrobbler is not designed to store Plays/Scrobbles indefinitely.**
+
+It should scale fine for thousands of scrobbles but it not meant to store 10's of thousands of scrobbles forever. It is not a scrobbler server.
+
+You **should** set a reasonable deletion policy so that MS stores less than 1000 scrobbles at a time, ideally less.
+
+:::
+
+:::note[Defaults]
+
+When no Deletion policy configuration is provided, Multi-scrobbler uses this policy:
+
+* Delete all Plays after 7 days
+
+:::
+
+#### Configuring Deletion Policy
+
+<details>
+
+<summary>Details</summary>
+
+Each value in the configuration properties below can be either
+
+* a number of seconds EX `3600` = 10 minutes
+* a unit of a common duration with the pattern `X unit` EX
+  * `30 minutes`
+  * `5 hours`
+  * `2 days`
+
+<Tabs groupId="configType" queryString>
+
+<TabItem value="env" label="ENV">
+
+* `RETENTION_DELETE_AFTER` - Default to use for all Plays
+* `RETENTION_DELETE_COMPLETED_AFTER` - Delete only completed Plays after...
+* `RETENTION_DELETE_FAILED_AFTER` - Delete only failed Plays after...
+* `RETENTION_DELETE_DUPED_AFTER` - Delete only duped/discard Plays after...
+
+Example
+
+```ini
+# delete all plays after 3 days 
+RETENTION_DELETE_AFTER=3 days
+# specifically, delete completed plays after 30 minutes
+RETENTIOND_DELETE_COMPLETED_AFTER=30 minutes
+```
+
+</TabItem>
+<TabItem value="aio" label="AIO">
+
+Deleting all Play types after 3 days: 
+
+```json title="config.json"
+{
+  "database": {
+    "retention": {
+      "deleteAfter": "3 days"
+    }
+  }
+}
+```
+
+* Delete all after 3 days except completed which are deleted after 30 minutes
+
+```json title="config.json"
+{
+  "database": {
+    "retention": {
+      "deleteAfter": {
+        "completed": "30 minutes",
+        "duped": "3 days",
+        "failed": "3 days"
+      },
+    }
+  }
+}
+```
+
+</TabItem>
+</Tabs>
+
+</details>
+
+</TabItem>
+
+
+</Tabs>
+
+## Debug Mode

 Turning on Debug Mode will

@@ -550,7 +788,7 @@ To set debug mode either add it to [AIO `config.json`](./?configType=aio#configu

 or set the [ENV](./?configType=env#configuration-types) `DEBUG_MODE=true`

-### Disable Web
+## Disable Web

 If you do not need the dashboard and/or ingress sources, or have security concerns about ingress and cannot control your hosting environment, the web server and API can be disabled.

@@ -630,7 +868,7 @@ Webhooks are configured in the AIO [config.json](#configuration-types) file unde

 #### [Gotify](https://gotify.net/)

-Refer to the [config schema for GotifyConfig](https://json-schema.app/view/%23/%23%2Fdefinitions%2FGotifyConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fmaster%2Fsrc%2Fbackend%2Fcommon%2Fschema%2Faio.json)
+Refer to the [config schema for GotifyConfig](/playground)

 multi-scrobbler optionally supports setting message notification priority via `info` `warn` and `error` mappings.

@@ -656,7 +894,7 @@ multi-scrobbler optionally supports setting message notification priority via `i

 #### [Ntfy](https://ntfy.sh/)

-Refer to the [config schema for NtfyConfig](https://json-schema.app/view/%23/%23%2Fdefinitions%2FNtfyConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fmaster%2Fsrc%2Fbackend%2Fcommon%2Fschema%2Faio.json)
+Refer to the [config schema for NtfyConfig](/playground)

 multi-scrobbler optionally supports setting message notification priority via `info` `warn` and `error` mappings.

@@ -684,7 +922,7 @@ multi-scrobbler optionally supports setting message notification priority via `i

 #### [Apprise](https://github.com/caronc/apprise-api)

-Refer to the [config schema for AppriseConfig](https://json-schema.app/view/%23/%23%2Fdefinitions%2FAppriseConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fmaster%2Fsrc%2Fbackend%2Fcommon%2Fschema%2Faio.json)
+Refer to the [config schema for AppriseConfig](/playground)

 multi-scrobbler supports [stateless](https://github.com/caronc/apprise-api?tab=readme-ov-file#stateless-solution) and [persistent storage](https://github.com/caronc/apprise-api?tab=readme-ov-file#persistent-storage-solution) endpoints as well as [tags](https://github.com/caronc/apprise-api?tab=readme-ov-file#tagging)/

@@ -1,317 +1,93 @@
 ---
 sidebar_position: 5
 title: Kitchen Sink
-description: Kitchen Sink Example
+description: Kitchen Sink Examples
 ---

-# Example Complex Scenario
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import MultiUsecase from "@site/src/components/snippets/_scenario-config-multi.mdx"
+import MultiPersonsServices from "@site/docs/configuration/_kitchensink_configs/_multi-persons-services.mdx"
+import MultiSourcesClients from "@site/docs/configuration/_kitchensink_configs/_multi-sources-clients.mdx"
+import Musicbrainz from "@site/docs/configuration/_kitchensink_configs/_musicbrainz.mdx"
+import SingleUsecase from "@site/src/components/snippets/_scenario-config-single.mdx"

-Scenario: 
+## What's This?

-* You want to scrobble plays for yourself (Foxx), Fred, and Mary
-* 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/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](/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)
+On this page you find contrived, complex usecases for multi-scrobbler that provide examples of equivalent [configuration types](/configuration#configuration-types) to fulfill that usecase.

-### All-in-one Config
+These example are useful for:

-```json5 title="CONFIG_DIR/config.json"
-{
-  "sourceDefaults": {
-    "maxPollRetries": 0,          // optional, default # of automatic polling restarts on error. can be overridden by property in individual config
-    "maxRequestRetries": 1,       // optional, default # of http request retries a source can make before error is thrown. can be overridden by property in individual config
-    "retryMultiplier": 1.5,       // optional, default retry delay multiplier (retry attempt * multiplier = # of seconds to wait before retrying). can be overridden by property in individual config
-  },
-  "clientDefaults": {
-    "maxRequestRetries": 1,       // optional, default # of http request retries a client can make before error is thrown. can be overridden by property in individual config
-    "retryMultiplier": 1.5,       // optional, default retry delay multiplier (retry attempt * multiplier = # of seconds to wait before retrying). can be overridden by property in individual config
-  },
-  "sources": [
-    {
-      "type": "spotify",
-      "name": "foxxSpot",
-      "clients": ["foxxMaloja"],
-      "data": {
-        "clientId": "foxxSpotifyAppId", 
-        "clientSecret": "foxxSpotifyAppSecret",
-      },
-      "options": {
-        "maxRequestRetries": 2,  // override default max retries because spotify can...spotty
-      }
-    },
-    {
-      "type": "spotify",
-      "name": "marySpot",
-      "clients": ["maryMaloja"],
-      "data": {
-        "clientId": "foxxSpotifyAppId", // only need one application, it can be used by all users of this multi-scrobbler instance 
-        "clientSecret": "foxxSpotifyAppSecret",
-      }
-    },
-    {
-      "type": "spotify",
-      "name": "fredSpot",
-      "clients": ["fredMaloja"],
-      "data": {
-        "accessToken": "fredsToken",
-        "refreshToken": "fredsRefreshToken",
-        "interval": 120, // he also wants a slower check interval because his application already has heavy api usage
-      }
-    },
-    {
-      "type": "plex",
-      "name": "fredPlex",
-      "clients": ["fredMaloja"],
-      "data": {
-        "token": "JtRnwQWD__XMJF8sT3jc",
-        "url": "192.168.0.233:32400",
-        "usersallow": ["fredUser"]
-      }
-    },
-    {
-      "type": "plex",
-      "name": "maryPlex",
-      "clients": ["maryMaloja"],
-      "data": {
-        "token": "JtRnwQWD__XMJF8sT3jc",
-        "url": "192.168.0.233:32400",
-        "usersallow": ["maryUser"], // still need to specify mary as user so not all users who play from 'podcasts' get scrobbled
-        "librariesAllow": ["podcasts"]
-      }
-    },
-    {
-      "type": "plex",
-      "name": "partyPlex",
-      // omitting clients (or making it empty) will make this Source scrobble to all Clients
-      "data": {
-        "token": "JtRnwQWD__XMJF8sT3jc",
-        "url": "192.168.0.233:32400",
-        "librariesAllow": ["party"]
-      }
-    },
-    {
-      "type": "jellyfin",
-      "name": "FredJelly",
-      // omitting clients (or making it empty) will make this Source scrobble to all Clients
-      "data": {
-        "url": "http://localhost:8096",
-        "user": "FoxxMD",
-        "apiKey": "c9fae8756fbf481ebd9c5bb56bd6540c",
-        "usersAllow": ["fredUser"]
-      }
-    },
-    {
-      "type": "subsonic",
-      "name": "foxxAirsonic",
-      "clients": ["foxxMaloja"],
-      "data": {
-        "user": "foxx",
-        "password": "foxxPassword",
-        "url": "https://airsonic.foxx.example"
-      }
-    },
-    {
-      "type": "ytmusic",
-      "name": "foxxYoutube",
-      "clients": ["foxxMaloja"],
-      "data": {
-        "cookie": "__Secure-3PAPISID=3AxsXpy0MKGu75Qb/AkISXGqOnSDn1jEKn; DEVICE_INFO=ChxOekU0Tmpjek5EWTBPRGd3TlRBMk16QXpNdz09EJbS8Z0GGJbS8Z0G; ...",
-      }
-    },
-    {
-      "type": "endpointlz",
-      "name": "listenbrainzfoxx",
-      "clients": ["foxxMaloja"],
-      "data": {
-        "token": "myToken"
-      }
-    }
-  ],
-  "clients": [
-    {
-      "type": "maloja",
-      "name": "foxxMaloja",
-      "data": {
-        "url": "https://maloja.foxx.example",
-        "apiKey": "foxxApiKey"
-      }
-    },
-    {
-      "type": "maloja",
-      "name": "fredMaloja",
-      "data": {
-        "url": "https://maloja.fred.example",
-        "apiKey": "fredApiKey"
-      }
-    },
-    {
-      "type": "maloja",
-      "name": "maryMaloja",
-      "data": {
-        "url": "https://maloja.mary.example",
-        "apiKey": "maryApiKey"
-      }
-    },
-    {
-      "type": "lastfm",
-      "name": "maryLFM",
-      "data": {
-        "apiKey": "maryApiKey",
-        "secret": "marySecret",
-        "redirectUri": "http://localhost:9078/lastfm/callback"
-      }
-    }
-  ]
-}
+* getting an idea of what you can do with Multi-scrobbler
+* using these examples as a starting point for your own configuration
+* providing an example of the same configuration across different [configuration types](/configuration#configuration-types)

-```
+:::tip

-### Separate JSON files
+More common, straightforward scenarios can be found in the [**quickstart**](/quickstart) guide.

-```json5 title="CONFIG_DIR/spotify.json"
-[
-  {
-    // may omit 'type' property since app knows this is file is for spotify configs
-    "name": "foxxSpot",
-    "clients": ["foxxMaloja"],
-    "data": {
-      "clientId": "foxxSpotifyAppId",
-      "clientSecret": "foxxSpotifyAppSecret"
-    }
-  },
-  {
-    "name": "marySpot",
-    "clients": ["maryMaloja"],
-    "data": {
-      "clientId": "foxxSpotifyAppId",
-      "clientSecret": "foxxSpotifyAppSecret"
-    }
-  },
-  {
-    "name": "fredSpot",
-    "clients": ["fredMaloja"],
-    "data": {
-      "accessToken": "fredsToken",
-      "refreshToken": "fredsRefreshToken",
-      "interval": 120
-    }
-  },
-]
-```
+:::

-```json5 title="CONFIG_DIR/plex.json"
-[
-  {
-    "name": "fredPlex",
-    "clients": ["fredMaloja"],
-    "data": {
-      "token": "JtRnwQWD__XMJF8sT3jc",
-      "url": "192.168.0.233:32400",
-      "usersallow": ["fredUser"]
-    }
-  },
-  {
-    "name": "maryPlex",
-    "clients": ["maryMaloja"],
-    "data": {
-      "token": "JtRnwQWD__XMJF8sT3jc",
-      "url": "192.168.0.233:32400",
-      "usersallow": ["maryUser"],
-      "librariesAllow": ["podcasts"]
-    }
-  },
-  {
-    "name": "partyPlex",
-    "data": {
-      "token": "JtRnwQWD__XMJF8sT3jc",
-      "url": "192.168.0.233:32400",
-      "librariesAllow": ["party"]
-    }
-  }
-]
-```
+## Examples

-```json5 title="CONFIG_DIR/jellyfin.json"
-[
-  {
-    "name": "FredJelly",
-    "data": {
-      "url": "http://localhost:8096",
-      "user": "FoxxMD",
-      "apiKey": "c9fae8756fbf481ebd9c5bb56bd6540c",
-      "usersAllow": ["fredUser"]
-    }
-  }
-]
-```
+### Multiple Sources to Multiple Clients {#multi-sources-clients}

-```json5 title="CONFIG_DIR/ytmusic.json"
-[
-  {
-    "name": "foxxYoutube",
-    "clients": ["foxxMaloja"],
-    "data": {
-      "cookie": "__Secure-3PAPISID=3AxsXpy0MKGu75Qb/AkISXGqOnSDn1jEKn; DEVICE_INFO=ChxOekU0Tmpjek5EWTBPRGd3TlRBMk16QXpNdz09EJbS8Z0GGJbS8Z0G; ...",
-    }
-  }
-]
-```
-```json5 title="CONFIG_DIR/endpointlz.json"
-[
-  {
-    "name": "listenbrainzfoxx",
-    "clients": ["foxxMaloja"],
-    "data": {
-      "token": "myToken",
-    }
-  }
-]
-```
+You are the only user of Multi-scrobbler. You have many Sources you listen to and want to scrobble them to multiple services.

-```json5 title="CONFIG_DIR/maloja.json"
-[
-  {
-    "name": "foxxMaloja",
-    "data": {
-      "url": "https://maloja.foxx.example",
-      "apiKey": "foxxApiKey"
-    }
-  },
-  {
-    "name": "fredMaloja",
-    "data": {
-      "url": "https://maloja.fred.example",
-      "apiKey": "fredApiKey"
-    }
-  },
-  {
-    "name": "maryMaloja",
-    "data": {
-      "url": "https://maloja.mary.example",
-      "apiKey": "maryApiKey"
-    }
-  }
-]
-```
+* You want to **scrobble from...**
+  * A [Spotify](/configuration/sources/spotify) account
+  * A Navidrome instance that you want to use with the built-in [listenbrainz](/configuration/sources/listenbrainz-endpoint) scrobble function
+  * A shared [Plex](/configuration/sources/plex) instance that you want to scrobble only from a specific library named `oldies`
+* You want to **scrobble to...**
+  * Your decades-old [Last.fm](/configuration/clients/lastfm) account
+  * A [Koito](/configuration/clients/koito) server for backup

-```json5 title="CONFIG_DIR/lastfm.json"
-[
-  {
-    "name": "maryLFM",
-    "data": {
-      "apiKey": "maryApiKey",
-      "secret": "marySecret",
-      "redirectUri": "http://localhost:9078/lastfm/callback"
-    }
-  }
-]
-```
+<details>

+<summary>Configuration</summary>
+
+<MultiSourcesClients/>
+
+</details>
+
+### Scrobble for Multiple People to Multiple Clients {#multi-persons-services}
+
+<MultiUsecase/>
+
+You want to scrobble plays for yourself (Foxx), Fred, and Mary:
+
+* The three of you want to **scrobble from...**
+  * Fred and Mary each have their own [Jellyfin servers](/configuration/sources/jellyfin)
+  * You have a [Plex](/configuration/sources/plex) server
+* The three of you want to **scrobble to...**
+  * Fred and Mary each have their own [Last.fm](/configuration/clients/lastfm) accounts
+  * You have a [Koito](/configuration/clients/koito) server 
+
+<details>
+
+<summary>Configuration</summary>
+
+<MultiPersonsServices/>
+
+</details>
+
+### Use Musicbrainz to Fix Scrobbles from Navidrome
+
+You have multiple Sources of music but your personal, on-filesystem music collection is not well organized.
+
+You want to use the [Musicbrainz Transformer](/configuration/transforms/musicbrainz) to fix any scrobbles that use Navidrome, where your personal collection is located, so that the scrobble artists/album/title are all standardized.
+
+* You want to **scrobble from...**
+  * A [Spotify](/configuration/sources/spotify) account
+  * A Navidrome instance that you want to use with the built-in [listenbrainz](/configuration/sources/listenbrainz-endpoint) scrobble function
+    * Plays from this Source should be fixed by Musicbrainz before going to your scrobble Clients
+* You want to **scrobble to...**
+  * A [Last.fm](/configuration/clients/lastfm) account
+
+<details>
+
+<summary>Configuration</summary>
+
+<Musicbrainz/>
+
+</details>
@@ -0,0 +1,13 @@
+| Environmental Variable                     | Type    | Default                  | Description                                                          |
+| ------------------------------------------ | ------- | ------------------------ | -------------------------------------------------------------------- |
+| _**`APPLEMUSIC_ID`**_                      | string  |                          | A globally unique ID EX `myComponentId`                              |
+| `APPLEMUSIC_NAME`                          | string  | Value of `APPLEMUSIC_ID` | A vanity name EX `My Cool Component`                                 |
+| `APPLEMUSIC_ENABLE`                        | boolean | true                     | Should this component be used?                                       |
+| `APPLEMUSIC_KEY_ID`                        | string  |                          |                                                                      |
+| `APPLEMUSIC_TEAM_ID`                       | string  |                          |                                                                      |
+| `APPLEMUSIC_KEY_P8`                        | string  |                          |                                                                      |
+| _**`APPLEMUSIC_MEDIA_USER_TOKEN`**_        | string  |                          |                                                                      |
+| `APPLEMUSIC_TOKEN`                         | string  |                          |                                                                      |
+| `APPLEMUSIC_ORIGIN_HEADER`                 | string  |                          | Origin header to include in every Apple Music API request.           |
+| `APPLEMUSIC_RECOVER_UNCHANGED_TOP_HISTORY` | boolean | true                     | Fixes a quirk where Apple Music's history API hides duplicate plays. |
+| `APPLEMUSIC_NORMALIZE_ALBUM`               | boolean | true                     | Removes extraneous suffixes from album data                          |
@@ -0,0 +1,10 @@
+| Environmental Variable | Type    | Default             | Description                                       |
+| ---------------------- | ------- | ------------------- | ------------------------------------------------- |
+| _**`AZURA_ID`**_       | string  |                     | A globally unique ID EX `myComponentId`           |
+| `AZURA_NAME`           | string  | Value of `AZURA_ID` | A vanity name EX `My Cool Component`              |
+| `AZURA_ENABLE`         | boolean | true                | Should this component be used?                    |
+| _**`AZURA_STATION`**_  | string  |                     | The specific station to monitor                   |
+| _**`AZURA_URL`**_      | string  |                     | Base URL of the Azuracast instance                |
+| `AZURA_KEY`            | string  |                     | API Key used to access data about private streams |
+| `AZURA_LISTENERS_NUM`  | string  |                     |                                                   |
+| `AZURA_LIVE`           | boolean |                     |                                                   |
@@ -0,0 +1,9 @@
+| Environmental Variable | Type    | Default          | Description                                                                                     |
+| ---------------------- | ------- | ---------------- | ----------------------------------------------------------------------------------------------- |
+| _**`CC_ID`**_          | string  |                  | A globally unique ID EX `myComponentId`                                                         |
+| `CC_NAME`              | string  | Value of `CC_ID` | A vanity name EX `My Cool Component`                                                            |
+| `CC_ENABLE`            | boolean | true             | Should this component be used?                                                                  |
+| `CC_BLACKLIST_DEVICES` | string  |                  | DO NOT scrobble from any cast devices on this comma-delimited list that START WITH these values |
+| `CC_WHITELIST_DEVICES` | string  |                  | ONLY scrobble from any cast device on this comma-delimited list that START WITH these values    |
+| `CC_BLACKLIST_APPS`    | string  |                  | DO NOT scrobble from any application on this comma-delimited list that START WITH these values  |
+| `CC_WHITELIST_APPS`    | string  |                  | ONLY scrobble from any application on this comma-delimited list that START WITH these values    |
@@ -0,0 +1,8 @@
+| Environmental Variable | Type    | Default                                                              | Description                                        |
+| ---------------------- | ------- | -------------------------------------------------------------------- | -------------------------------------------------- |
+| _**`DEEZER_ID`**_      | string  |                                                                      | A globally unique ID EX `myComponentId`            |
+| `DEEZER_NAME`          | string  | Value of `DEEZER_ID`                                                 | A vanity name EX `My Cool Component`               |
+| `DEEZER_ENABLE`        | boolean | true                                                                 | Should this component be used?                     |
+| _**`DEEZER_ARL`**_     | string  |                                                                      | ARL retrieved from Deezer response header          |
+| `DEEZER_ACCOUNT_ID`    | string  |                                                                      | The ID (USER_ID) of the linked account to monitor. |
+| `DEEZER_USER_AGENT`    | string  | Mozilla/5.0 (X11; Linux i686; rv:135.0) Gecko/20100101 Firefox/135.0 | User agent                                         |
@@ -0,0 +1,8 @@
+| Environmental Variable | Type    | Default           | Description                                                                                                                                                                      |
+| ---------------------- | ------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| _**`LFM_ID`**_         | string  |                   | A globally unique ID EX `myComponentId`                                                                                                                                          |
+| `LFM_NAME`             | string  | Value of `LFM_ID` | A vanity name EX `My Cool Component`                                                                                                                                             |
+| `LFM_ENABLE`           | boolean | true              | Should this component be used?                                                                                                                                                   |
+| `LFM_SLUG`             | string  |                   | When using **multiple sources without apikey/user**, or **not** using the standard base URL, this is the URL base path that should be used to identify scrobbles for this source |
+| `LFM_USERNAME`         | string  |                   | A fake username to differentiate LFM Endpoint Sources                                                                                                                            |
+| `LFM_API_KEY`          | string  |                   | A fake api key to differentiate LFM Endpoint Sources                                                                                                                             |
@@ -0,0 +1,8 @@
+| Environmental Variable | Type    | Default           | Description                                                                                                                                                               |
+| ---------------------- | ------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| _**`LZE_ID`**_         | string  |                   | A globally unique ID EX `myComponentId`                                                                                                                                   |
+| `LZE_NAME`             | string  | Value of `LZE_ID` | A vanity name EX `My Cool Component`                                                                                                                                      |
+| `LZE_ENABLE`           | boolean | true              | Should this component be used?                                                                                                                                            |
+| `LZE_SLUG`             | string  |                   | When using **multiple sources without tokens**, or **not** using a standard base URL, this is the URL base path that should be used to identify scrobbles for this source |
+| `LZE_TOKEN`            | string  |                   | If an LZ submission request contains this token in the Authorization Header it will be used to match the submission with this Source                                      |
+| `LZE_USERNAME`         | string  |                   | The listenbrainz "username" to associate with this Source                                                                                                                 |
@@ -0,0 +1,7 @@
+| Environmental Variable | Type    | Default               | Description                             |
+| ---------------------- | ------- | --------------------- | --------------------------------------- |
+| _**`ICECAST_ID`**_     | string  |                       | A globally unique ID EX `myComponentId` |
+| `ICECAST_NAME`         | string  | Value of `ICECAST_ID` | A vanity name EX `My Cool Component`    |
+| `ICECAST_ENABLE`       | boolean | true                  | Should this component be used?          |
+| _**`ICECAST_URL`**_    | string  |                       | The Icecast stream URL                  |
+| `ICECAST_AUTO_MONITOR` | boolean |                       |                                         |
@@ -0,0 +1,17 @@
+| Environmental Variable           | Type           | Default                | Description                                                                                                                       |
+| -------------------------------- | -------------- | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+| _**`JELLYFIN_ID`**_              | string         |                        | A globally unique ID EX `myComponentId`                                                                                           |
+| `JELLYFIN_NAME`                  | string         | Value of `JELLYFIN_ID` | A vanity name EX `My Cool Component`                                                                                              |
+| `JELLYFIN_ENABLE`                | boolean        | true                   | Should this component be used?                                                                                                    |
+| _**`JELLYFIN_USER`**_            | string         |                        | The username of the user to authenticate for or track scrobbles for                                                               |
+| `JELLYFIN_PASSWORD`              | string         |                        | Password of the username to authenticate for                                                                                      |
+| `JELLYFIN_APIKEY`                | string         |                        | API Key to authenticate with.                                                                                                     |
+| _**`JELLYFIN_URL`**_             | string         |                        | HOST:PORT of the Jellyfin server to connect to                                                                                    |
+| `JELLYFIN_USERS_ALLOW`           | string OR true |                        | Only scrobble for specific users from this comma-delimited list. If `true`, scrobble for all users.                               |
+| `JELLYFIN_USERS_BLOCK`           | string         |                        | Do not scrobble for users from this comma-delimited list                                                                          |
+| `JELLYFIN_DEVICES_ALLOW`         | string         |                        | Only scrobble if device or application name contains strings from this comma-delimited list                                       |
+| `JELLYFIN_DEVICES_BLOCK`         | string         |                        | Do not scrobble if device or application name contains strings from this comma-delimited list                                     |
+| `JELLYFIN_LIBRARIES_ALLOW`       | string         |                        | Only scrobble if library name contains string from this comma-delimited list                                                      |
+| `JELLYFIN_LIBRARIES_BLOCK`       | string         |                        | Do not scrobble if library name contains strings from this comma-delimited list                                                   |
+| `JELLYFIN_FRONTEND_URL_OVERRIDE` | string         |                        | HOST:PORT of the Jellyfin server that your browser will be able to access from the frontend (and thus load images and links from) |
+| `JELLYFIN_MEDIATYPES_ALLOW`      | string         |                        | Allow media types from this comma-delimited list to be scrobbled                                                                  |
@@ -0,0 +1,8 @@
+| Environmental Variable | Type    | Default                         | Description                                              |
+| ---------------------- | ------- | ------------------------------- | -------------------------------------------------------- |
+| _**`JRIVER_ID`**_      | string  |                                 | A globally unique ID EX `myComponentId`                  |
+| `JRIVER_NAME`          | string  | Value of `JRIVER_ID`            | A vanity name EX `My Cool Component`                     |
+| `JRIVER_ENABLE`        | boolean | true                            | Should this component be used?                           |
+| _**`JRIVER_URL`**_     | string  | http://localhost:52199/MCWS/v1/ | URL of the JRiver HTTP server to connect to              |
+| `JRIVER_USER`          | string  |                                 | If you have enabled authentication, the username you set |
+| `JRIVER_PASSWORD`      | string  |                                 | If you have enabled authentication, the password you set |
@@ -0,0 +1,8 @@
+| Environmental Variable | Type    | Default                       | Description                                       |
+| ---------------------- | ------- | ----------------------------- | ------------------------------------------------- |
+| _**`KODI_ID`**_        | string  |                               | A globally unique ID EX `myComponentId`           |
+| `KODI_NAME`            | string  | Value of `KODI_ID`            | A vanity name EX `My Cool Component`              |
+| `KODI_ENABLE`          | boolean | true                          | Should this component be used?                    |
+| _**`KODI_URL`**_       | string  | http://localhost:8080/jsonrpc | URL of the Kodi HTTP server to connect to         |
+| _**`KODI_USER`**_      | string  |                               | The username set for Remote Control via Web Sever |
+| _**`KODI_PASSWORD`**_  | string  |                               | The password set for Remote Control via Web Sever |
@@ -0,0 +1,8 @@
+| Environmental Variable     | Type    | Default                    | Description                             |
+| -------------------------- | ------- | -------------------------- | --------------------------------------- |
+| _**`SOURCE_KOITO_ID`**_    | string  |                            | A globally unique ID EX `myComponentId` |
+| `SOURCE_KOITO_NAME`        | string  | Value of `SOURCE_KOITO_ID` | A vanity name EX `My Cool Component`    |
+| `SOURCE_KOITO_ENABLE`      | boolean | true                       | Should this component be used?          |
+| _**`SOURCE_KOITO_URL`**_   | string  |                            | URL for the Koito server                |
+| _**`SOURCE_KOITO_TOKEN`**_ | string  |                            | User token for the user to scrobble for |
+| _**`SOURCE_KOITO_USER`**_  | string  |                            | Username of the user to scrobble for    |
@@ -0,0 +1,9 @@
+| Environmental Variable        | Type    | Default                               | Description                                             |
+| ----------------------------- | ------- | ------------------------------------- | ------------------------------------------------------- |
+| _**`SOURCE_LASTFM_ID`**_      | string  |                                       | A globally unique ID EX `myComponentId`                 |
+| `SOURCE_LASTFM_NAME`          | string  | Value of `SOURCE_LASTFM_ID`           | A vanity name EX `My Cool Component`                    |
+| `SOURCE_LASTFM_ENABLE`        | boolean | true                                  | Should this component be used?                          |
+| _**`SOURCE_LASTFM_API_KEY`**_ | string  |                                       | API Key generated from Last.fm/Libre.fm account         |
+| _**`SOURCE_LASTFM_SECRET`**_  | string  |                                       | Secret generated from Last.fm/Libre.fm account          |
+| `SOURCE_LASTFM_REDIRECT_URI`  | string  | http://localhost:9078/lastfm/callback | Optional URI to use for callback.                       |
+| `SOURCE_LASTFM_SESSION`       | string  |                                       | Optional session id returned from a completed auth flow |
@@ -0,0 +1,10 @@
+| Environmental Variable        | Type    | Default                                | Description                                                    |
+| ----------------------------- | ------- | -------------------------------------- | -------------------------------------------------------------- |
+| _**`SOURCE_LIBREFM_ID`**_     | string  |                                        | A globally unique ID EX `myComponentId`                        |
+| `SOURCE_LIBREFM_NAME`         | string  | Value of `SOURCE_LIBREFM_ID`           | A vanity name EX `My Cool Component`                           |
+| `SOURCE_LIBREFM_ENABLE`       | boolean | true                                   | Should this component be used?                                 |
+| `SOURCE_LIBREFM_API_KEY`      | string  |                                        | Optional Secret for Libre.fm account                           |
+| `SOURCE_LIBREFM_SECRET`       | string  |                                        | Optional Secret for Libre.fm account                           |
+| `SOURCE_LIBREFM_REDIRECT_URI` | string  | http://localhost:9078/librefm/callback | Optional URI to use for callback.                              |
+| `SOURCE_LIBREFM_SESSION`      | string  |                                        | Optional session id returned from a completed auth flow        |
+| `SOURCE_LIBREFM_URLBASE`      | string  | https://libre.fm/2.0/                  | (Optional) The host and path prefix for your Libre.fm instance |
@@ -0,0 +1,8 @@
+| Environmental Variable  | Type    | Default                       | Description                                               |
+| ----------------------- | ------- | ----------------------------- | --------------------------------------------------------- |
+| _**`SOURCE_LZ_ID`**_    | string  |                               | A globally unique ID EX `myComponentId`                   |
+| `SOURCE_LZ_NAME`        | string  | Value of `SOURCE_LZ_ID`       | A vanity name EX `My Cool Component`                      |
+| `SOURCE_LZ_ENABLE`      | boolean | true                          | Should this component be used?                            |
+| `SOURCE_LZ_URL`         | string  | https://api.listenbrainz.org/ | URL for the ListenBrainz server, if not using the default |
+| _**`SOURCE_LZ_TOKEN`**_ | string  |                               | User token for the user to scrobble for                   |
+| _**`SOURCE_LZ_USER`**_  | string  |                               | Username of the user to scrobble for                      |
@@ -0,0 +1,7 @@
+| Environmental Variable        | Type    | Default                     | Description                             |
+| ----------------------------- | ------- | --------------------------- | --------------------------------------- |
+| _**`SOURCE_MALOJA_ID`**_      | string  |                             | A globally unique ID EX `myComponentId` |
+| `SOURCE_MALOJA_NAME`          | string  | Value of `SOURCE_MALOJA_ID` | A vanity name EX `My Cool Component`    |
+| `SOURCE_MALOJA_ENABLE`        | boolean | true                        | Should this component be used?          |
+| _**`SOURCE_MALOJA_URL`**_     | string  |                             | URL for maloja server                   |
+| _**`SOURCE_MALOJA_API_KEY`**_ | string  |                             | API Key for Maloja server               |
@@ -0,0 +1,9 @@
+| Environmental Variable  | Type    | Default                        | Description                                                                                |
+| ----------------------- | ------- | ------------------------------ | ------------------------------------------------------------------------------------------ |
+| _**`MOPIDY_ID`**_       | string  |                                | A globally unique ID EX `myComponentId`                                                    |
+| `MOPIDY_NAME`           | string  | Value of `MOPIDY_ID`           | A vanity name EX `My Cool Component`                                                       |
+| `MOPIDY_ENABLE`         | boolean | true                           | Should this component be used?                                                             |
+| `MOPIDY_URL`            | string  | ws://localhost:6680/mopidy/ws/ | URL of the Mopidy HTTP server to connect to                                                |
+| `MOPIDY_URI_DENYLIST`   | string  |                                | Do not scrobble tracks whose URI STARTS WITH any of these strings, case-insensitive        |
+| `MOPIDY_URI_ALLOWLIST`  | string  |                                | Only scrobble tracks whose URI STARTS WITH any of these strings, case-insensitive          |
+| `MOPIDY_ALBUM_DENYLIST` | string  | Soundcloud                     | Remove album data that matches any case-insensitive string from this list when scrobbling, |
@@ -0,0 +1,7 @@
+| Environmental Variable | Type    | Default           | Description                                                                                              |
+| ---------------------- | ------- | ----------------- | -------------------------------------------------------------------------------------------------------- |
+| _**`MPD_ID`**_         | string  |                   | A globally unique ID EX `myComponentId`                                                                  |
+| `MPD_NAME`             | string  | Value of `MPD_ID` | A vanity name EX `My Cool Component`                                                                     |
+| `MPD_ENABLE`           | boolean | true              | Should this component be used?                                                                           |
+| `MPD_URL`              | string  | localhost:6600    | URL:PORT of the MPD server to connect to                                                                 |
+| `MPD_PASSWORD`         | string  |                   | Password for the server, if set https://mpd.readthedocs.io/en/stable/user.html#permissions-and-passwords |
@@ -0,0 +1,7 @@
+| Environmental Variable | Type    | Default             | Description                                                                            |
+| ---------------------- | ------- | ------------------- | -------------------------------------------------------------------------------------- |
+| _**`MPRIS_ID`**_       | string  |                     | A globally unique ID EX `myComponentId`                                                |
+| `MPRIS_NAME`           | string  | Value of `MPRIS_ID` | A vanity name EX `My Cool Component`                                                   |
+| `MPRIS_ENABLE`         | boolean | true                | Should this component be used?                                                         |
+| `MPRIS_BLACKLIST`      | string  |                     | DO NOT scrobble from any players that START WITH values from this comma-delimited list |
+| `MPRIS_WHITELIST`      | string  |                     | ONLY scrobble from any players that START WITH values from this comma-delimited list   |
@@ -0,0 +1,6 @@
+| Environmental Variable | Type    | Default             | Description                                                  |
+| ---------------------- | ------- | ------------------- | ------------------------------------------------------------ |
+| _**`MCAST_ID`**_       | string  |                     | A globally unique ID EX `myComponentId`                      |
+| `MCAST_NAME`           | string  | Value of `MCAST_ID` | A vanity name EX `My Cool Component`                         |
+| `MCAST_ENABLE`         | boolean | true                | Should this component be used?                               |
+| _**`MCAST_URL`**_      | string  |                     | The host or URL of the YamahaExtendedControl endpoint to use |
@@ -0,0 +1,7 @@
+| Environmental Variable | Type    | Default             | Description                                                                                  |
+| ---------------------- | ------- | ------------------- | -------------------------------------------------------------------------------------------- |
+| _**`MC_ID`**_          | string  |                     | A globally unique ID EX `myComponentId`                                                      |
+| `MC_NAME`              | string  | Value of `MC_ID`    | A vanity name EX `My Cool Component`                                                         |
+| `MC_ENABLE`            | boolean | true                | Should this component be used?                                                               |
+| `MC_URL`               | string  | ws://localhost:7905 | URL of the Musikcube Websocket (Metadata) server to connect to                               |
+| _**`MC_PASSWORD`**_    | string  |                     | Password set in Musikcube https://github.com/clangen/musikcube/wiki/remote-api-documentation |
@@ -0,0 +1,13 @@
+| Environmental Variable | Type    | Default            | Description                                                                                   |
+| ---------------------- | ------- | ------------------ | --------------------------------------------------------------------------------------------- |
+| _**`PLEX_ID`**_        | string  |                    | A globally unique ID EX `myComponentId`                                                       |
+| `PLEX_NAME`            | string  | Value of `PLEX_ID` | A vanity name EX `My Cool Component`                                                          |
+| `PLEX_ENABLE`          | boolean | true               | Should this component be used?                                                                |
+| _**`PLEX_URL`**_       | string  |                    | http(s)://HOST:PORT of the Plex server to connect to                                          |
+| `PLEX_TOKEN`           | string  |                    |                                                                                               |
+| `PLEX_USERS_ALLOW`     | string  |                    | Only scrobble for specific users from this comma-delimited list                               |
+| `PLEX_USERS_BLOCK`     | string  |                    | Do not scrobble for users from this comma-delimited list                                      |
+| `PLEX_DEVICES_ALLOW`   | string  |                    | Do not scrobble if device or application name contains strings from this comma-delimited list |
+| `PLEX_DEVICES_BLOCK`   | string  |                    | Only scrobble if device or application name contains strings from this comma-delimited list   |
+| `PLEX_LIBRARIES_ALLOW` | string  |                    | Only scrobble if library name contains string from this comma-delimited list                  |
+| `PLEX_LIBRARIES_BLOCK` | string  |                    | Do not scrobble if library name contains strings from this comma-delimited list               |
@@ -0,0 +1,7 @@
+| Environmental Variable        | Type    | Default                      | Description                                                                                                                                      |
+| ----------------------------- | ------- | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
+| _**`SOURCE_ROCKSKY_ID`**_     | string  |                              | A globally unique ID EX `myComponentId`                                                                                                          |
+| `SOURCE_ROCKSKY_NAME`         | string  | Value of `SOURCE_ROCKSKY_ID` | A vanity name EX `My Cool Component`                                                                                                             |
+| `SOURCE_ROCKSKY_ENABLE`       | boolean | true                         | Should this component be used?                                                                                                                   |
+| `SOURCE_ROCKSKY_KEY`          | string  |                              | API Key generated from [API Applications](https://docs.rocksky.app/migrating-from-listenbrainz-to-rocksky-1040189m0) in Rocksky for your account |
+| _**`SOURCE_ROCKSKY_HANDLE`**_ | string  |                              | The **fully-qualified** handle for your ATPRoto/Bluesky account                                                                                  |
--- a/Show More
+++ b/Show More