docs: Add glossary plugin

feat: Implement transform pipeline providers

.devcontainer/compose.yml

@@ -0,0 +1,25 @@
+version: '3.7'
+services:
+  # Update this to the name of the service you want to work with in your docker-compose.yml file
+  app:
+    # Uncomment if you want to override the service's Dockerfile to one in the .devcontainer 
+    # folder. Note that the path of the Dockerfile and context is relative to the *primary* 
+    # docker-compose.yml file (the first in the devcontainer.json "dockerComposeFile"
+    # array). The sample below assumes your primary file is in the root of your project.
+    #
+    # build:
+    #   context: .
+    #   dockerfile: .devcontainer/Dockerfile
+
+    image: mcr.microsoft.com/devcontainers/javascript-node:1-20-bookworm
+
+    volumes:
+      # Update this to wherever you want VS Code to mount the folder of your project
+      - ..:/workspaces:cached
+    command: sleep infinity
+
+  valkey:
+    image: valkey/valkey
+    env_file:
+      - path: ./.env
+        required: false

.devcontainer/devcontainer.json

@@ -3,19 +3,43 @@
 {
 	"name": "Node.js",
 	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
-	"image": "mcr.microsoft.com/devcontainers/javascript-node:1-22-bookworm",
+	"dockerComposeFile": [
+		"compose.yml"
+	],
+
+	"service": "app",
+
+	"workspaceFolder": "/workspaces",
 
 	// Features to add to the dev container. More info: https://containers.dev/features.
 	// "features": {},
 
 	// Use 'forwardPorts' to make a list of ports inside the container available locally.
-	"forwardPorts": [9078]
+	"forwardPorts": [9078,3000],
 
 	// Use 'postCreateCommand' to run commands after the container is created.
-	//"postCreateCommand": "./.devcontainer/postCreateCommand.sh"
+	"postCreateCommand": "npm install",
 
 	// Configure tool-specific properties.
-	// "customizations": {},
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"hbenl.vscode-mocha-test-adapter",
+				"dbaeumer.vscode-eslint",
+				"unifiedjs.vscode-mdx",
+				"bradlc.vscode-tailwindcss",
+				"TakumiI.markdowntable"
+			]
+		}
+	},
+	"portsAttributes": {
+		"3000": {
+			"label": "Docusaurus"
+		},
+		"9078": {
+			"label": "App"
+		}
+	}
 
 	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
 	// "remoteUser": "root"

.dockerignore

@@ -24,4 +24,7 @@ docsite/.cache-loader
 build
 *.secrets
 .devcontainer
-.vscode
+.vscode
+**/act/*
+tmp-*
+.env

.github/ISSUE_TEMPLATE/01-bug-report.yml

@@ -0,0 +1,67 @@
+name: Bug Report
+description: Report a reproducible problem
+title: "bug: "
+labels: ["bug"]
+body:
+  - type: checkboxes
+    attributes:
+      label: Please check existing knowledge before opening an issue
+      options:
+      - label: I have [checked the FAQ](https://foxxmd.github.io/multi-scrobbler/docs/FAQ/) and [documentation](https://foxxmd.github.io/multi-scrobbler/docs/configuration/)
+        required: true
+      - label: I have [searched through existing issues](https://github.com/FoxxMD/multi-scrobbler/issues?q=sort%3Aupdated-desc) and [discussions.](https://github.com/FoxxMD/multi-scrobbler/discussions)
+        required: true
+  - type: markdown
+    attributes:
+      value: |
+        If this a how-do-I question, troublehooting, or generally **not** a bug/error with multi-scrobbler please consider [**starting a discussion**](https://github.com/FoxxMD/multi-scrobbler/discussions) instead of opening an issue.
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: Describe the Bug
+      description: Describe what you expected to happen and what happened instead. Please provide as much detail as possible.
+      placeholder: The app should have scrobbled from Spotify but instead it crashed with an error about undefined properties, etc...
+    validations:
+      required: true
+  - type: dropdown
+    id: platform
+    attributes:
+      label: Platform
+      description: What platform are you running multi-scrobbler on?
+      options:
+        - Docker
+        - Local (NodeJS)
+        - Flatpak
+      default: 0
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Versions
+      description: What version of multi-scrobbler and issue-related sources/clients are running?
+      placeholder: |
+        - multi-scrobbler: 0.8.3 on docker
+        - maloja 3.1.4
+        - jellyfin 10.8.9
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: |
+        Please copy and paste any/all relevant from the DEBUG level log output. 
+        Even if your issue does not seem to be shown in the logs you should still add as much detail as possible, a _lack_ of issues in logs may be a good hint during debugging.
+        Your logs will be automatically formatted into code, do not need use backticks.
+        If possible reproduce the issue with [**Debug Mode** enabled](https://foxxmd.github.io/multi-scrobbler/docs/configuration#debug-mode).
+      render: shell
+      placeholder: |
+        [2025-02-14 12:47:57.170 -0500] VERBOSE: [Init] Config Dir ENV: undefined -> Resolved: CWD/config
+        [2025-02-14 12:47:57.236 -0500] INFO   : [Init] Debug Mode: NO
+        [2025-02-14 12:47:57.258 -0500] INFO   : [Init] Version: master
+        [2025-02-14 12:47:57.259 -0500] INFO   : [Init] Generating schema definitions...
+        [2025-02-14 12:47:59.148 -0500] DEBUG  : [App] [Scrobblers] [Maloja - default] Found 100 recent scrobbles
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: Add any other context about the problem here.

.github/ISSUE_TEMPLATE/02-feature-request.yml

@@ -0,0 +1,31 @@
+name: Feature Request
+description: Suggest a new feature or functionality
+title: "feat: "
+labels: ["enhancement"]
+body:
+  - type: checkboxes
+    attributes:
+      label: Please check existing knowledge before opening an issue
+      options:
+      - label: I have checked the [documentation](https://foxxmd.github.io/multi-scrobbler/docs/configuration/)
+        required: true
+      - label: I have [searched through existing issues](https://github.com/FoxxMD/multi-scrobbler/issues?q=sort%3Aupdated-desc) and [discussions.](https://github.com/FoxxMD/multi-scrobbler/discussions)
+        required: true
+  - type: textarea
+    attributes:
+      label: Describe the new functionality
+      description: Please describe the feature or functionality you want multi-scrobbler to have. Use as much detail as possible about the exact behavior you wish to see.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Configuration Example
+      description: |
+        If the functionality involves changes to configuration files please provide an example here
+      render: json5
+  - type: checkboxes
+    attributes:
+      label: Will you help implement it?
+      options:
+        - label: I am willing to contribute code towards completing this feature
+        - label: I am willing to help test preview builds for this feature

.github/ISSUE_TEMPLATE/03-new-source-client.yml

@@ -0,0 +1,75 @@
+name: Request a new Source or Client
+description: Request a new Source or Client to be implemented
+title: "feat: "
+labels: ["enhancement"]
+body:
+  - type: checkboxes
+    attributes:
+      label: Please check existing knowledge before opening an issue
+      options:
+      - label: I have checked the [documentation](https://foxxmd.github.io/multi-scrobbler/docs/configuration/)
+        required: true
+      - label: I have [searched through existing issues](https://github.com/FoxxMD/multi-scrobbler/issues?q=sort%3Aupdated-desc) and [discussions.](https://github.com/FoxxMD/multi-scrobbler/discussions)
+        required: true
+  - type: dropdown
+    attributes:
+      label: What Type?
+      description: Is this a Source or a Client?
+      options:
+        - Source
+        - Client
+      default: 1
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Name
+      description: "What is the name of the new service/software?"
+      placeholder: "My Cool Player"
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Website
+      description: "Website for the service/software. Preferably a github repo or other source-code homepage"
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: API Available?
+      description: Does the service have an API or other protocol that multi-scrobbler can use to communicate? **Without this the likelyhood of implementation is very low.**
+      options:
+        - 'Yes'
+        - 'No'
+      default: 1
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Free To Use?
+      description: Is this service/software freely available or does it require purchasing/subscription?
+      options:
+        - 'Yes'
+        - 'No'
+      default: 1
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Willing to finance development?
+      description: If the software is **non-free** are you will to provide a paid account/subscription to multi-scrobbler developer's in order to facilitate development/testing?
+      options:
+        - 'Yes'
+        - 'No'
+    validations:
+      required: false
+  - type: checkboxes
+    attributes:
+      label: Will you help implement it?
+      options:
+        - label: I am willing to contribute code towards completing this feature
+        - label: I am willing to help test preview builds for this feature
+  - type: textarea
+    attributes:
+      label: Additional Context
+      description: Add any other context about the new Source/Client here

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,40 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-
-[Please check the FAQ](https://github.com/FoxxMD/multi-scrobbler/blob/master/docsite/docs/FAQ.md) before submitting a bug report.
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Logs**
-If possible reproduce the issue with [debug logging ON](https://github.com/FoxxMD/multi-scrobbler/blob/master/docsite/docs/FAQ.md#turn-on-debug-logging)
-
-```
-Copy and paste as much log data as possible related to this issue here.
-```
-
-**Versions (please complete the following information):**
-Provide version information for any related sources/clients.
-
-- multi-scrobbler: [e.g. 0.8.3 on docker]
-- maloja [e.g. 3.1.4]
-- jellyfin [e.g. 10.8.9]
-
-**Additional context**
-Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/act/.actrc

@@ -1,3 +1,5 @@
 --directory ../../
 --env-file .github/act/.env
---secret-file .github/act/.secrets
+--secret-file .github/act/.secrets
+--artifact-server-path out
+#--action-offline-mode

.github/act/.env.example

@@ -1 +1,5 @@
-NO_DOCKER_BUILD=true
+NO_DOCKER_BUILD=true
+#https://github.com/nektos/act/issues/329#issuecomment-1905955589
+ACTIONS_RUNTIME_URL=http://YOUR_HOST_IP:8082/
+ACTIONS_RUNTIME_TOKEN=foo
+ACTIONS_CACHE_URL=http://YOUR_HOST_IP:8082/

.github/act/README.md

@@ -1,10 +1,24 @@
-Testing GH Actions with [ACT]
+Testing GH Actions with ACT
 
 Need to have credentials in a [`.secrets` file](https://nektosact.com/usage/index.html#secrets), copy and rename [`.secrets.example`](./secrets.example) to `.secrets`, then fill out blank fields. Required for docker/metadata-action to read...something. Fails with `Parameter token or opts.auth is required` if they are not supplied.
 
-An ENV file can also be made by copy and renaming [`.env.example`](./env.example). Set `NO_DOCKER_BUILD=true` if you only want to test APP_VERSION and docker tags output.
+An ENV file can also be made by copy and renaming [`.env.example`](./env.example). Set `NO_DOCKER_BUILD=true` if you only want to test APP_VERSION and docker tags output. 
 
-Run the following **from this directory** to make use of `.actrc` and proper working directoy.
+If running a full docker build for multi-runner workflows you will need to create an [artifact server](https://github.com/nektos/act/issues/329#issuecomment-1905955589) for ACT to work:
+
+
+```shell
+docker pull ghcr.io/jefuller/artifact-server:latest
+docker run -d --name artifact-server -p 8082:8080 --add-host host.docker.internal:host-gateway -e AUTH_KEY=foo ghcr.io/jefuller/artifact-server:latest
+```
+
+Run the following **from this directory** to make use of `.actrc` and proper working directory.
+
+### Test Branch Test Suite
+
+```shell
+act -W '.github/act/testSuite.yml' -e '.github/act/actBranchEvent.json'
+```
 
 ### Test Branch Push
 
@@ -25,3 +39,15 @@ act -W '.github/act/actTest.yml' -e '.github/act/actTagEvent.json'
 ```shell
 act -W '.github/act/actTest.yml' -e '.github/act/actTagPreEvent.json'
 ```
+
+### Test Multi-Runner Push (WIP)
+
+```shell
+act -W '.github/act/multiRunnerTest.yml' -e '.github/act/actBranchEvent.json'
+```
+
+### Test Multi-Runner Bake Push (WIP)
+
+```shell
+act -W '.github/act/multiRunnerBakeTest.yml' -e '.github/act/actBranchEvent.json'
+```

.github/act/actBranchEvent.json

@@ -1,4 +1,4 @@
 {
   "ref": "refs/heads/master",
-  "sha": "005dae76ab51799d3d55112738e301cb1af0dafd"
+  "sha": "14d5eb3313110f2cfd1aa8fe9c229c21901c1eeb"
 }

.github/act/actPREvent.json

@@ -0,0 +1,164 @@
+{
+    "action": "synchronize",
+    "number": 210,
+    "pull_request": {
+      "url": "https://api.github.com/repos/FoxxMD/multi-scrobbler/pulls/210",
+      "id": 2123337348,
+      "node_id": "PR_kwDOEpP-x85-j46E",
+      "number": 210,
+      "state": "open",
+      "locked": false,
+      "merge_commit_sha": "349bea1f4580b9e61aa22446eae73f8b1225bbb7",
+      "labels": [
+        {
+          "id": 2494982061,
+          "node_id": "MDU6TGFiZWwyNDk0OTgyMDYx",
+          "url": "https://api.github.com/repos/FoxxMD/multi-scrobbler/labels/bug",
+          "name": "bug",
+          "color": "d73a4a",
+          "default": true,
+          "description": "Something isn't working"
+        },
+        {
+          "id": 7131135993,
+          "node_id": "LA_kwDOEpP-x88AAAABqQx_-Q",
+          "url": "https://api.github.com/repos/FoxxMD/multi-scrobbler/labels/safe%20to%20test",
+          "name": "safe to test",
+          "color": "D4C5F9",
+          "default": false,
+          "description": "trusted to build image"
+        }
+      ],
+      "milestone": null,
+      "draft": false,
+      "head": {
+        "label": "FoxxMD:GH-209/jellyfinCleanup",
+        "ref": "GH-209/jellyfinCleanup",
+        "sha": "e251da9b8eecfcb3aba8756393e5075d0092794b",
+        "user": {
+          "login": "FoxxMD",
+          "id": 4663766,
+          "node_id": "MDQ6VXNlcjQ2NjM3NjY=",
+          "avatar_url": "https://avatars.githubusercontent.com/u/4663766?v=4",
+          "gravatar_id": "",
+          "url": "https://api.github.com/users/FoxxMD",
+          "html_url": "https://github.com/FoxxMD",
+          "followers_url": "https://api.github.com/users/FoxxMD/followers",
+          "following_url": "https://api.github.com/users/FoxxMD/following{/other_user}",
+          "gists_url": "https://api.github.com/users/FoxxMD/gists{/gist_id}",
+          "starred_url": "https://api.github.com/users/FoxxMD/starred{/owner}{/repo}",
+          "subscriptions_url": "https://api.github.com/users/FoxxMD/subscriptions",
+          "organizations_url": "https://api.github.com/users/FoxxMD/orgs",
+          "repos_url": "https://api.github.com/users/FoxxMD/repos",
+          "events_url": "https://api.github.com/users/FoxxMD/events{/privacy}",
+          "received_events_url": "https://api.github.com/users/FoxxMD/received_events",
+          "type": "User",
+          "site_admin": false
+        },
+        "repo": {
+          "id": 311688903,
+          "node_id": "MDEwOlJlcG9zaXRvcnkzMTE2ODg5MDM=",
+          "name": "multi-scrobbler",
+          "full_name": "FoxxMD/multi-scrobbler",
+          "private": false,
+          "owner": {
+            "login": "FoxxMD",
+            "id": 4663766,
+            "node_id": "MDQ6VXNlcjQ2NjM3NjY=",
+            "avatar_url": "https://avatars.githubusercontent.com/u/4663766?v=4",
+            "gravatar_id": "",
+            "url": "https://api.github.com/users/FoxxMD",
+            "html_url": "https://github.com/FoxxMD",
+            "followers_url": "https://api.github.com/users/FoxxMD/followers",
+            "following_url": "https://api.github.com/users/FoxxMD/following{/other_user}",
+            "gists_url": "https://api.github.com/users/FoxxMD/gists{/gist_id}",
+            "starred_url": "https://api.github.com/users/FoxxMD/starred{/owner}{/repo}",
+            "subscriptions_url": "https://api.github.com/users/FoxxMD/subscriptions",
+            "organizations_url": "https://api.github.com/users/FoxxMD/orgs",
+            "repos_url": "https://api.github.com/users/FoxxMD/repos",
+            "events_url": "https://api.github.com/users/FoxxMD/events{/privacy}",
+            "received_events_url": "https://api.github.com/users/FoxxMD/received_events",
+            "type": "User",
+            "site_admin": false
+          },
+          "html_url": "https://github.com/FoxxMD/multi-scrobbler",
+          "description": "Scrobble plays from multiple sources to multiple clients",
+          "fork": false,
+          "created_at": "2020-11-10T14:45:38Z",
+          "updated_at": "2024-10-14T09:21:37Z",
+          "pushed_at": "2024-10-14T15:43:00Z",
+          "allow_forking": true,
+          "is_template": false,
+          "web_commit_signoff_required": false,
+          "visibility": "public",
+          "forks": 16,
+          "open_issues": 19,
+          "watchers": 369,
+          "default_branch": "master",
+          "allow_squash_merge": true,
+          "allow_merge_commit": true,
+          "allow_rebase_merge": true,
+          "allow_auto_merge": false,
+          "delete_branch_on_merge": false,
+          "allow_update_branch": false,
+          "use_squash_pr_title_as_default": false,
+          "squash_merge_commit_message": "COMMIT_MESSAGES",
+          "squash_merge_commit_title": "COMMIT_OR_PR_TITLE",
+          "merge_commit_message": "PR_TITLE",
+          "merge_commit_title": "MERGE_MESSAGE"
+        }
+      },
+      "base": {
+        "label": "FoxxMD:master",
+        "ref": "master",
+        "sha": "9c21db8172b6beff9d321e831e9353bf17e92a37",
+        "repo": {
+          "id": 311688903,
+          "node_id": "MDEwOlJlcG9zaXRvcnkzMTE2ODg5MDM=",
+          "name": "multi-scrobbler",
+          "full_name": "FoxxMD/multi-scrobbler",
+          "private": false,
+          "fork": false,
+          "created_at": "2020-11-10T14:45:38Z",
+          "updated_at": "2024-10-14T09:21:37Z",
+          "pushed_at": "2024-10-14T15:43:00Z",
+          "allow_forking": true,
+          "is_template": false,
+          "web_commit_signoff_required": false,
+          "visibility": "public",
+          "forks": 16,
+          "open_issues": 19,
+          "watchers": 369,
+          "default_branch": "master",
+          "allow_squash_merge": true,
+          "allow_merge_commit": true,
+          "allow_rebase_merge": true,
+          "allow_auto_merge": false,
+          "delete_branch_on_merge": false,
+          "allow_update_branch": false,
+          "use_squash_pr_title_as_default": false,
+          "squash_merge_commit_message": "COMMIT_MESSAGES",
+          "squash_merge_commit_title": "COMMIT_OR_PR_TITLE",
+          "merge_commit_message": "PR_TITLE",
+          "merge_commit_title": "MERGE_MESSAGE"
+        }
+      },
+      "author_association": "OWNER",
+      "auto_merge": null,
+      "active_lock_reason": null,
+      "merged": false,
+      "mergeable": null,
+      "rebaseable": null,
+      "mergeable_state": "unknown",
+      "merged_by": null,
+      "comments": 0,
+      "review_comments": 0,
+      "maintainer_can_modify": false,
+      "commits": 5,
+      "additions": 84,
+      "deletions": 28,
+      "changed_files": 5
+    },
+    "before": "335ee0cd601f5a82e36643c812507b2b53e7daf0",
+    "after": "e251da9b8eecfcb3aba8756393e5075d0092794b"
+  }

.github/act/actTagPreEvent.json

@@ -1,6 +1,6 @@
 {
-  "ref": "refs/tags/0.8.5-rc1",
-  "ref_name": "0.8.5-rc1",
+  "ref": "refs/tags/0.8.5-gh-runner",
+  "ref_name": "0.8.5-gh-runner",
   "before": "0000000000000000000000000000000000000000",
   "after": "005dae76ab51799d3d55112738e301cb1af0dafd",
   "sha": "005dae76ab51799d3d55112738e301cb1af0dafd",

.github/act/docker-bake.hcl

@@ -0,0 +1,30 @@
+variable "DEFAULT_TAG" {
+  default = "multi-scrobbler:local"
+}
+
+// Special target: https://github.com/docker/metadata-action#bake-definition
+target "docker-metadata-action" {
+  tags = ["${DEFAULT_TAG}"]
+}
+
+// Default target if none specified
+group "default" {
+  targets = ["image-local"]
+}
+
+target "image" {
+  inherits = ["docker-metadata-action"]
+}
+
+target "image-local" {
+  inherits = ["image"]
+  output = ["type=docker"]
+}
+
+target "image-all" {
+  inherits = ["image"]
+  platforms = [
+    "linux/amd64",
+    "linux/arm64"
+  ]
+}

.github/act/multiRunnerBakeTest.yml

@@ -0,0 +1,233 @@
+# Based on https://docs.docker.com/build/ci/github-actions/multi-platform/#with-bake (https://github.com/docker/build-push-action/issues/671#issuecomment-1609106171)
+# with example from here https://github.com/crazy-max/docker-linguist/blob/master/.github/workflows/build.yml that uses caching
+#
+# may have to use this to enable pushing to multiple registries? https://github.com/docker/build-push-action/discussions/1067#discussioncomment-8677682
+
+name: build
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - 'master'
+    tags:
+      - '*.*.*'
+    paths-ignore:
+      - 'README.md'
+      - '.github/**'
+      - 'flatpak/**'
+
+env:
+  DOCKERHUB_SLUG: foxxmd/multi-scrobbler
+  GHCR_SLUG: ghcr.io/foxxmd/multi-scrobbler
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.platforms.outputs.matrix }}
+    steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set short git commit SHA
+        id: appvars
+        # https://dev.to/hectorleiva/github-actions-and-creating-a-short-sha-hash-8b7
+        # short sha available under env.COMMIT_SHORT_SHA
+        run: |
+          calculatedSha=$(git rev-parse --short HEAD)
+          branchName=$(git rev-parse --abbrev-ref HEAD)
+          echo "COMMIT_SHORT_SHA=$calculatedSha" >> $GITHUB_ENV
+          echo "COMMIT_BRANCH=$branchName" >> $GITHUB_ENV
+
+      - name: Get App Version
+        id: appversion
+        env:
+          # use release instead of tags once version is correctly parsed
+          #APP_VERSION: ${{ github.event.release.tag_name }}
+
+          # https://github.com/actions/runner/issues/409#issuecomment-752775072
+          # https://stackoverflow.com/a/69919067/1469797
+          APP_VERSION: ${{ contains(github.ref, 'refs/tags/') && github.ref_name || format('{0}-{1}', env.COMMIT_BRANCH, env.COMMIT_SHORT_SHA ) }}
+        run: |
+          echo appversion=$APP_VERSION >>${GITHUB_OUTPUT}
+
+      -
+        name: Create matrix
+        id: platforms
+        run: |
+          echo "matrix=$(docker buildx bake --file ./docker-bake.hcl image-all --print | jq -cr '.target."image-all".platforms')" >>${GITHUB_OUTPUT}
+      -
+        name: Show matrix
+        run: |
+          echo ${{ steps.platforms.outputs.matrix }}
+      -
+        name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            ${{ env.DOCKERHUB_SLUG }}
+            ${{ env.GHCR_SLUG }}
+          tags: |
+            type=edge
+
+            # maybe re-enable branch-named tags in the futures
+            #type=ref,event=branch,enable=${{ !endsWith(github.ref, 'master') }}
+            
+            # tag non-prelease as latest -- has a higher priority than regular tag so it shows first in registries
+            type=match,pattern=\d.\d.\d$,priority=901
+            
+            # tag all semver (include pre-release)
+            type=semver,pattern={{version}}
+          labels: |
+            org.opencontainers.image.title=Multi-Scrobbler
+            org.opencontainers.image.description=Scrobble from many sources to many clients
+            org.opencontainers.image.vendor=FoxxMD
+      -
+        name: Rename meta bake definition file
+        run: |
+          mv "${{ steps.meta.outputs.bake-file }}" "/tmp/bake-meta.json"
+      -
+        name: Upload meta bake definition
+        uses: actions/upload-artifact@v3
+        with:
+          name: bake-meta
+          path: /tmp/bake-meta.json
+          if-no-files-found: error
+          retention-days: 1
+
+  build:
+    runs-on: ubuntu-latest
+    needs:
+      - prepare
+    strategy:
+      fail-fast: false
+      matrix:
+        platform: ${{ fromJson(needs.prepare.outputs.matrix) }}
+    steps:
+      -
+        name: Prepare
+        run: |
+          platform=${{ matrix.platform }}
+          echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV
+      -
+        name: Checkout
+        uses: actions/checkout@v4
+      -
+        name: Test App Version Transfer
+        run: |
+          echo "App Version in Build ${{ needs.prepare.appversion.outputs.appversion }}"
+      -
+        name: Download meta bake definition
+        uses: actions/download-artifact@v3
+        with:
+          name: bake-meta
+          path: /tmp
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+        with:
+          buildkitd-flags: "--debug"
+      -
+        name: Login to DockerHub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+      -
+        name: Login to GHCR
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      -
+        name: Build
+        id: bake
+        uses: docker/bake-action@v5
+        with:
+          files: |
+            ./.github/act/docker-bake.hcl
+            /tmp/bake-meta.json
+          targets: image
+          set: |
+            *.args.APP_BUILD_VERSION=${{ needs.prepare.appversion.outputs.appversion }}
+            *.tags=
+            *.platform=${{ matrix.platform }}
+            *.cache-from=type=gha,scope=build-${{ env.PLATFORM_PAIR }}
+            *.cache-to=type=gha,scope=build-${{ env.PLATFORM_PAIR }}
+            *.output=type=image,"name=${{ env.DOCKERHUB_SLUG }},${{ env.GHCR_SLUG }}",push-by-digest=true,name-canonical=true,push=${{ github.event_name != 'pull_request' }}
+      -
+        name: Export digest
+        run: |
+          mkdir -p /tmp/digests
+          digest="${{ fromJSON(steps.bake.outputs.metadata).image['containerimage.digest'] }}"
+          touch "/tmp/digests/${digest#sha256:}"
+      -
+        name: Upload digest
+        uses: actions/upload-artifact@v3
+        with:
+          name: digests-${{ env.PLATFORM_PAIR }}
+          path: /tmp/digests/*
+          if-no-files-found: error
+          retention-days: 1
+
+  merge:
+    runs-on: ubuntu-latest
+    if: github.event_name != 'pull_request'
+    needs:
+      - build
+    steps:
+      -
+        name: Download meta bake definition
+        uses: actions/download-artifact@v3
+        with:
+          name: bake-meta
+          path: /tmp
+      -
+        name: Download digests
+        uses: actions/download-artifact@v3
+        with:
+          path: /tmp/digests
+          pattern: digests-*
+          merge-multiple: true
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      -
+        name: Login to DockerHub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+      -
+        name: Login to GHCR
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      -
+        name: Create manifest list and push
+        working-directory: /tmp/digests
+        run: |
+          docker buildx imagetools create $(jq -cr '.target."docker-metadata-action".tags | map(select(startswith("${{ env.DOCKERHUB_SLUG }}")) | "-t " + .) | join(" ")' /tmp/bake-meta.json) \
+            $(printf '${{ env.DOCKERHUB_SLUG }}@sha256:%s ' *)
+          docker buildx imagetools create $(jq -cr '.target."docker-metadata-action".tags | map(select(startswith("${{ env.GHCR_SLUG }}")) | "-t " + .) | join(" ")' /tmp/bake-meta.json) \
+            $(printf '${{ env.GHCR_SLUG }}@sha256:%s ' *)
+      -
+        name: Inspect image
+        run: |
+          tag=$(jq -r '.target."docker-metadata-action".args.DOCKER_META_VERSION' /tmp/bake-meta.json)
+          docker buildx imagetools inspect ${{ env.DOCKERHUB_SLUG }}:${tag}
+          docker buildx imagetools inspect ${{ env.GHCR_SLUG }}:${tag}

.github/act/multiRunnerTest.yml

@@ -0,0 +1,198 @@
+# Based on https://docs.docker.com/build/ci/github-actions/multi-platform/#distribute-build-across-multiple-runners
+
+name: build
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  push:
+    branches:
+      - 'master'
+    tags:
+      - '*.*.*'
+    paths-ignore:
+      - 'README.md'
+      - '.github/**'
+      - 'flatpak/**'
+
+env:
+  DOCKERHUB_SLUG: foxxmd/multi-scrobbler
+  GHCR_SLUG: ghcr.io/foxxmd/multi-scrobbler
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        platform:
+          - linux/amd64
+          - linux/arm64
+    steps:
+      - name: Prepare
+        run: |
+          platform=${{ matrix.platform }}
+          echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV          
+
+      - name: Check out the repo
+        uses: actions/checkout@v5
+
+      - name: Set short git commit SHA
+        id: appvars
+        # https://dev.to/hectorleiva/github-actions-and-creating-a-short-sha-hash-8b7
+        # short sha available under env.COMMIT_SHORT_SHA
+        run: |
+          calculatedSha=$(git rev-parse --short HEAD)
+          branchName=$(git rev-parse --abbrev-ref HEAD)
+          echo "COMMIT_SHORT_SHA=$calculatedSha" >> $GITHUB_ENV
+          echo "COMMIT_BRANCH=$branchName" >> $GITHUB_ENV
+
+      - name: Get App Version
+        id: appversion
+        env:
+          # use release instead of tags once version is correctly parsed
+          #APP_VERSION: ${{ github.event.release.tag_name }}
+
+          # https://github.com/actions/runner/issues/409#issuecomment-752775072
+          # https://stackoverflow.com/a/69919067/1469797
+          APP_VERSION: ${{ contains(github.ref, 'refs/tags/') && github.ref_name || format('{0}-{1}', env.COMMIT_BRANCH, env.COMMIT_SHORT_SHA ) }}
+        run: |
+          echo appversion=$APP_VERSION >>${GITHUB_OUTPUT}
+      
+      # - name: Extract metadata (tags, labels) for Docker
+      #   id: meta
+      #   uses: docker/metadata-action@v5
+      #   with:
+      #     images: |
+      #       ${{ env.DOCKERHUB_SLUG }}
+      #       ${{ env.GHCR_SLUG }}
+      #     labels: |
+      #       org.opencontainers.image.title=Multi-Scrobbler
+      #       org.opencontainers.image.description=Scrobble from many sources to many clients
+      #       org.opencontainers.image.vendor=FoxxMD
+      
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      
+      # https://github.com/docker/build-push-action/issues/671#issuecomment-1619353328
+      # for caching
+      - name: Build and push by digest
+        id: build
+        uses: docker/build-push-action@v6
+        with:
+          build-args: |
+            APP_BUILD_VERSION=${{steps.appversion.outputs.appversion}}
+          platforms: ${{ matrix.platform }}
+          labels: ${{ steps.meta.outputs.labels }}
+          #tags: ${{ steps.meta.outputs.tags }}
+          outputs: type=image,"name=${{ env.DOCKERHUB_SLUG }},${{ env.GHCR_SLUG }}",push-by-digest=true,name-canonical=true,push=true
+          #cache-from: type=gha,scope=build-${{ env.PLATFORM_PAIR }}
+          #cache-to: type=gha,scope=build-${{ env.PLATFORM_PAIR }}
+      
+      - name: Export digest
+        run: |
+          mkdir -p /tmp/digests
+          digest="${{ steps.build.outputs.digest }}"
+          touch "/tmp/digests/${digest#sha256:}"          
+      
+      - name: Upload digest
+        uses: actions/upload-artifact@v4
+        with:
+          name: digests-${{ env.PLATFORM_PAIR }}
+          path: /tmp/digests/*
+          if-no-files-found: error
+          retention-days: 1
+
+  merge:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+    needs:
+      - build
+    steps:
+      - name: Download digests
+        uses: actions/download-artifact@v4
+        with:
+          path: /tmp/digests
+          pattern: digests-*
+          merge-multiple: true
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            ${{ env.DOCKERHUB_SLUG }}
+            ${{ env.GHCR_SLUG }}
+          # generate Docker tags based on the following events/attributes
+          # https://github.com/docker/metadata-action/issues/247#issuecomment-1511259674 for NOT is default branch, eventually
+          tags: |
+            type=edge
+
+            # maybe re-enable branch-named tags in the futures
+            type=ref,event=branch,enable=${{ !endsWith(github.ref, 'master') }}
+            
+            # tag non-prelease as latest -- has a higher priority than regular tag so it shows first in registries
+            type=match,pattern=\d.\d.\d$,priority=901
+            
+            # tag all semver (include pre-release)
+            type=semver,pattern={{version}}
+        #  flavor: |
+        #    latest=false
+          labels: |
+            org.opencontainers.image.title=Multi-Scrobbler
+            org.opencontainers.image.description=Scrobble from many sources to many clients
+            org.opencontainers.image.vendor=FoxxMD
+      
+
+      
+      - name: Create manifest list and push
+        working-directory: /tmp/digests
+        run: |
+          docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
+            $(printf '${{ env.DOCKERHUB_SLUG }}@sha256:%s ' *)
+          docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
+            $(printf '${{ env.GHCR_SLUG }}@sha256:%s ' *)        
+      
+      - name: Inspect image
+        run: |
+          docker buildx imagetools inspect ${{ env.DOCKERHUB_SLUG }}:${{ steps.meta.outputs.version }}
+          docker buildx imagetools inspect ${{ env.GHCR_SLUG }}:${{ steps.meta.outputs.version }}      

.github/act/testSuite.yml

@@ -0,0 +1,10 @@
+name: PR Workflow
+
+on:
+  push:
+    branches:
+      - 'master'
+
+jobs:
+  test:
+      uses: ./.github/workflows/testAndSanity.yml

.github/workflows/dependabotTest.yml

@@ -11,24 +11,6 @@ on:
 
 jobs:
   test:
-    name: Run Tests and Build (sanity)
+    name: Tests / Build / Sanity Run
     if: github.actor == 'dependabot[bot]'
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out the repo
-        uses: actions/checkout@v4
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '18.x'
-          cache: 'npm'
-      - name: Install dev dependencies
-        run: npm ci
-      - name: Build Backend
-        run: 'npm run build:backend'
-      - name: Test Backend
-        run: npm run test
-      - name: Install Docs Deps
-        run: npm run docs:install
-      - name: Build
-        run: npm run build
+    uses: ./.github/workflows/testAndSanity.yml

.github/workflows/docsDeploy.yml

@@ -12,19 +12,30 @@ jobs:
     name: Deploy to GitHub Pages
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-node@v4
+      - uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 #v4.3.0
+        with:
+          persist-credentials: false
+      - uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 #4.4.0
         with:
           node-version: 20
           cache: npm
 
-      - name: Install dependencies
+      - name: Install app dev dependencies
+        run: npm ci
+      - name: Generate schema files
+        run: npm run schema
+
+      - name: Install docusaurus dependencies
         run: npm ci
         working-directory: ./docsite
       - name: Build website
         env:
           ANALYTICS: ${{ vars.ANALYTICS }}
           ANALYTICS_DOMAIN: ${{ vars.ANALYTICS_DOMAIN }}
+          RY_ANALYTICS: ${{ vars.RY_ANALYTICS }}
+          RY_ANALYTICS_SITEID: ${{ vars.RY_ANALYTICS_SITEID }}
+          RY_ANALYTICS_REPLAY: ${{ vars.RY_ANALYTICS_REPLAY }}
+          GSITEVERIFICATION: ${{ vars.GSITEVERIFICATION }}
           DOCS_BASE: '/multi-scrobbler'
         run: npm run build
         working-directory: ./docsite
@@ -32,7 +43,7 @@ jobs:
       # Popular action to deploy to GitHub Pages:
       # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
       - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
+        uses: peaceiris/actions-gh-pages@373f7f263a76c20808c831209c920827a82a2847 #3.9.3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           # Build output to publish to the `gh-pages` branch:

.github/workflows/packagesDeleteUntagged.yml

@@ -13,7 +13,7 @@ jobs:
     permissions:
       packages: write
     steps:
-      - uses: dataaxiom/ghcr-cleanup-action@v1
+      - uses: dataaxiom/ghcr-cleanup-action@cd0cdb900b5dbf3a6f2cc869f0dbb0b8211f50c4 #1.0.16
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
 

.github/workflows/pr.yml

@@ -1,5 +1,9 @@
 name: PR Workflow
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.head.sha }}
+  cancel-in-progress: true
+
 on:
   pull_request_target:
     types:
@@ -12,29 +16,16 @@ on:
 
 jobs:
   test:
-    name: Run Tests
-    runs-on: ubuntu-latest
     if: contains(github.event.pull_request.labels.*.name, 'safe to test')
-    steps:
-      - name: Check out the repo
-        uses: actions/checkout@v4
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '18.x'
-          cache: 'npm'
-      - name: Install dev dependencies
-        run: npm ci
-      - name: Build Backend
-        run: 'npm run build:backend'
-      - name: Test Backend
-        run: npm run test
+    uses: ./.github/workflows/testAndSanity.yml
+    with:
+      ref: ${{ github.event.pull_request.head.sha }}
 
-  release-snapshot:
-    name: Release snapshot
-    runs-on: ubuntu-latest
+  build-snapshot:
+    name: Build OCI snapshot
     needs: test
     if: contains(github.event.pull_request.labels.*.name, 'safe to test')
+    runs-on: ${{ matrix.os }}
     permissions:
       packages: write
       contents: read
@@ -42,62 +33,185 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - dockerfile: ./Dockerfile
-            suffix: ''
-            platforms: 'linux/amd64,linux/arm64'
-#          - dockerfile: ./alpine.Dockerfile
-#            suffix: '-alpine'
-#            platforms: 'linux/amd64,linux/arm64'
+          - os: ubuntu-latest
+            arch: amd64
+            platform: linux/amd64
+          - os: ubuntu-24.04-arm
+            arch: arm64
+            platform: linux/arm64
     steps:
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
+      - name: Prepare
+        run: |
+          platform=${{ matrix.platform }}
+          echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV     
 
-      - name: Set up Buildx
-        uses: docker/setup-buildx-action@v3
+          # list all registries to push to and join all non-empty with comma
+          # https://unix.stackexchange.com/a/693165/116849
+          # https://stackoverflow.com/a/9429887/1469797
+          strings=("${VARS_DOCKERHUB_SLUG}" "${VARS_GHCR_SLUG}")
+          for i in ${!strings[@]}; do [[ -z ${strings[i]} ]] && unset strings[i]; done
+          joined_string=$(IFS=, ; echo "${strings[*]}")
+          echo "REGISTRIES_JOINED=$joined_string" >> $GITHUB_ENV 
+        env:
+          VARS_DOCKERHUB_SLUG: ${{ vars.DOCKERHUB_SLUG }}
+          VARS_GHCR_SLUG: ${{vars.GHCR_SLUG}}
 
-      - name: Log in to Docker Hub
-        uses: docker/login-action@v3
+      # do not use here!
+      # instead we can specify repo#sha in build-push-action so we only deal with foreign SHA for actually building image
+      # - uses: actions/checkout@v4
+      #   with:
+      #     ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Set short git commit SHA
+        run: |
+          short=$(echo "${{ github.event.pull_request.head.sha }}" | head -c7)
+          echo "COMMIT_SHORT_SHA=$short" >> $GITHUB_ENV
+
+      - name: Get App Version
+        id: appversion
+        env:
+          APP_VERSION: ${{ format('pr{0}-{1}', github.event.number, env.COMMIT_SHORT_SHA ) }}
+        run: |
+          echo appversion=$APP_VERSION >>${GITHUB_OUTPUT}
+
+      - name: Login to Docker Hub
+        if: ${{ vars.DOCKERHUB_SLUG != '' }}
+        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
-
+  
       - name: Login to GitHub Container Registry
-        uses: docker/login-action@v3
+        if: ${{ vars.GHCR_SLUG != '' }}
+        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Extract metadata (tags, labels) for Docker
+      # metadata extract for docker labels/image names is done in merge job
+
+      - name: Set up Buildx
+        uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 #v3.11.1
+
+      # https://github.com/docker/build-push-action/issues/671#issuecomment-1619353328
+      # for caching
+      - name: Build and push by digest
+        id: build
+        uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 #v6.18.0
+        with:
+          # specify foreign repo#sha from PR that is used to build image
+          context: ${{github.event.pull_request.head.repo.clone_url}}#${{github.event.pull_request.head.sha}}
+          build-args: |
+            APP_BUILD_VERSION=${{steps.appversion.outputs.appversion}}
+          platforms: ${{ matrix.platform }}
+          labels: ${{ steps.meta.outputs.labels }}
+          outputs: type=image,"name=${{ env.REGISTRIES_JOINED }}",push-by-digest=true,name-canonical=true,push=true
+          #cache-from: type=gha,scope=build-${{ env.PLATFORM_PAIR }}
+          #cache-to: type=gha,scope=build-${{ env.PLATFORM_PAIR }}
+
+      - name: Export digest
+        run: |
+          mkdir -p /tmp/digests
+          digest="${{ steps.build.outputs.digest }}"
+          touch "/tmp/digests/${digest#sha256:}"          
+      
+      - name: Upload digest
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 #4.6.2
+        with:
+          name: digests-${{ env.PLATFORM_PAIR }}
+          path: /tmp/digests/*
+          if-no-files-found: error
+          retention-days: 1
+
+  release-snapshot:
+    name: Merge OCI Images and Push
+    if: ${{ vars.DOCKERHUB_SLUG != '' ||  vars.GHCR_SLUG != '' }}
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+    needs:
+      - build-snapshot
+      - test
+    steps:
+      - name: Download digests
+        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 #4.3.0
+        with:
+          path: /tmp/digests
+          pattern: digests-*
+          merge-multiple: true
+
+      - name: Login to Docker Hub
+        if: ${{ vars.DOCKERHUB_SLUG != '' }}
+        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Login to GitHub Container Registry
+        if: ${{ vars.GHCR_SLUG != '' }}
+        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 
+      
+      - name: Extract metadata (tags, labels)
         id: meta
-        uses: docker/metadata-action@v5
+        uses: docker/metadata-action@318604b99e75e41977312d83839a89be02ca4893 #5.9.0
         with:
           images: |
-            foxxmd/multi-scrobbler
-            ghcr.io/foxxmd/multi-scrobbler
+            ${{ vars.DOCKERHUB_SLUG }}
+            ${{ vars.GHCR_SLUG }}
+          # generate Docker tags based on the following events/attributes
+          # https://github.com/docker/metadata-action/issues/247#issuecomment-1511259674 for NOT is default branch, eventually
           tags: |
-            type=ref,event=pr,suffix=${{ matrix.suffix }}
+            type=ref,event=pr
           flavor: |
             latest=false
-
-      - uses: actions/checkout@v4
-        with:
-          ref: ${{ github.event.pull_request.head.sha }}
-
-      - name: Build and push
-        id: docker_build
-        uses: docker/build-push-action@v5
+          labels: |
+            org.opencontainers.image.title=Multi-Scrobbler
+            org.opencontainers.image.description=Scrobble from many sources to many clients
+            org.opencontainers.image.vendor=FoxxMD
+      
+      - name: Create manifest list and push dockerhub
+        if: ${{ vars.DOCKERHUB_SLUG != '' }}
+        working-directory: /tmp/digests
+        run: |
+          docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
+            $(printf "${VARS_DOCKERHUB_SLUG}@sha256:%s " *)
         env:
-          APP_VERSION: ${{ format('pr{0}-{1}', github.event.number, github.event.pull_request.head.sha ) }}
-        with:
-          context: .
-          build-args: |
-            APP_BUILD_VERSION=${{env.APP_VERSION}}
-          file: ${{ matrix.dockerfile }}
-          push: ${{ !env.ACT}}
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-          platforms: ${{ matrix.platforms }}
+          VARS_DOCKERHUB_SLUG: ${{ vars.DOCKERHUB_SLUG }}
+      
+      - name: Create manifest list and push gchr
+        if: ${{ vars.GHCR_SLUG != '' }}
+        working-directory: /tmp/digests
+        run: |
+          docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
+            $(printf "${VARS_GHCR_SLUG}@sha256:%s " *)
+        env:
+          VARS_GHCR_SLUG: ${{ vars.GHCR_SLUG }}    
+      
+      - name: Inspect image dockerhub
+        if: ${{ vars.DOCKERHUB_SLUG != '' }}
+        run: |
+          docker buildx imagetools inspect ${VARS_DOCKERHUB_SLUG}:${STEPS_META_OUTPUTS_VERSION}
+        env:
+          VARS_DOCKERHUB_SLUG: ${{ vars.DOCKERHUB_SLUG }}
+          STEPS_META_OUTPUTS_VERSION: ${{ steps.meta.outputs.version }}
+
+      - name: Inspect image ghcr
+        if: ${{ vars.GHCR_SLUG != '' }}
+        run: |
+            docker buildx imagetools inspect ${VARS_GHCR_SLUG}:${STEPS_META_OUTPUTS_VERSION}
+        env:
+          VARS_GHCR_SLUG: ${{ vars.GHCR_SLUG }}
+          STEPS_META_OUTPUTS_VERSION: ${{ steps.meta.outputs.version }}   
+
 
   combine-and-comment:
     name: Leave comment
@@ -106,7 +220,7 @@ jobs:
     if: contains(github.event.pull_request.labels.*.name, 'safe to test')
     steps:
       - name: Create comment
-        uses: marocchino/sticky-pull-request-comment@v2
+        uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 #2.9.4
         with:
           recreate: true
           header: "pr-release"

.github/workflows/publishImage.yml

@@ -1,5 +1,11 @@
+# Based on https://docs.docker.com/build/ci/github-actions/multi-platform/#distribute-build-across-multiple-runners
+
 name: Publish Docker image to Dockerhub
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
 on:
   workflow_dispatch:
   push:
@@ -18,41 +24,60 @@ on:
 #  release:
 #    types: [ published ]
 
+# define in GH Repository -> Actions -> Variables (or act .variables) to enable pushing to registries
+# -- will only push to registries that are defined
+# EX
+# DOCKERHUB_SLUG=foxxmd/multi-scrobbler
+# GHCR_SLUG=ghcr.io/foxxmd/multi-scrobbler
+  
 jobs:
   test:
-    name: Run Tests
     if: github.event_name != 'pull_request'
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out the repo
-        uses: actions/checkout@v4
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '18.x'
-          cache: 'npm'
-      - name: Install dev dependencies
-        run: npm ci
-      - name: Build Backend
-        run: 'npm run build:backend'
-      - name: Test Backend
-        run: npm run test
+    uses: ./.github/workflows/testAndSanity.yml
 
-  push_to_registry:
-    name: Build and push container images
-    if: github.event_name != 'pull_request'
-    runs-on: ubuntu-latest
+  build:
+    name: Build OCI Images
+    if: ${{ github.event_name != 'pull_request' && (vars.DOCKERHUB_SLUG != '' ||  vars.GHCR_SLUG != '') }}
     needs: test
-    # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token
+    runs-on: ${{ matrix.os }}
     permissions:
       packages: write
       contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - os: ubuntu-latest
+            arch: amd64
+            platform: linux/amd64
+          - os: ubuntu-24.04-arm
+            arch: arm64
+            platform: linux/arm64
     steps:
+      - name: Prepare
+        run: |
+          platform=${{ matrix.platform }}
+          echo "PLATFORM_PAIR=${platform//\//-}" >> $GITHUB_ENV     
+
+          # list all registries to push to and join all non-empty with comma
+          # https://unix.stackexchange.com/a/693165/116849
+          # https://stackoverflow.com/a/9429887/1469797
+          strings=("${VARS_DOCKERHUB_SLUG}" "${VARS_GHCR_SLUG}")
+          for i in ${!strings[@]}; do [[ -z ${strings[i]} ]] && unset strings[i]; done
+          joined_string=$(IFS=, ; echo "${strings[*]}")
+          echo "REGISTRIES_JOINED=$joined_string" >> $GITHUB_ENV 
+        env:
+          VARS_DOCKERHUB_SLUG: ${{ vars.DOCKERHUB_SLUG }}
+          VARS_GHCR_SLUG: ${{vars.GHCR_SLUG}}
+          
+
       - name: Check out the repo
-        uses: actions/checkout@v4
+        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 #v4.3.0
+        with:
+          persist-credentials: false
 
       - name: Set short git commit SHA
-        id: vars
+        id: appvars
         # https://dev.to/hectorleiva/github-actions-and-creating-a-short-sha-hash-8b7
         # short sha available under env.COMMIT_SHORT_SHA
         run: |
@@ -61,33 +86,117 @@ jobs:
           echo "COMMIT_SHORT_SHA=$calculatedSha" >> $GITHUB_ENV
           echo "COMMIT_BRANCH=$branchName" >> $GITHUB_ENV
 
-      - name: Log in to Docker Hub
-        uses: docker/login-action@v3
+      - name: Get App Version
+        id: appversion
+        env:
+          # use release instead of tags once version is correctly parsed
+          #APP_VERSION: ${{ github.event.release.tag_name }}
+
+          # https://github.com/actions/runner/issues/409#issuecomment-752775072
+          # https://stackoverflow.com/a/69919067/1469797
+          APP_VERSION: ${{ contains(github.ref, 'refs/tags/') && github.ref_name || format('{0}-{1}', env.COMMIT_BRANCH, env.COMMIT_SHORT_SHA ) }}
+        run: |
+          echo appversion=$APP_VERSION >>${GITHUB_OUTPUT}
+
+      - name: Login to Docker Hub
+        if: ${{ github.event_name != 'pull_request' && vars.DOCKERHUB_SLUG != '' }}
+        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
         with:
           username: ${{ secrets.DOCKER_USERNAME }}
           password: ${{ secrets.DOCKER_PASSWORD }}
-
+  
       - name: Login to GitHub Container Registry
-        uses: docker/login-action@v3
+        if: ${{ github.event_name != 'pull_request' && vars.GHCR_SLUG != '' }}
+        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
         with:
           registry: ghcr.io
           username: ${{ github.repository_owner }}
           password: ${{ secrets.GITHUB_TOKEN }}
       
-      - name: Extract metadata (tags, labels) for Docker
+      # metadata extract for docker labels/image names is done in merge job
+      
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 #v3.11.1
+      
+      # https://github.com/docker/build-push-action/issues/671#issuecomment-1619353328
+      # for caching
+      - name: Build and push by digest
+        id: build
+        uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 #v6.18.0
+        with:
+          build-args: |
+            APP_BUILD_VERSION=${{steps.appversion.outputs.appversion}}
+          platforms: ${{ matrix.platform }}
+          labels: ${{ steps.meta.outputs.labels }}
+          outputs: type=image,"name=${{ env.REGISTRIES_JOINED }}",push-by-digest=true,name-canonical=true,push=true
+          #cache-from: type=gha,scope=build-${{ env.PLATFORM_PAIR }}
+          #cache-to: type=gha,scope=build-${{ env.PLATFORM_PAIR }}
+      
+      - name: Export digest
+        run: |
+          mkdir -p /tmp/digests
+          digest="${VARS_DIGEST}"
+          touch "/tmp/digests/${digest#sha256:}"
+        env:
+            VARS_DIGEST: ${{ steps.build.outputs.digest }}      
+      - name: Upload digest
+        uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 #4.6.2
+        with:
+          name: digests-${{ env.PLATFORM_PAIR }}
+          path: /tmp/digests/*
+          if-no-files-found: error
+          retention-days: 1
+
+  merge:
+    name: Merge OCI Images and Push
+    if: ${{ github.event_name != 'pull_request' && (vars.DOCKERHUB_SLUG != '' ||  vars.GHCR_SLUG != '') }}
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: read
+    needs:
+      - build
+      - test
+    steps:
+      - name: Download digests
+        uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 #4.3.0
+        with:
+          path: /tmp/digests
+          pattern: digests-*
+          merge-multiple: true
+
+      - name: Login to Docker Hub
+        if: ${{ github.event_name != 'pull_request' && vars.DOCKERHUB_SLUG != '' }}
+        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Login to GitHub Container Registry
+        if: ${{ github.event_name != 'pull_request' && vars.GHCR_SLUG != '' }}
+        uses: docker/login-action@5e57cd118135c172c3672efd75eb46360885c0ef # v3.6.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@e468171a9de216ec08956ac3ada2f0791b6bd435 
+      
+      - name: Extract metadata (tags, labels)
         id: meta
-        uses: docker/metadata-action@v5
+        uses: docker/metadata-action@318604b99e75e41977312d83839a89be02ca4893 #5.9.0
         with:
           images: |
-            foxxmd/multi-scrobbler
-            ghcr.io/foxxmd/multi-scrobbler
+            ${{ vars.DOCKERHUB_SLUG }}
+            ${{ vars.GHCR_SLUG }}
           # generate Docker tags based on the following events/attributes
           # https://github.com/docker/metadata-action/issues/247#issuecomment-1511259674 for NOT is default branch, eventually
           tags: |
             type=edge
 
-            # maybe re-enable branch-named tags in the futures
-            #type=ref,event=branch,enable=${{ !endsWith(github.ref, 'master') }}
+            # push with branch name as tag if not master/main
+            type=ref,event=branch,enable=${{ !endsWith(github.ref, 'master') }}
             
             # tag non-prelease as latest -- has a higher priority than regular tag so it shows first in registries
             type=match,pattern=\d.\d.\d$,priority=901
@@ -96,28 +205,41 @@ jobs:
             type=semver,pattern={{version}}
         #  flavor: |
         #    latest=false
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v3
-
-      - name: Build and push Docker image
+          labels: |
+            org.opencontainers.image.title=Multi-Scrobbler
+            org.opencontainers.image.description=Scrobble from many sources to many clients
+            org.opencontainers.image.vendor=FoxxMD
+      
+      - name: Create manifest list and push dockerhub
+        if: ${{ vars.DOCKERHUB_SLUG != '' }}
+        working-directory: /tmp/digests
+        run: |
+          docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
+            $(printf "${VARS_DOCKERHUB_SLUG}@sha256:%s " *)
         env:
-          # use release instead of tags once version is correctly parsed
-          #APP_VERSION: ${{ github.event.release.tag_name }}
+          VARS_DOCKERHUB_SLUG: ${{ vars.DOCKERHUB_SLUG }}
+      
+      - name: Create manifest list and push gchr
+        if: ${{ vars.GHCR_SLUG != '' }}
+        working-directory: /tmp/digests
+        run: |
+          docker buildx imagetools create $(jq -cr '.tags | map("-t " + .) | join(" ")' <<< "$DOCKER_METADATA_OUTPUT_JSON") \
+            $(printf "${VARS_GHCR_SLUG}@sha256:%s " *)
+        env:
+          VARS_GHCR_SLUG: ${{ vars.GHCR_SLUG }}    
+      
+      - name: Inspect image dockerhub
+        if: ${{ vars.DOCKERHUB_SLUG != '' }}
+        run: |
+          docker buildx imagetools inspect ${VARS_DOCKERHUB_SLUG}:${STEPS_META_OUTPUTS_VERSION}
+        env:
+          VARS_DOCKERHUB_SLUG: ${{ vars.DOCKERHUB_SLUG }}
+          STEPS_META_OUTPUTS_VERSION: ${{ steps.meta.outputs.version }}
 
-        # https://github.com/actions/runner/issues/409#issuecomment-752775072
-        # https://stackoverflow.com/a/69919067/1469797
-          APP_VERSION: ${{ contains(github.ref, 'refs/tags/') && github.ref_name || format('{0}-{1}', env.COMMIT_BRANCH, env.COMMIT_SHORT_SHA ) }}
-        uses: docker/build-push-action@v5
-        with:
-          context: .
-          # https://github.com/docker/build-push-action/issues/1026#issue-2041857786
-          build-args: |
-            APP_BUILD_VERSION=${{env.APP_VERSION}}
-          push: ${{ !env.ACT }}
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-          platforms: linux/amd64,linux/arm64
+      - name: Inspect image ghcr
+        if: ${{ vars.GHCR_SLUG != '' }}
+        run: |
+            docker buildx imagetools inspect ${VARS_GHCR_SLUG}:${STEPS_META_OUTPUTS_VERSION}   
+        env:
+          VARS_GHCR_SLUG: ${{ vars.GHCR_SLUG }}
+          STEPS_META_OUTPUTS_VERSION: ${{ steps.meta.outputs.version }}

.github/workflows/testAndSanity.yml

@@ -0,0 +1,66 @@
+name: Tests and Sanity Run
+
+on:
+  workflow_call:
+    inputs:
+      node-version:
+        description: "Node version"
+        required: false
+        default: '20.x'
+        type: string
+      ref:
+        description: "Ref to checkout"
+        required: false
+        type: string
+
+jobs:
+  test:
+    name: Tests / Build / Sanity Run
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@08eba0b27e820071cde6df949e0beb9ba4906955 #v4.3.0
+        with:
+          ref: ${{ inputs.ref }}
+          persist-credentials: false
+      - name: Use Node.js
+        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 #4.4.0
+        with:
+          node-version: ${{ inputs.node-version }}
+          cache: 'npm'
+
+      - name: Install concurrently
+        run: npm install -g concurrently
+
+      - name: Install dev dependencies
+        run: npm run install:parallel
+
+      - name: Test Backend
+        run: npm run test
+
+      - name: Build
+        run: npm run build:parallel
+      
+        # remove modules that might include dev stuff
+        # so that in the next step we are sure that prod-only runs work correctly
+      - name: Install Prod Deps
+        run: |
+          rm -rf node_modules && \
+          rm -rf docsite/node_modules && \
+          NODE_ENV=production npm ci --omit=dev
+
+        # run app for 10 seconds as sanity check to see if it errors for any reason
+        # easy testcase for missing packages and init errors
+      - name: Sanity Run
+        run: |
+          set +e
+          export NODE_ENV=production
+          timeout --preserve-status 10s node node_modules/.bin/tsx src/backend/index.ts
+          exitcode="$?"
+          if [[ "$exitcode" -eq 143 ]] || [[ "$exitcode" -eq 137 ]]; then
+            echo "App stayed up long enough and exited with expected status"
+            exit 0
+          else
+            echo "App exited with unexpected code $exitcode"
+            exit "$exitcode"
+          fi

.gitignore

@@ -118,7 +118,11 @@ dist
 .pnp.*
 
 config/*.json
+config/mscache
+config/yti-*
+config/*.cache
 *.txt
+!robots.txt
 .idea/
 
 src/**/**.js
@@ -133,3 +137,5 @@ flatpak/generated-sources.json
 build
 !setupProxy.js
 **/generated-sources.*
+.github/act/out
+tmp-*

.lnav.config.json

@@ -0,0 +1,28 @@
+{
+    "$schema": "https://lnav.org/schemas/format-v1.schema.json",
+    "error_log": {
+        "title": "Multi-Scrobbler Log",
+        "description": "Logs from Multi Scrobbler",
+        "regex": {
+            "std": {
+                "pattern": "^\\[(?<timestamp>\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2}(?:\\.\\d{3})?)(?:.*?)\\] (?<level>[A-Z]*)  : (?<body>.*)"
+            }
+        },
+        "level-field": "level",
+        "level": {
+            "info": "^(?i)(?:info)$",
+            "debug": "^(?i)(?:debug)$",
+            "error": "^(?i)(error)$",
+            "warning": "^(?i)(warn)$",
+            "trace": "^(?i)verbose$",
+            "critical": "^(?i)(?:crit|Cr)$",
+            "fatal": "^(?i)(?:alert|fatal|panic|Al|Em)$"
+        },
+        "sample": [
+            {
+                "line": "[2024-12-26 01:58:48.261 -0500] DEBUG  : [App] [Sources] [Jellyfin - unnamed] Last activity was at 01:58:48-05:00 | Next check in 10.00s | No new tracks discovered",
+                "level": "debug"
+            }
+        ]
+    }
+}

.mocharc.json

@@ -1,5 +1,10 @@
 {
   "reporter": "dot",
   "extension": "ts",
-  "import": "tsx/esm"
+  "import": "tsx/esm",
+  "spec": "./src/backend/tests/**/*.test.ts",
+  "file": [
+    "./src/backend/tests/setup.ts"
+  ],
+  "exit": true
 }

.vscode/launch.json

@@ -4,9 +4,8 @@
         {
             "name": "dev",
             "type": "node",
-            "runtimeVersion": "18.19.1",
             "request": "launch",
-            // Debug current file in VSCode
+            // Debug app in VSCode
             "program": "${workspaceFolder}/src/backend/index.ts",
             "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
             "console": "integratedTerminal",
@@ -17,10 +16,28 @@
                 "${workspaceFolder}/node_modules/**",
             ],
         },
+        {
+            "name": "dev (ENV Only)",
+            "type": "node",
+            "request": "launch",
+            // Debug app in VSCode
+            "program": "${workspaceFolder}/src/backend/index.ts",
+            "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
+            "console": "integratedTerminal",
+            "envFile": "${workspaceFolder}/.env",
+            "env": {
+                "CONFIG_DIR": "./not-real"
+            },
+            "internalConsoleOptions": "neverOpen",
+            "skipFiles": [
+                "<node_internals>/**",
+                // Ignore all dependencies (optional)
+                "${workspaceFolder}/node_modules/**",
+            ],
+        },
         {
             "name": "tsx",
             "type": "node",
-            "runtimeVersion": "18.19.1",
             "request": "launch",
             // Debug current file in VSCode
             "program": "${file}",
@@ -33,6 +50,25 @@
                 "${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",
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen",
+            "skipFiles": [
+                "<node_internals>/**",
+                // Ignore all dependencies (optional)
+                //"${workspaceFolder}/node_modules/**",
+            ],
+            "resolveSourceMapLocations": [
+                "${workspaceFolder}/src/**/*",
+                "${workspaceFolder}/node_modules/**/*"
+            ]
+        },
         {
             "args": [
                 "-u",
@@ -47,7 +83,6 @@
                 "--recursive",
                 "${workspaceFolder}/src/backend/tests/**/*.test.ts"
             ],
-            "runtimeVersion": "18.19.1",
             "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
             "internalConsoleOptions": "openOnSessionStart",
             "name": "Mocha Tests",
@@ -72,7 +107,6 @@
                 "--config", "${workspaceRoot}/.mocharc.json",
                 "${file}"
             ],
-            "runtimeVersion": "18.19.1",
             "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
             "internalConsoleOptions": "openOnSessionStart",
             "name": "Mocha Test on File",

.vscode/settings.json

@@ -1,5 +1,16 @@
 {
-    "debug.javascript.terminalOptions": {
-        "runtimeVersion": "18.19.1"
-    }
+    "mochaExplorer.require": "tsx/esm",
+    "mochaExplorer.timeout": 1200000,
+    "mochaExplorer.exit": true,
+    "search.exclude": {
+        "**/.docusaurus": true,
+        "**/build": true
+    },
+    "tailwindCSS.files.exclude": [
+        "docsite/**"
+    ],
+    "files.associations": {
+        "*.css": "tailwindcss"
+    },
+    "tailwindCSS.experimental.configFile": "src/client/index.css"
 }

.vscode/tasks.json

@@ -12,6 +12,26 @@
 				"isDefault": true
 			},
 			"label": "tsc: build - src/backend/tsconfig.json"
-		}
+		},
+		{
+			"type": "shell",
+			"label": "compose-up-dev",
+			"command": "docker-compose -f docker-compose.dev.yml up",
+			"presentation": {
+			  "reveal": "always",
+			  "panel": "new"
+			},
+			"problemMatcher": []
+		  },
+		  {
+			"type": "shell",
+			"label": "compose-build-dev",
+			"command": "docker-compose -f docker-compose.dev.yml build",
+			"presentation": {
+				"reveal": "always",
+				"panel": "new"
+			  },
+			  "problemMatcher": []
+		  }
 	]
 }

Dockerfile

@@ -1,7 +1,7 @@
-FROM ghcr.io/linuxserver/baseimage-debian:bookworm as base
+FROM ghcr.io/linuxserver/baseimage-debian:bookworm AS base
 
 ENV TZ=Etc/GMT
-ENV NODE_VERSION 20.11.1
+ENV NODE_VERSION=20.18.1
 
 # borrowing openssl header removal trick from offical docker-node
 # https://github.com/nodejs/docker-node/blob/main/18/bookworm-slim/Dockerfile#L8
@@ -49,6 +49,8 @@ RUN \
 
 RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
 
+RUN npm install -g concurrently
+
 ARG data_dir=/config
 VOLUME $data_dir
 ENV CONFIG_DIR=$data_dir
@@ -57,10 +59,11 @@ COPY docker/root /
 
 WORKDIR /app
 
-FROM base as build
+FROM base AS build
 
 COPY --chown=abc:abc package*.json tsconfig.json ./
 COPY --chown=abc:abc patches ./patches
+COPY --chown=abc:abc docsite/package*.json tsconfig.json ./docsite/
 
 # for debugging, so the build fails faster when timing out (arm64)
 #RUN npm config set fetch-retries 1 && \
@@ -74,21 +77,20 @@ COPY --chown=abc:abc patches ./patches
 
 # This FAILED for node < 20 when building arm64 but not amd64 (and alpine-based Dockerfile has no issues building arm64)
 # see https://github.com/FoxxMD/multi-scrobbler/issues/126
-RUN npm ci \
-    --verbose \
-#   --no-audit \
-    && chown -R root:root node_modules
+RUN npm run install:parallel \
+    && chown -R root:root node_modules \
+    && chown -R root:root docsite/node_modules
 
 COPY --chown=abc:abc . /app
 
 # need to set before build so server/client build is optimized and has constants (if needed)
 ENV NODE_ENV=production
 
-RUN npm run docs:install && npm run build && rm -rf node_modules && rm -rf docsite/node_modules
+RUN npm run build:parallel && rm -rf node_modules && rm -rf docsite/node_modules
 
-FROM base as app
+FROM base AS app
 
-COPY --chown=abc:abc package*.json ./
+COPY --chown=abc:abc *.json *.js *.ts index.html ./
 COPY --chown=abc:abc patches ./patches
 COPY --from=build --chown=abc:abc /app/dist /app/dist
 COPY --from=build --chown=abc:abc /app/src /app/src
@@ -103,11 +105,11 @@ ENV IS_DOCKER=true
 ARG APP_BUILD_VERSION
 ENV APP_VERSION=$APP_BUILD_VERSION
 
-RUN npm ci --omit=dev \
+RUN npm ci --omit=dev --no-audit \
     && npm cache clean --force \
     && chown -R abc:abc node_modules \
-    && rm -rf node_modules/@types \
-              /root/.cache
+    && rm -rf /root/.cache
+
 
 ARG webPort=9078
 ENV PORT=$webPort

README.md

@@ -9,40 +9,53 @@
 <img src="/assets/icon.png" align="right"
 alt="multi-scrobbler logo" width="180" height="180">
 
-A javascript app to scrobble music you listened to, to [Maloja](https://github.com/krateng/maloja), [Last.fm](https://www.last.fm), and [ListenBrainz](https://listenbrainz.org)
+A javascript app to scrobble music you listen to, to [Maloja](https://github.com/krateng/maloja), [Last.fm](https://www.last.fm), [ListenBrainz](https://listenbrainz.org), and other services.
 
-* Supports scrobbling from many **Sources**
-  * [Spotify](https://foxxmd.github.io/multi-scrobbler/docs/configuration#spotify)
-  * [Plex](https://foxxmd.github.io/multi-scrobbler/docs/configuration#plex) or [Tautulli](https://foxxmd.github.io/multi-scrobbler/docs/configuration#tautulli)
-  * [Subsonic-compatible APIs](https://foxxmd.github.io/multi-scrobbler/docs/configuration#subsonic) (like [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/))
-  * [Jellyfin](https://foxxmd.github.io/multi-scrobbler/docs/configuration#jellyfin)
-  * [WebScrobbler](https://foxxmd.github.io/multi-scrobbler/docs/configuration#webscrobbler)
-  * [Youtube Music](https://foxxmd.github.io/multi-scrobbler/docs/configuration#youtube-music)
-  * [Last.fm](https://foxxmd.github.io/multi-scrobbler/docs/configuration#lastfm-source)
-  * [ListenBrainz](https://foxxmd.github.io/multi-scrobbler/docs/configuration#listenbrainz-source)
-  * [~~Deezer~~](https://foxxmd.github.io/multi-scrobbler/docs/configuration#deezer)
-  * [MPRIS (Linux Desktop)](https://foxxmd.github.io/multi-scrobbler/docs/configuration#mpris)
-  * [Mopidy](https://foxxmd.github.io/multi-scrobbler/docs/configuration#mopidy)
-  * [JRiver](https://foxxmd.github.io/multi-scrobbler/docs/configuration#jriver)
-  * [Kodi](https://foxxmd.github.io/multi-scrobbler/docs/configuration#kodi)
-  * [Google Cast (Chromecast)](https://foxxmd.github.io/multi-scrobbler/docs/configuration#google-cast-chromecast)
-  * [Musikcube](https://foxxmd.github.io/multi-scrobbler/docs/configuration#muikcube)
-  * [MPD (Music Player Daemon)](https://foxxmd.github.io/multi-scrobbler/docs/configuration#mpd-music-player-daemon)
-  * [VLC](https://foxxmd.github.io/multi-scrobbler/docs/configuration#vlc)
-* Supports scrobbling to many **Clients**
-  * [Maloja](https://foxxmd.github.io/multi-scrobbler/docs/configuration#maloja)
-  * [Last.fm](https://foxxmd.github.io/multi-scrobbler/docs/configuration#lastfm)
-  * [ListenBrainz](https://foxxmd.github.io/multi-scrobbler/docs/configuration#listenbrainz)
-* Monitor status of Sources and Clients using [webhooks (Gotify, Ntfy, Apprise)](https://foxxmd.github.io/multi-scrobbler/docs/configuration#webhook-configurations) or [healthcheck endpoint](https://foxxmd.github.io/multi-scrobbler/docs/configuration#health-endpoint)
+* Supports scrobbling from many [**Sources**](https://foxxmd.github.io/multi-scrobbler/configuration/sources)
+    * [Azuracast](https://foxxmd.github.io/multi-scrobbler/configuration/sources/azuracast)
+    * [Deezer](https://foxxmd.github.io/multi-scrobbler/configuration/sources/deezer)
+    * [Google Cast (Chromecast)](https://foxxmd.github.io/multi-scrobbler/configuration/sources/google-cast)
+    * [Icecast](https://foxxmd.github.io/multi-scrobbler/configuration/sources/icecast)
+    * [Jellyfin](https://foxxmd.github.io/multi-scrobbler/configuration/sources/jellyfin)
+    * [JRiver](https://foxxmd.github.io/multi-scrobbler/configuration/sources/jriver)
+    * [Kodi](https://foxxmd.github.io/multi-scrobbler/configuration/sources/kodi)
+    * [Koito](https://foxxmd.github.io/multi-scrobbler/configuration/sources/koito-source)
+    * [Last.fm](https://foxxmd.github.io/multi-scrobbler/configuration/sources/lastfm-source)
+    * [Last.fm (Endpoint)](https://foxxmd.github.io/multi-scrobbler/configuration/sources/lastfm-endpoint)
+    * [ListenBrainz](https://foxxmd.github.io/multi-scrobbler/configuration/sources/listenbrainz-source)
+    * [ListenBrainz (Endpoint)](https://foxxmd.github.io/multi-scrobbler/configuration/sources/listenbrainz-endpoint)
+    * [Maloja](https://foxxmd.github.io/multi-scrobbler/configuration/sources/maloja)
+    * [Mopidy](https://foxxmd.github.io/multi-scrobbler/configuration/sources/mopidy)
+    * [MPD (Music Player Daemon)](https://foxxmd.github.io/multi-scrobbler/configuration/sources/mpd)
+    * [MPRIS (Linux Desktop)](https://foxxmd.github.io/multi-scrobbler/configuration/sources/mpris)
+    * [Musikcube](https://foxxmd.github.io/multi-scrobbler/configuration/sources/musikcube)
+    * [Plex](https://foxxmd.github.io/multi-scrobbler/configuration/sources/plex)
+    * [Rocksky](https://foxxmd.github.io/multi-scrobbler/configuration/sources/rocksky-source)
+    * [Spotify](https://foxxmd.github.io/multi-scrobbler/configuration/sources/spotify)
+    * [Subsonic-compatible APIs](https://foxxmd.github.io/multi-scrobbler/configuration/sources/subsonic) (like [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/))
+    * [teal.fm](https://foxxmd.github.io/multi-scrobbler/configuration/sources/tealfm-source)
+    * [WebScrobbler](https://foxxmd.github.io/multi-scrobbler/configuration/sources/webscrobbler)
+    * [VLC](https://foxxmd.github.io/multi-scrobbler/configuration/sources/vlc)
+    * [Yamaha MusicCast](https://foxxmd.github.io/multi-scrobbler/configuration/sources/yamaha-musiccast)
+    * [Youtube Music](https://foxxmd.github.io/multi-scrobbler/configuration/sources/youtube-music)
+* Supports scrobbling to many [**Clients**](https://foxxmd.github.io/multi-scrobbler/configuration/clients)
+    * [Koito](https://foxxmd.github.io/multi-scrobbler/configuration/clients/koito)
+    * [Last.fm](https://foxxmd.github.io/multi-scrobbler/configuration/clients/lastfm)
+    * [ListenBrainz](https://foxxmd.github.io/multi-scrobbler/configuration/clients/listenbrainz)
+    * [Maloja](https://foxxmd.github.io/multi-scrobbler/configuration/clients/maloja)
+    * [Rocksky](https://foxxmd.github.io/multi-scrobbler/configuration/clients/rocksky)
+    * [teal.fm](https://foxxmd.github.io/multi-scrobbler/configuration/clients/tealfm)
+* Monitor status of Sources and Clients using [webhooks (Gotify, Ntfy, Apprise)](https://foxxmd.github.io/multi-scrobbler/configuration#webhook-configurations) or [healthcheck endpoint](https://foxxmd.github.io/multi-scrobbler/configuration#health-endpoint)
+* Supports [Now Playing](https://foxxmd.github.io/multi-scrobbler/configuration/clients#now-playing) for scrobble Clients
 * Supports configuring for single or multiple users (scrobbling for your friends and family!)
 * Web server interface for stats, basic control, and detailed logs
 * Graceful network and client failure handling (queued scrobbles that auto-retry)
 * Smart handling of credentials (persistent, authorization through app)
-* Easy configuration through ENVs or JSON
-* Modify data before scrobbling with [regular expression or search patterns](https://foxxmd.github.io/multi-scrobbler/docs/transforms)
-* Install using [Docker images for x86/ARM](https://foxxmd.github.io/multi-scrobbler/docs/installation#docker), [flatpak](https://foxxmd.github.io/multi-scrobbler/docs/installationr#flatpak), or [locally with NodeJS](https://foxxmd.github.io/multi-scrobbler/docs/installation#nodejs)
+* Easy configuration through [ENVs or JSON](ttps://foxxmd.github.io/multi-scrobbler/configuration#configuration-types)
+* Modify data before scrobbling with [regular expression or search patterns](https://foxxmd.github.io/multi-scrobbler/configuration/transforms)
+* Install using [Docker images for x86/ARM](https://foxxmd.github.io/multi-scrobbler/installation#docker) or [locally with NodeJS](https://foxxmd.github.io/multi-scrobbler/installation#nodejs)
 
-[**Quick Start Guide**](https://foxxmd.github.io/multi-scrobbler/docs/quickstart)
+[**Quick Start Guide**](https://foxxmd.github.io/multi-scrobbler//quickstart)
 
 <img src="/assets/status-ui.png" width="800">
 
@@ -55,15 +68,15 @@ A javascript app to scrobble music you listened to, to [Maloja](https://github.c
 
 **But I already scrobble my music to Last.fm/ListenBrainz, is multi-scrobbler for me?**
 
-Yes! You can use [Last.fm as a **Source**](https://foxxmd.github.io/multi-scrobbler/docs/configuration#lastfm-source) or [Listenbrainz as a **Source**](https://foxxmd.github.io/multi-scrobbler/docs/configuration#listenbrainz-source) to forward scrobbles from your profile to any other Client! That way you can keep your current scrobble setup as-is but still get the benefit of capturing your data to a self-hosted location.
+Yes! You can use [Last.fm as a **Source**](https://foxxmd.github.io/multi-scrobbler/configuration/sources/lastfm-source) or [Listenbrainz as a **Source**](https://foxxmd.github.io/multi-scrobbler/configuration/sources/listenbrainz-source) to forward scrobbles from your profile to any other Client! That way you can keep your current scrobble setup as-is but still get the benefit of capturing your data to a self-hosted location.
 
 ## How Does multi-scrobbler (MS) Work?
 
-You set up configurations for one or more **Sources** and one or more **Clients**. MS monitors all of your configured **Sources**. When new tracks are played by a Source it grabs that information and then sends it (scrobbles it) to all **Clients** that Source is configured to scrobble to.
+You set up [configurations](https://foxxmd.github.io/multi-scrobbler/configuration) for one or more [**Sources**](https://foxxmd.github.io/multi-scrobbler/configuration/sources) and one or more [**Clients**](https://foxxmd.github.io/multi-scrobbler/configuration/clients). MS monitors all of your configured **Sources**. When new tracks are played by a Source MS grabs that information and then sends it (scrobbles it) to all **Clients** that Source is configured to forward to.
 
 ### Source
 
-A **Source** is a data source that contains information about tracks you are playing like a music player or platform. Examples are **Spotify, Jellyfin, Plex, Youtube Music, Airsonic**, etc...
+A [**Source**](https://foxxmd.github.io/multi-scrobbler/configuration/sources) is a data source that contains information about music you are playing or have listened to, like a desktop player, web music player, or cloud music service. Examples are **Spotify, Jellyfin, Plex, Youtube Music, Navidrome**, etc...
 
 Source configurations consist of:
 
@@ -73,7 +86,7 @@ Source configurations consist of:
 
 ### Client
 
-A **Client** is an application that stores the historical information about what songs you have played (scrobbles). Examples are **Maloja, Last.fm, Listenbrainz**...
+A [**Client**](https://foxxmd.github.io/multi-scrobbler/configuration/clients) is an application that stores the historical information about what music you have played (scrobbles). Examples are **Maloja, Last.fm, Listenbrainz**...
 
 Client configurations consist of:
 
@@ -82,15 +95,15 @@ Client configurations consist of:
 
 ## Quick Start
 
-[See the **Quick Start Guide**](https://foxxmd.github.io/multi-scrobbler/docs/quickstart)
+[See the **Quick Start Guide**](https://foxxmd.github.io/multi-scrobbler/quickstart)
 
 ## Installation
 
-[See the **Installation** documentation](https://foxxmd.github.io/multi-scrobbler/docs/installation)
+[See the **Installation** documentation](https://foxxmd.github.io/multi-scrobbler/installation)
 
 ## Configuration
 
-[See the **Configuration** documentation](https://foxxmd.github.io/multi-scrobbler/docs/configuration)
+[See the **Configuration** documentation](https://foxxmd.github.io/multi-scrobbler/configuration)
 
 ## Usage
 
@@ -105,11 +118,11 @@ On first startup you may need to authorize Spotify and/or Last.fm by visiting th
 
 ## Help/FAQ
 
-Having issues with connections or configuration? Check the [FAQ](https://foxxmd.github.io/multi-scrobbler/docs/FAQ) before creating an issue!
+Having issues with connections or configuration? Check the [FAQ](https://foxxmd.github.io/multi-scrobbler/FAQ) before creating an issue!
 
 ## Development
 
-[Detailed architecture and development guides for Sources/Clients](https://foxxmd.github.io/multi-scrobbler/docs/development/dev-common)
+[Detailed architecture and development guides for Sources/Clients](https://foxxmd.github.io/multi-scrobbler/development/dev-common)
 
 ## License
 

config/azuracast.json.example

@@ -0,0 +1,13 @@
+[
+  {
+    "type": "azuracast",
+    "enable": true,
+    "name": "azura",
+    "data": {
+      "url": "ws://192.168.0.101",
+      "station": "my-station-name",
+      "monitorWhenLive": true,
+      "monitorWhenListeners": 1
+    }
+  }
+]

config/deezer-deprecated.json.example

@@ -0,0 +1,13 @@
+[
+  {
+    "name": "DeezerOfficalDeprecated",
+    "enable": true,
+    "clients": [],
+    "data": {
+      "clientId": "a89cba1569901a0671d5a9875fed4be1",
+      "clientSecret": "ec42e09d5ae0ee0f0816ca151008412a",
+      "redirectUri": "http://localhost:9078/deezer/callback",
+      "interval": 60
+    }
+  }
+]

config/deezer.json.example

@@ -1,13 +1,10 @@
 [
   {
-    "name": "FoxxMDeezer",
+    "name": "DeezerARL",
     "enable": true,
     "clients": [],
     "data": {
-      "clientId": "a89cba1569901a0671d5a9875fed4be1",
-      "clientSecret": "ec42e09d5ae0ee0f0816ca151008412a",
-      "redirectUri": "http://localhost:9078/deezer/callback",
-      "interval": 60
+      "arl": "UOsRPjT3U5Dhaaup3xQ30DWFoSgqugdSYzL3QE743waaVy2eur2ckyJcZ4RV123Q3PsbKXkLwA6ahc9XmEfev6BtfSP8LujE3JswWRQogZCDUOwVzWO5sAig",
     }
   }
 ]

config/endpointlfm.json.example

@@ -0,0 +1,9 @@
+[
+  {
+    "name": "myLfm",
+    "enable": true,
+    "data": {
+      "slug": "mySlug"
+    }
+  }
+]

config/endpointlz.json.example

@@ -0,0 +1,9 @@
+[
+  {
+    "name": "myLz",
+    "enable": true,
+    "data": {
+      "token": "myToken"
+    }
+  }
+]

config/icecast.json.example

@@ -0,0 +1,10 @@
+[
+    {
+      "name": "myIcy",
+      "enable": true,
+      "data": {
+        "url": "http://myIcecast.com/radio"
+      }
+    }
+  ]
+  

config/jellyfin.json.example

@@ -7,12 +7,19 @@
       "url": "http://localhost:8096",
       "user": "FoxxMD",
       "apiKey": "c9fae8756fbf481ebd9c5bb56bd6540c",
-      "usersAllowed": ["FoxxMD","SomeOtherUser"],
-      "usersBlocked": ["AnotherUser"],
-      "devicesAllowed": ["firefox"],
-      "devicesBlocked": ["google-home"]
+
+      // everything below is optional
+      "usersAllow": ["FoxxMD","SomeOtherUser"],
+      "usersBlock": ["AnotherUser"],
+      "devicesAllow": ["firefox"],
+      "devicesBlock": ["google-home"],
+      "librariesAllow": ["GoodMusic"],
+      "librariesBlock": ["BadMusic"],
+      "additionalAllowedLibraryTypes": ["musicvideos"],
+      "allowUnknown": false,
     },
     "options": {
+      "logPayload": true,
       "logFilterFailure": "debug"
     }
   }

config/koito.json.example

@@ -0,0 +1,20 @@
+[
+      {
+    "name": "koito-client",
+    "configureAs": "client",
+    "data": {
+      "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
+      "username": "admin",
+      "url": "http://192.168.0.100:4110" 
+    }
+  },
+  {
+    "name": "koito-source",
+    "configureAs": "source",
+    "data": {
+      "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
+      "username": "admin",
+      "url": "http://192.168.0.100:4110" 
+    }
+  }
+]

config/lastfm.json.example

@@ -1,6 +1,6 @@
 [
   {
-    "name": "myLastFm",
+    "name": "myLastFmClient",
     "enable": true,
     "configureAs": "client",
     "data": {
@@ -8,5 +8,15 @@
       "secret": "ec42e09d5ae0ee0f0816ca151008412a",
       "redirectUri": "http://localhost:9078/lastfm/callback"
     }
+  },
+  {
+    "name": "myLastFmSource",
+    "enable": true,
+    "configureAs": "source",
+    "data": {
+      "apiKey": "a89cba1569901a0671d5a9875fed4be1",
+      "secret": "ec42e09d5ae0ee0f0816ca151008412a",
+      "redirectUri": "http://localhost:9078/lastfm/callback"
+    }
   }
 ]

config/listenbrainz.json.example

@@ -1,11 +1,22 @@
 [
   {
-    "name": "brainz",
+    "name": "brainzClient",
     "enable": true,
     "configureAs": "client",
     "data": {
       "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
-      "username": "FoxxMD"
+      "username": "FoxxMD",
+      "url": "https://api.listenbrainz.org"
+    }
+  },
+  {
+    "name": "brainzSource",
+    "enable": true,
+    "configureAs": "source",
+    "data": {
+      "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
+      "username": "FoxxMD",
+      "url": "https://api.listenbrainz.org"
     }
   }
 ]

config/maloja.json.example

@@ -1,7 +1,17 @@
 [
   {
-    "name": "myMaloja",
+    "name": "myMaloja-client",
     "enable": true,
+    "configureAs": "client",
+    "data": {
+      "url": "http://localhost:42010",
+      "apiKey": "myMalojaKey"
+    }
+  },
+    {
+    "name": "myMaloja-source",
+    "enable": true,
+    "configureAs": "source",
     "data": {
       "url": "http://localhost:42010",
       "apiKey": "myMalojaKey"

config/musiccast.json.example

@@ -0,0 +1,9 @@
+[
+  {
+    "name": "myYamaha",
+    "enable": true,
+    "data": {
+      "url": "192.168.0.101"
+    }
+  }
+]

config/plex.json.example

@@ -1,15 +1,22 @@
 [
   {
-    "name": "MyPlex",
+    "name": "MyPlexApi",
     "enable": true,
     "clients": [],
     "data": {
-      "user": ["username@gmail.com","anotherUser@gmail.com"],
-      "libraries": ["music","my podcasts"],
-      "servers": ["myServer","anotherServer"],
-      "options": {
-        "logFilterFailure": "warn"
+      "token": "1234",
+      "url": "http://192.168.0.120:32400",
+      "usersAllow": ["FoxxMD","SomeOtherUser"],
+      "usersBlock": ["AnotherUser"],
+      "devicesAllow": ["firefox"],
+      "devicesBlock": ["google-home"],
+      "librariesAllow": ["GoodMusic"],
+      "librariesBlock": ["BadMusic"]
+    },
+    "options": {
+      "logPayload": true,
+      "logFilterFailure": "debug",
+      "ignoreInvalidCert": "false"
       }
-    }
   }
 ]

config/plex.webhook.json.example

@@ -0,0 +1,17 @@
+[
+  // DEPRECATED, use API Source instead
+  // rename files to plex.json to use
+  {
+    "name": "MyPlex",
+    "enable": true,
+    "clients": [],
+    "data": {
+      "user": ["username@gmail.com","anotherUser@gmail.com"],
+      "libraries": ["music","my podcasts"],
+      "servers": ["myServer","anotherServer"],
+      "options": {
+        "logFilterFailure": "warn"
+      }
+    }
+  }
+]

config/rocksky.json.example

@@ -0,0 +1,18 @@
+[
+    {
+    "name": "myRockskyClient",
+    "configureAs": "client",
+    "data": {
+      "key": "7cdr86vis3mpq5b1pi01md0hkm7ykzzxjy81r",
+      "handle": "alice.bsky.social"
+    }
+  },
+  {
+    "name": "myRockskySource",
+    "configureAs": "source",
+    "data": {
+      "key": "e4xwktm7jxm607x8el1fcda30eu14dzb64h3j",
+      "handle": "alice.bsky.social"
+    }
+  }
+]

config/subsonic.json.example

@@ -5,7 +5,8 @@
     "data": {
       "url": "http://localhost:4040/airsonic",
       "user": "yourUser",
-      "password": "yourPassword"
+      "password": "yourPassword",
+      "usersAllow": ["yourUser"]
     }
   }
 ]

config/tealfm.json.example

@@ -0,0 +1,18 @@
+[
+    {
+        "name": "myTeal",
+        "configureAs": "client",
+        "data": {
+            "identifier": "alice.bsky.social",
+            "appPassword": "twog-phu7-4dhe-y4j3"
+        }
+    },
+        {
+        "name": "myTealSource",
+        "configureAs": "source",
+        "data": {
+            "identifier": "alice.bsky.social",
+            "appPassword": "twog-phu7-4dhe-y4j3"
+        }
+    }
+]

config/webscrobbler.json.example

@@ -2,7 +2,7 @@
   {
     "name": "MyWebScrobbler",
     "data": {
-      "slug": null,
+      "slug": "MyOptionalSlug",
       "whitelist": [],
       "blacklist": []
     }

config/ytmusic.json.example

@@ -4,8 +4,16 @@
     "enable": true,
     "clients": [],
     "data": {
-      "cookie": "VISITOR_INFO1_LIVE=jMDXz2_L8rY; __Secure-3PAPISID=3AxsXpSXGqOInSDn1jEKn; DEVICE_INFO=ChxOekU0TmTBpjek5EWZ0G; YSC=7gZdl3Zdl3; SID=TwhNsaZRXYTAtXxzGyu6rZdpg2HvGROeW8J4Ym_FhkhoZMUYEQ.; __Secure-1PSID=TwhNOsaZRXYTyRBe4rxAtXRIKsIEtk_Qot2VLBNfHQrQ.; __Secure-3PSID=ZRXYTAtXRIKsIEtk_Qot2yRBerZdpg2HvvZRXYTAtXRIKsIEtk_Qot2yRBerkuZICFQ.; HSID=A1UMmELW79; SSID=AKhomOs; APISID=IlHHmuzkPdQzZZDhHn3; SAPISID=3AxsXpy0u75Qb/n1jEKn; __Secure-1PAPISID=3AxsXpQb/AkSDn1jEKn; LOGIN_INFO=AFmP6vFpyVCZZAIgDwbkhWMBBhluaIWAPP:QUQ314UW5NWMjNmd2ZUJnYnJsakdIMjZoaE5zVVMjNmd2ZZUiHRlb3ZlV3ZIcUVyRVIMjNmdjNmd2ZZUivYlNqX2ZNZUiHdUNFNFdaYmJIW1NkJRX3hqdlU2YnFESkFuSS1uTldnZVRmLXNjWFc5OUJuR3dTd3JsZGZYa2EtZFQ2a0k2Ry1KQQ==; PREF=volume=26; SIDCC=AFvI_94PxXwls-ndqpGfPgFX3FWj80y_94PxXwls-ndqfSh15sP; __Secure-1PSIDCC=AFvIBnUbRr96I96UCIp2U4T8HRVk2B0HfKzhzxwsiP; __Secure-3PSIDCC=AFvIB3bINuUN0ETDR9gO91wpwWIVmpGki3BxT3bINuUN0ETDR9gO91wCH",
-      "authUser": "0"
+      "cookie": "__Secure-1PSIDTS=sidts-CjEB3EgAEvCd-......",
+      // either cookie or id/secret needs to be provided
+      "clientId": "891098404....apps.googleusercontent.com",
+      "clientSecret": "GOCS..."
+
+      // optional
+      //"redirectUri": "http://my.custom.tld/api/ytmusic/callback?name=MyYTMusic"
+    },
+    "options": {
+      "logDiff": true
     }
   }
 ]

docker-compose.dev.yml

@@ -0,0 +1,29 @@
+version: '3.7'
+
+services:
+  multi-scrobbler:
+    build:
+      context: .
+    env_file:
+      - path: ./.env
+        required: false
+    #environment:
+      #- TZ=Etc/GMT # Specify timezone from TZ Database name found here https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+      #- SPOTIFY_CLIENT_ID=
+      #- SPOTIFY_CLIENT_SECRET=
+      #- SPOTIFY_REDIRECT_URI=http://multi-scrobbler-host-IP:9078/callback ## Need to be whitelisted in Spotify dashboard and is used for creating the connection first time
+      #- MALOJA_URL=http://maloja:42010
+      #- MALOJA_API_KEY=
+      #- PUID=1000 # required if running docker on linux host, see main README Docker setup instructions
+      #- PGID=1000 # required if running docker on linux host, see main README Docker setup instructions
+
+      # set if using a source/client with redirect URI that you have not explicitly set and MS is NOT running on the same machine that you will view the dashboard from
+      # EX: You will view MS dashboard at 'http://192.168.0.101:9078' -> set BASE_URL=http://192.168.0.101:9078
+      #- BASE_URL=http://MyHostIP:9078
+    volumes:
+      - "./config:/config"
+    #networks:
+    #  - (optional to add container to the same bridge network that maloja is inside to be able to use docker internal networking & dns to resolve and connect to maloja URL via http://maloja:port)
+    ports:
+      - 9078:9078 # first port is the HOST port multi-scrobbler will serve UI and API on
+    restart: unless-stopped

docker-compose.yml

@@ -1,14 +1,12 @@
-version: '3.7'
-
 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_CLIENT_ID=
-      #- SPOTIFY_CLIENT_SECRET=
-      #- SPOTIFY_REDIRECT_URI=http://multi-scrobbler-host-IP:9078/callback ## Need to be whitelisted in Spotify dashboard and is used for creating the connection first time
+      #- JELLYFIN_APIKEY=
+      #- JELLYFIN_URL=
+      #- JELLYFIN_USER=
       #- MALOJA_URL=http://maloja:42010
       #- MALOJA_API_KEY=
       #- PUID=1000 # required if running docker on linux host, see main README Docker setup instructions
@@ -18,7 +16,7 @@ services:
       # EX: You will view MS dashboard at 'http://192.168.0.101:9078' -> set BASE_URL=http://192.168.0.101:9078
       #- BASE_URL=http://MyHostIP:9078
     volumes:
-      - /path_on_host/multi-scrobbler-config:/config
+      - "./config:/config"
     #networks:
     #  - (optional to add container to the same bridge network that maloja is inside to be able to use docker internal networking & dns to resolve and connect to maloja URL via http://maloja:port)
     ports:

docsite/babel.config.js

@@ -1,3 +0,0 @@
-module.exports = {
-  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
-};

docsite/docs/FAQ.md

@@ -5,22 +5,21 @@ toc_max_heading_level: 5
 
 ## Connection Issues
 
-### Plex/Tautulli/Jellyfin/Webscrobbler don't connect
+### Webscrobbler/Listenbrainz Endpoint doesn't connect {#ingress-connection}
 
-These sources are **ingress-based** which means that multi-scrobbler waits for the Plex/Tautulli/Jellyfin server (or Webscrobbler extension) to contact multi-scrobbler, as opposed to multi-scrobbler contacting them.
+These sources are **ingress-based** which means that multi-scrobbler waits for the Webscrobbler extension or app using Listenbrainz Endpoint to contact multi-scrobbler, as opposed to multi-scrobbler contacting them.
 
 multi-scrobbler will log information about any server that connects to it for these services. In the logs it looks something like this:
 
 ```
-2023-02-22T10:55:56-05:00 info   : [Ingress - Plex  ] Received request from a new remote address: ::ffff:192.168.0.140 (UA: PlexMediaServer/1.24.5.5173-8dcc73a59)
-2023-02-22T10:55:56-05:00 info   : [Ingress - Plex  ] ::ffff:192.168.0.140 (UA: PlexMediaServer/1.24.5.5173-8dcc73a59) Received valid data from server examplePlex for the first time.
-2023-02-22T10:55:56-05:00 warn   : [Plex Request    ] Received valid Plex webhook payload but no Plex sources are configured
+[2025-07-10 12:32:21.417 -0400] INFO   : [App] [API] [Ingress] [WebScrobbler] [Ingress] [WebScrobbler] Received request from a new remote address: ::ffff:127.0.0.1 (192.168.0.100) (UA: Mozilla/5.0 (X11; Linux x86_64; rv:139.0) Gecko/20100101 Firefox/139.0)
+[2025-07-10 12:32:21.418 -0400] INFO   : [App] [API] [Ingress] [WebScrobbler] [Ingress] [WebScrobbler] ::ffff:127.0.0.1 (192.168.0.100) (UA: Mozilla/5.0 (X11; Linux x86_64; rv:139.0) Gecko/20100101 Firefox/139.0) Received data for API URL slug '(none)' for the first time.
 ```
 It also logs if a server tries to connect to a URL that it does not recognize:
 ```
-2023-02-22T11:16:12-05:00 debug  : [App             ] Server received POST request from ::ffff:192.168.0.140 (UA: PlexMediaServer/1.24.5.5173-8dcc73a59) to unknown route: /plkex
+2023-02-22T11:16:12-05:00 debug  : [App             ] Server received POST request from ::ffff:192.168.0.100 (UA: PlexMediaServer/1.24.5.5173-8dcc73a59) to unknown route: /plkex
 ```
-**So, if you do not see either of these in your logs then Plex/Tautulli/Jellyfin/Webscrobbler is not able to connect to your multi-scrobbler instance at all.**
+**So, if you do not see either of these in your logs then the Source is not able to connect to your multi-scrobbler instance at all.**
 
 This is not something multi-scrobbler can fix and means you have an issue in your network.
 
@@ -30,18 +29,13 @@ Check or try all these steps before submitting an issue:
 
 ##### Turn on Debug Logging
 
-First, turn on **debug** logging for multi-scrobbler by setting the environmental variable `LOG_LEVEL=debug`:
-
-* using node `LOG_LEVEL=debug ... node src/index.js`
-* using docker `docker run -e LOG_LEVEL=debug ... foxxmd/multi-scrobbler`
-
-Check the output for any additional information.
+First, turn on **debug** logging for multi-scrobbler by setting the environmental variable `DEBUG_MODE=true`. Then, check the output for any additional information.
 
 ##### Check Host name and URL
 
-The URLs examples in the [configuration](configuration/configuration.mdx) documentation assume you are running Plex/Tautulli/Jellyfin/Webscrobbler on the same server as multi-scrobbler. If these are not the same machine then you need to determine the IP address or domain name that multi-scrobbler is reachable at and use that instead of `localhost` when configuring these sources. **This is likely the same host name that you would use to access the web interface for multi-scrobbler.**
+The URLs examples in the [configuration](/configuration#base-url) documentation assume you are running Webscrobbler/LFM Endpoint on the same server as multi-scrobbler. If these are not the same machine then you need to determine the IP address or domain name that multi-scrobbler is reachable at and use that instead of `localhost` when configuring these sources. **This is likely the same host name that you would use to access the web interface for multi-scrobbler.**
 
-EX `http://localhost:9078/plex` -> `http://192.168.0.140:9078/plex`
+EX `http://localhost:9078/api/webscrobbler` -> `http://192.168.0.140:9078/api/webscrobbler`
 
 ##### Check Firewall and Port Forwarding
 
@@ -49,68 +43,10 @@ If the machine multi-scrobbler is running on has a firewall ensure that port **9
 
 ##### Check Source Service Logs
 
-Plex/Tautulli/Jellyfin all have logs that will log if they cannot connect to multi-scrobbler. Check these for further information.
-
-###### Plex
-
-Settings -> Manage -> Console
-
-###### Tautulli
-
-Check the command-line output of the application or docker logs.
-
-###### Jellyfin
-
-Administration -> Dashboard -> Advanced -> Logs
-
 ###### Webscrobbler
 
 See [Debugging the extension](https://github.com/web-scrobbler/web-scrobbler/wiki/Debug-the-extension) to get logs which should have information about failed requests.
 
-### Jellyfin has warnings about undefined or missing data
-
-Make sure you have 
-* [Configured the webhook plugin correctly](configuration/configuration.mdx#jellyfin)
-  * Checked the **Send All Properties(ignores template)** option in the webhook settings and **Saved**
-
-multi-scrobbler is known to work on Jellyfin `10.8.9` with Webhook version `11.0.0.0`.
-
-You can verify the payload sent from the webhook by modifying your jellyfin configuration to include `logPayload: true` which will output the raw payload to DEBUG level logging:
-
-```json
-[
-  {
-    "name": "MyJellyfin",
-    "clients": [],
-    "data": {
-      "users": ["FoxxMD"]
-    },
-    "options": {
-      "logPayload": true
-    }
-  }
-]
-```
-
-If your issue persists and you open an Issue for it please include the raw payload logs in your report.
-
-### Jellyfin has warnings about missing headers
-
-If you experience issues trying to scrobble with Jellyfin and find this in your MS logs
-
-```
-[API] Jellyfin is not sending a request with valid headers...
-```
-
-A workaround that may fix this:
-
-* In Webhook settings:
-  * [In the webhook you have already configured...](configuration/configuration.mdx#jellyfin)
-    * Add Request Header...
-      * **Key:** `Content-Type`
-      * **Value:** `application/json`
-  * Then Save
-
 ### Spotify/Deezer/LastFM won't authenticate
 
 Ensure any **client id** or **secrets** are correct in your configuration.
@@ -124,21 +60,27 @@ If multi-scrobbler is not running on the same machine your browser is on then th
 
 EX `http://localhost:9078/lastfm/callback` -> `http://192.168.0.220:9078/lastfm/callback`
 
-### Deezer is not working
-
-Deezer has discontinued support for their API and the Deezer Source is now [**deprecated.**](configuration/configuration.mdx#deezer) See [this issue for more discussion.](https://github.com/FoxxMD/multi-scrobbler/issues/175#issuecomment-2296776625)
-
 ### Youtube Music fails after some time
 
-The Youtube Music library relies on scraping the YTM site (pretending to be a browser) by using cookies/auth from your actual browser. It does its best to keep these up to date but since this is not an official way to access the service YTM may invalidate your access _to the authenticated session_ at any time. How this is triggered is unknown and not something multi-scrobbler can control.
-
 If you see errors in multi-scrobbler for YTM that contain **401** or **403** like
 
 ```
 Error: Could not send the specified request to browse. Status code: 401
 ```
 
-then YTM has invalidated your access. [Follow the YTM instructions to retrieve a new set of cookies for multi-scrobbler](configuration/configuration.mdx#youtube-music) and then restart MS to potentially resolve the problem. See [this issue](https://github.com/FoxxMD/multi-scrobbler/issues/158) for further discussion of the problem.
+then YTM has invalidated your authentication.
+
+First, ensure you are NOT using [YoutubeTV authentication.](/configuration/sources/youtube-music?ytmAuth=ytt#authentication) If you completed authentication by entering a "User Code" you are using YoutubeTV which has stopped working. You should reauthenticate using **Cookies** or **Custom OAuth.**
+
+#### When using OAuth Client Authentication
+
+Refresh your authentication by using the **(Re)authenticate** link from MS's web dashboard.
+
+#### When using Cookies Authentication
+
+The library MS uses relies on scraping the YTM site by using cookies from your actual browser to pretend it is a browser. It does its best to keep these up to date but since this is not an official way to access the service YTM may invalidate your access _to the authenticated session_ at any time. How this is triggered is unknown and not something multi-scrobbler can control. You can help limit the chance of your session being invalidated by [getting the cookie from an Incognito/Private Session](https://github.com/LuanRT/YouTube.js/issues/803#issuecomment-2504032666) and then immediately closing the browser afterwards.
+
+To re-authenticate MS [follow the YTM instructions to retrieve a new set of cookies for multi-scrobbler](/configuration/sources/youtube-music?ytmAuth=cookie#authentication) and then restart MS to potentially resolve the problem.
 
 ## Configuration Issues
 
@@ -162,15 +104,11 @@ This is a limitation of the [Last.fm API](https://www.last.fm/api/show/track.scr
 
 Multi-scrobbler works the same was the official Spotify-Last.fm integration works -- it only scrobbles the **first** artist on a multi-artist track.
 
-### Jellyfin does not scrobble tracks with multiple artists correctly
-
-This is a limitation caused by the [Jellyfin webhook plugin](https://github.com/FoxxMD/multi-scrobbler/issues/70#issuecomment-1443804712) only sending the first artist to multi-scrobbler. This issues needs to be [fixed upstream on the Jellyfin webhook repository.](https://github.com/jellyfin/jellyfin-plugin-webhook/issues/166)
-
 ### Google Cast track information is missing/incorrect or MS player has weird times
 
 The Google Cast integration relies on a few common fields in the data it receives from your casting device. Every platform that can cast (Spotify, Pandora, etc...) *should* use these fields the same but there are slight differences between their implementations that may confuse multi-scrobbler. Specific platforms may also return more information in non-common fields that are undocumented.
 
-To diagnose these issues you [**must enable payload logging**](configuration/configuration.mdx#cast-troubleshooting) for your google cast Source, run MS, and then include logs with this output from that run. Without the raw data logged from your cast device it will be nearly impossible to resolve your issue.
+To diagnose these issues you [**must enable payload logging**](/configuration/sources/google-cast#cast-troubleshooting) for your google cast Source, run MS, and then include logs with this output from that run. Without the raw data logged from your cast device it will be nearly impossible to resolve your issue.
 
 ### Google Cast device does not track media
 
@@ -182,22 +120,100 @@ MS logs will tell you what type the media is reported as with lines like:
 My Artist - Example Track has 'unknown' media type and allowUnknownMedia=false, will not track
 ```
 
-Refer to [Allow Unknown Media Type](configuration/configuration.mdx#allow-unknown-media-type) section to fix this
+Refer to [Allow Unknown Media Type](/configuration/sources/google-cast#allow-unknown-media-type) section to fix this
 
 ```
 My Artist - Example Track has 'movie' media type so will not track
 ```
 
-Refer to [Force Media Tracking](configuration/configuration.mdx#forcing-media-tracking) section to fix this
+Refer to [Force Media Tracking](/configuration/sources/google-cast#forcing-media-tracking) section to fix this
 
 ### VLC is not scrobbling fields correctly
 
-Before reporting an issue turn on metadata logging in the MS VLC configuration, [see the VLC documentation.](configuration/configuration.mdx#vlc-information-reporting)
+Before reporting an issue turn on metadata logging in the MS VLC configuration, [see the VLC documentation.](/configuration/sources/vlc#vlc-information-reporting)
 
-### Youtube Music misses scrobbles
+### Youtube Music misses or duplicates scrobbles
 
-In order for multi-scrobbler to accurately determine if a song has been scrobbled it needs **a source of truth.** For YTM this is a "history" list scraped from the YTM website. Unfortunately, the data in this list can be (often) inconsistent which makes it hard for multi-scrobbler to "trust" that it is correct and determine when/if new scrobbles occur. This inconsistency is not something multi-scrobbler can control -- it is a side-effect of having to use an unofficial method to access YTM (scraping).
+<details>
 
-In order to compensate for this multi-scrobbler resets when it considers this list the "source of truth" based on if the list changes in an inconsistent way between consecutive checks. New scrobbles can only be detected when this list is "OK" as a source of truth for N+1 checks. Therefore, any new tracks that appear when the list is inconsistent will be ignored.
+  <summary>How MS detects YTM history</summary>
 
-See [this issue](https://github.com/FoxxMD/multi-scrobbler/issues/156#issuecomment-2312533486) for further discussion and a more detailed explanation of why this is happening and how multi-scrobbler compensates for it.
+  In order for multi-scrobbler to accurately determine if a song has been scrobbled it needs **a source of truth.** For YTM this is a "history" list scraped from the YTM website. Unfortunately, the data in this list can be (often) inconsistent which makes it hard for multi-scrobbler to "trust" that it is correct and determine when/if new scrobbles occur. This inconsistency is not something multi-scrobbler can control -- it is a side-effect of having to use an unofficial method to access YTM (scraping).
+
+  To compensate for this multi-scrobbler resets when it considers this list the "source of truth" based on if the list changes in an inconsistent way between consecutive checks. New scrobbles can only be detected when this list is "OK" as a source of truth for N+1 checks. Therefore, any new tracks that appear when the list is inconsistent will be ignored.
+
+  Duplicate scrobbles can also occur if the change between two checks is technically consistent. For instance, if you listen to a track twice in some period, separated by other music, YTM will sometimes "remove" the track from the earlier time (further down in your history) and "re-add" it at the top of the history.
+
+</details>
+
+#### Reporting YTM scrobble issues
+
+If you experience scrobble detection issues you can help improve MS's YTM heureistic by providing thorough feedback as [an issue.](https://github.com/FoxxMD/multi-scrobbler/issues/new?assignees=&labels=bug&projects=&template=01-bug-report.yml&title=bug%3A+) **Please do the following to provide the most useful report:**
+
+##### Turn on Change Detection
+
+In your YTM configuration (`ytmusic.json`) add `logDiff` under `options` like this:
+
+
+```json
+{
+    "type": "ytmusic",
+    "name": "MyYTM",
+    "data": { ... },
+    "options": {
+        "logDiff": true
+    }
+}
+```
+
+or set either ENVs:
+
+* `YTM_LOG_DIFF=true`
+* [`DEBUG_MODE=true`](/configuration#debug-mode)
+
+This will cause MS to log YTM history changes similar to this:
+
+```
+[Ytmusic - MyYTM] Changes from last seen list:
+1. (tuhe1CpHRxY) KNOWER - I’m The President --- undefined => Moved -  Originally at 6
+2. (Mtg8V6Xa2nc) Vulfpeck - Romanian Drinking Song --- Schvitz => Moved -  Originally at 1
+3. (rxbCaiyYSXM) Nightmares On Wax - You Wish --- In A Space Outta Sound => Moved -  Originally at 2
+4. (tMt_YXr90AM) Gorillaz - O Green World --- undefined => Moved -  Originally at 3
+...
+```
+
+Which are essential to troubleshooting this behavior.
+
+
+##### Turn on File Logging
+
+Optionally, if your logs are busy due to many other sources, you can log **only** YTM logs to a file. Turn this on with the `logToFile` config option:
+
+```json
+{
+    "type": "ytmusic",
+    "name": "MyYTM",
+    "data": { ... },
+    "options": {
+        "logDiff": true,
+        "logToFile": true
+    }
+}
+```
+
+This will cause MS to write YTM logs to a file in your `logs` folder named `ytmusic-MyYTM.log` (based on your source name).
+
+##### Provide Detail and Context
+
+Provide a detailed account of how you were using YTM when the issue occurred, including things like:
+
+* the platform listening on (desktop, mobile, 3rd party client, etc...)
+* any changes in platform
+  * > I switched from desktop to listening on my phone...
+* how you were listening to music
+  * > I was playing an album start to finish
+  * > I listened to two songs in a row, then browsed for a new song in library by artist, then went back to a song in the queue...
+
+Explain the expected behavior (it should have scrobbled songs x, y, then z) and what actually happened (it scrobbled songs x, then y, then x again, then z)
+
+Provide ALL logs from the time when the issue occurred including logs from BEFORE (ideally 2-3 minutes of logs) and AFTER the issue.

docsite/docs/configuration/_category_.json

@@ -1,8 +1,8 @@
 {
   "label": "Configuration",
-  "position": 3,
+  "position": 5,
   "link": {
-    "type": "generated-index",
-    "description": "Configuring Multi-Scrobbler and examples"
+    "type": "doc",
+    "id": "configuration/configuration"
   }
 }

docsite/docs/configuration/clients/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Scrobble Clients",
+  "link": {
+    "type": "doc",
+    "id": "configuration/clients/clients"
+  }
+}

docsite/docs/configuration/clients/clients.mdx

@@ -0,0 +1,66 @@
+---
+sidebar_position: 2
+title: Overview
+toc_max_heading_level: 4
+---
+
+import ScrobbleThreshold from "@site/src/components/snippets/_scrobble-threshold.mdx"
+
+A **Client** is an application that stores the historical information about what songs you have played (scrobbles). Examples are **Maloja, Last.fm, Listenbrainz**...
+
+## Clients
+
+| Name                                                | Now Playing |
+| :-------------------------------------------------- | :---------- |
+| [Last.fm](/configuration/clients/lastfm)            | ✅          |
+| [Listenbrainz](/configuration/clients/listenbrainz) | ✅          |
+| [Koito](/configuration/clients/koito)               | ❌          |
+| [Maloja](/configuration/clients/maloja)             | ❌          |
+| [Rocksky](/configuration/clients/rocksky)           | ❌          |
+| [Teal.fm](/configuration/clients/tealfm)            | ❌          |
+
+## Features
+
+### Dead Scrobbles
+
+If multi-scrobbler is unable to submit a scrobble to a Client then it places the scrobble into a queue which is retried every 5 minutes for a number of times before it gives up.
+
+After it stops _automatically_ retrying the scrobble still exists and can be retried from the dashboard. Dead scrobbles persist between restart so you will never lose a scrobble that hasn't been successfully submitted yet.
+
+### Now Playing
+
+Multi-scrobbler can report the currently **playing** tracks it is monitoring to some Scrobble Clients via their individual **Now Playing** functionality.
+
+Now Playing is **default enabled** for all Clients that support it.
+
+The behavior multi-scrobbler uses for determining Now Playing reporting:
+
+* Now Playing can be explicitly enabled or disabled globally using ENV `NOW_PLAYING=true` or `NOW_PLAYING=false`
+    * This only affects Clients that don't have behavior set via File/AIO (below)
+* Now Playing will be only be reported to the same Clients a Source is configured to scrobble to
+* A Source's Player status must be **Playing**, IE **active**, for reporting to occur
+  * This status can be verified via Player UI on the Dashboard
+* If multiple Sources having active Players then the scrobble Client will default to reporting the track based on Source **configuration** name, alphabetically
+  * This is the `name` property set in [File or AIO source configs](/configuration?configType=file#configuration-types)
+
+Clients can customize the Now Playing behavior individually using [File or AIO source configs:](/configuration?configType=file#configuration-types)
+
+```json5 title="CONFIG_DIR/lastfm.json"
+[
+  {
+    "name": "myLastFmClient",
+    "configureAs": "client",
+    "data": {
+      // ...
+    },
+    "options": {
+        // disable or enable
+        //"nowPlaying": true
+        //
+        // OR define a list of Source *config* names that should be allowed to report Now Playing
+        // order of the list determines priority for reporting Now Playing
+        //"nowPlaying": ["mySpotify1","myJellyfin2"]
+    }
+  },
+]
+```

docsite/docs/configuration/clients/koito.mdx

@@ -0,0 +1,60 @@
+---
+title: Koito
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import JsonConfig from '!!raw-loader!@site/../config/koito.json.example';
+
+:::tip[Other Uses]
+
+To monitor and re-scrobble activity from a Koito account create a [Koito (Source)](/configuration/sources/koito-source)
+
+:::
+
+Setup a [Koito server](https://koito.io/guides/installation/) if you have not already done this.
+
+* [Create (or get) an API Key](https://koito.io/guides/scrobbler/)
+    * From your Koito server dashboard navigate to **Settings** (bottom-left icon) => **API Keys**
+    * Create a new Key (or use an existing) and Copy the key using the copy icon to the right of the key
+    * EX `pM195xPV98CDpk0QW47FIIOR8AKATAX5DblBF-Jq0t1MbbKL`
+* Take note of your Koito username (used below as `KOITO_USER`)
+* Determine your Koito URL
+    * This is the URL you use to access your Koito dashboard OR whatever URL is accessible from your multi-scrobbler instance.
+    * EX dashboard at `http://192.168.0.100:4110` => `KOITO_URL` is set to `http://192.168.0.100:4110`
+
+:::note[Koito Base URL]
+
+Using the URL path `/apis/listenbrainz` [Koito docs describe](https://koito.io/guides/scrobbler/) **is not required.** The Koito URL used for multi-scrobbler should only be the **base** URL. Only include a URL path if your Koito **base** url is not at `host:port`. See the table below for examples.
+
+<details>
+
+<summary>Base URL Examples</summary>
+    | `KOITO_URL`                                   | MS Detected Base URL            | Example Scrobble Api URL                             |
+    | :-------------------------------------------- | :------------------------------ | ---------------------------------------------------- |
+    | `http://192.168.0.100:4110`                   | `http://192.168.0.100:4110`     | `http://192.168.0.100:4110/apis/listenbrainz/1`      |
+    | `https://koito.mydomain.com`                  | `https://koito.mydomain.com`    | `https://koito.mydomain.com/apis/listenbrainz/1`     |
+    | `http://192.168.0.100:4110/apis/listenbrainz` | `http://192.168.0.100:4110`     | `http://192.168.0.100:4110/apis/listenbrainz/1`      |
+    | `http://192.168.0.100:80/koito`               | `http://192.168.0.100:80/koito` | `http://192.168.0.100:80/koito/apis/listenbrainz/1` |
+</details>
+:::
+                                       
+
+:::tip
+
+Ensure that Koito is configured to allow requests from multi-scrobbler! In Koito config set [`KOITO_ALLOWED_HOSTS`](https://koito.io/reference/configuration/#koito_allowed_hosts) to the IP the multi-scrobbler dashboard is accessible from.
+
+:::
+
+## 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>

docsite/docs/configuration/clients/lastfm.mdx

@@ -0,0 +1,36 @@
+---
+title: Last.fm
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import JsonConfig from '!!raw-loader!@site/../config/lastfm.json.example';
+
+:::tip[Other Users]
+
+* To monitor and re-scrobble activity from your Last.fm account create a [Last.fm (Source)](/configuration/sources/lastfm-source)
+* To accept scrobbles from outside applications as if multi-scrobbler was Last.fm, create a [Last.fm (Endpoint)](/configuration/sources/lastfm-endpoint)
+
+:::
+
+[Register for an API account here.](https://www.last.fm/api/account/create)
+
+The Callback URL is actually specified by multi-scrobbler but to keep things consistent you should use
+```
+http://localhost:9078/lastfm/callback
+```
+or replace `localhost:9078` with your own base URL.
+
+## 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>

docsite/docs/configuration/clients/listenbrainz.mdx

@@ -0,0 +1,31 @@
+---
+title: Listenbrainz
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import JsonConfig from '!!raw-loader!@site/../config/listenbrainz.json.example';
+
+:::tip[Other Users]
+
+* To monitor and re-scrobble activity from a Listenbrainz account create a [Listenbrainz (Source)](/configuration/sources/listenbrainz-source)
+* To accept scrobbles from outside applications as if multi-scrobbler was a Listenbrainz server, create a [Listenbrainz (Endpoint)](/configuration/sources/listenbrainz-endpoint)
+
+:::
+
+You will need to run your own Listenbrainz server or have an account [on the official instance](https://listenbrainz.org/login/)
+
+On your [profile page](https://listenbrainz.org/profile/) find your **User Token** to use in the configuration.
+
+## 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>

docsite/docs/configuration/clients/maloja.mdx

@@ -0,0 +1,45 @@
+---
+title: Maloja
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import JsonConfig from '!!raw-loader!@site/../config/maloja.json.example';
+
+Setup a [Maloja server](https://github.com/krateng/maloja?tab=readme-ov-file#how-to-install) if you have not already done this.
+
+<details>
+
+    <summary>Maloja Setup Intructions</summary>
+
+    Using Maloja's example `docker-compose.yml`:
+
+    ```yaml reference title="~/malojaData/docker-compose.yml"
+    https://github.com/krateng/maloja/blob/master/example-compose.yml
+    ```
+
+    Uncomment `environment` and add `MALOJA_FORCE_PASSWORD=CHANGE_ME` to set an admin password
+
+    Start the container:
+
+    ```shell title="~/malojaData"
+    docker compose up -d
+    ```
+</details>
+
+* Navigate to the Admin Panel (Cog in upper-right corner) -> API Keys (or at http://myMalojaServerIP/admin_apikeys)
+    * Create a **New Key** and then copy the generated key value
+
+Finally, add the Maloja server URL and API Key to the configuration type you choose to use, below.
+
+## 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>

docsite/docs/configuration/clients/rocksky.mdx

@@ -0,0 +1,72 @@
+---
+title: Rocksky
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Bluesky from "@site/src/components/snippets/_bluesky.mdx";
+import JsonConfig from '!!raw-loader!@site/../config/rocksky.json.example';
+
+:::tip[Other Uses]
+
+To monitor and re-scrobble activity **from** Rocksky create a [Rocksky (Source)](/configuration/sources/rocksky-source)
+
+:::
+
+[**Rocksky**](https://rocksky.app/) is music tracking and discovery platform built on the AT Protocol (Bluesky).
+
+<details>
+
+<summary>How does that work?</summary>
+
+<Bluesky name="Rocksky" lexicon="app.rocksky"/>
+
+</details>
+
+:::warning[Public Data]
+
+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.
+
+:::
+
+:::warning[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.
+
+To do this it *asynchronously* matches your scrobble data against Musicbrainz's and/or Spotify's catalogs, *after the scrobble has been submitted.* **If the scrobble does not end up matching then it is not persisted.**
+
+If you need your scrobbles to be 100% captured then you should scrobble to an *additional* [Scrobble Client](/configuration/clients).
+
+:::
+
+## Setup
+
+You will need a [Bluesky](https://bsky.app/) account 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
+
+## Configuration
+
+### Handle
+
+The handle used with multi-scrobbler should be your **full** ATProto 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`
+* For non-Bluesky users, you probably already know your handle
+
+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                                   |
+</Config>

docsite/docs/configuration/clients/tealfm.mdx

@@ -0,0 +1,72 @@
+---
+title: Teal.fm
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import JsonConfig from '!!raw-loader!@site/../config/tealfm.json.example';
+import Bluesky from "@site/src/components/snippets/_bluesky.mdx";
+
+:::tip[Other Uses]
+
+To monitor and re-scrobble activity from a ATProto Profile create a [teal.fm (Source)](/configuration/sources/tealfm-source)
+
+:::
+
+[**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).
+
+<details>
+
+<summary>How does that work?</summary>
+
+<Bluesky name="teal.fm" lexicon="fm.teal"/>
+
+</details>
+
+:::warning
+
+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.
+
+:::
+
+:::note
+
+[teal.fm is still in developement](https://notes.teal.fm/3lzlwe6puis2l) and does not have a public website, yet.
+
+To view your teal.fm scrobbles you can:
+
+* use [wrapped.baileytownsend.dev](https://wrapped.baileytownsend.dev/) which gives a simple stats overview of your scrobbles
+* use [atproto.at](https://atproto.at) to view the raw data (convenience URLs are generated in multi-scrobbler for you to do this)
+
+:::
+
+## Setup
+
+#### Bluesky
+
+* Create a [Bluesky](https://bsky.app) account, if you don't already have one
+* Navigate to https://bsky.app/settings/app-passwords
+  * Settings -> Privacy and Security -> App passwords
+* Create a new **App Password** and save it somewhere, it will not be shown again
+
+## Configuration
+
+### Handle
+
+The handle used with multi-scrobbler should be your **full** ATProto 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`
+* For non-Bluesky users, you probably already know your handle
+
+If you do 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. For Bluesky account this is like `myUser.bsky.social` |
+        | TEALFM_APP_PW          | Yes       |         | Bluesky/ATProto network App Password                                                |
+</Config>

docsite/docs/configuration/kitchensink.mdx

@@ -3,21 +3,22 @@ sidebar_position: 3
 title: Kitchen Sink
 ---
 
-# Example Config using all Possible Features
+# Example Complex Scenario
 
 Scenario: 
 
 * You want to scrobble plays for yourself (Foxx), Fred, and Mary
-* Each person has their own Maloja server
+* Each person has their own [Maloja](/configuration/clients/maloja) server
 * Each person has their own Spotify account
-* You have your own Airsonic (subsonic) server you to scrobble from
-* You have your own Youtube Music account you want to scrobble from
-* Mary has her own Last.fm account she also wants to scrobble to
-* Fred has his own Spotify application and provides you with just his access and refresh token because he doesn't trust you (wtf Fred)
+* You have your own Airsonic ([subsonic](/configuration/sources/subsonic)) server you to scrobble from
+* You have your own [Youtube Music](/configuration/soures/youtube-mysic) account you want to scrobble from
+* 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 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 and wants to scrobble everything he plays
+* The three of you have a shared library on [Plex](/configuration/sources/plex) called `party` that you only play when you are hanging out. You want plays from that library to be scrobbled to everyone's servers.
+* Fred also has his own [Jellyfin server](/configurion/sources/jellyfin) and wants to scrobble everything he plays
+* You have an android music app that can scrobble to a [custom listenbrainz server](/configuration/sources/listenbrainz-endpoint)
 
 ### All-in-one Config
 
@@ -69,7 +70,9 @@ Scenario:
       "name": "fredPlex",
       "clients": ["fredMaloja"],
       "data": {
-        "user": ["fred@email.com"]
+        "token": "JtRnwQWD__XMJF8sT3jc",
+        "url": "192.168.0.233:32400",
+        "usersallow": ["fredUser"]
       }
     },
     {
@@ -77,8 +80,10 @@ Scenario:
       "name": "maryPlex",
       "clients": ["maryMaloja"],
       "data": {
-        "user": ["mary@email.com"], // still need to specify mary as user so not all users who play from 'podcasts' get scrobbled
-        "libraries": ["podcasts"]
+        "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"]
       }
     },
     {
@@ -86,7 +91,9 @@ Scenario:
       "name": "partyPlex",
       // omitting clients (or making it empty) will make this Source scrobble to all Clients
       "data": {
-        "libraries": ["party"],
+        "token": "JtRnwQWD__XMJF8sT3jc",
+        "url": "192.168.0.233:32400",
+        "librariesAllow": ["party"]
       }
     },
     {
@@ -94,7 +101,10 @@ Scenario:
       "name": "FredJelly",
       // omitting clients (or making it empty) will make this Source scrobble to all Clients
       "data": {
-        "user": ["fred@email.com"]
+        "url": "http://localhost:8096",
+        "user": "FoxxMD",
+        "apiKey": "c9fae8756fbf481ebd9c5bb56bd6540c",
+        "usersAllow": ["fredUser"]
       }
     },
     {
@@ -113,9 +123,16 @@ Scenario:
       "clients": ["foxxMaloja"],
       "data": {
         "cookie": "__Secure-3PAPISID=3AxsXpy0MKGu75Qb/AkISXGqOnSDn1jEKn; DEVICE_INFO=ChxOekU0Tmpjek5EWTBPRGd3TlRBMk16QXpNdz09EJbS8Z0GGJbS8Z0G; ...",
-        "authUser": 1
       }
     },
+    {
+      "type": "endpointlz",
+      "name": "listenbrainzfoxx",
+      "clients": ["foxxMaloja"],
+      "data": {
+        "token": "myToken"
+      }
+    }
   ],
   "clients": [
     {
@@ -195,21 +212,27 @@ Scenario:
     "name": "fredPlex",
     "clients": ["fredMaloja"],
     "data": {
-      "user": ["fred@email.com"]
+      "token": "JtRnwQWD__XMJF8sT3jc",
+      "url": "192.168.0.233:32400",
+      "usersallow": ["fredUser"]
     }
   },
   {
     "name": "maryPlex",
     "clients": ["maryMaloja"],
     "data": {
-      "user": ["mary@email.com"],
-      "libraries": ["podcasts"]
+      "token": "JtRnwQWD__XMJF8sT3jc",
+      "url": "192.168.0.233:32400",
+      "usersallow": ["maryUser"],
+      "librariesAllow": ["podcasts"]
     }
   },
   {
     "name": "partyPlex",
     "data": {
-      "libraries": ["party"]
+      "token": "JtRnwQWD__XMJF8sT3jc",
+      "url": "192.168.0.233:32400",
+      "librariesAllow": ["party"]
     }
   }
 ]
@@ -220,7 +243,10 @@ Scenario:
   {
     "name": "FredJelly",
     "data": {
-      "user": ["fred@email.com"]
+      "url": "http://localhost:8096",
+      "user": "FoxxMD",
+      "apiKey": "c9fae8756fbf481ebd9c5bb56bd6540c",
+      "usersAllow": ["fredUser"]
     }
   }
 ]
@@ -229,12 +255,21 @@ Scenario:
 ```json5 title="CONFIG_DIR/ytmusic.json"
 [
   {
-    "type": "ytmusic",
     "name": "foxxYoutube",
     "clients": ["foxxMaloja"],
     "data": {
       "cookie": "__Secure-3PAPISID=3AxsXpy0MKGu75Qb/AkISXGqOnSDn1jEKn; DEVICE_INFO=ChxOekU0Tmpjek5EWTBPRGd3TlRBMk16QXpNdz09EJbS8Z0GGJbS8Z0G; ...",
-      "authUser": 1
+    }
+  }
+]
+```
+```json5 title="CONFIG_DIR/endpointlz.json"
+[
+  {
+    "name": "listenbrainzfoxx",
+    "clients": ["foxxMaloja"],
+    "data": {
+      "token": "myToken",
     }
   }
 ]

docsite/docs/configuration/plex.md

@@ -1,73 +0,0 @@
----
-sidebar_position: 2
-title: Plex/Tautulli
----
-
-Tracks played on [Plex](https://plex.tv/) can be scrobbled either by:
- * A [Tautulli](https://tautulli.com/) notification agent with a webhook.
- * Using Plex [Webhooks](https://support.plex.tv/articles/115002267687-webhooks) (restricted to Plex Pass users)
-
-# Using Tautulli
-
-## Create a new Notification Agent
-
-* Navigate to the **Notification Agents** page in **Settings**
-* Click **Add a new notification agent**
-* Select **Webhook**
-
-## Configure the Agent
-
-The below sections correspond with the tabs available in the notification agent configuration popup.
-
-### Configuration
-* Webhook URL -- `http://localhost:9078/tautulli` (substitute your domain if different than the default)
-* Webhook Method -- POST
-
-### Triggers
-
-Select **Watched**
-
-### Conditions
-
-Refer to [Tautulli's documentation](https://github.com/Tautulli/Tautulli-Wiki/wiki/Custom-Notification-Conditions) if you need help here. It may be a good idea to restrict notifications to only one library (if you have a Music library, for instance)
-
-**This app will only scrobble an item if `media_type` is a "track", which is the default for all music.**
-
-### Data
-
-Expand the **Watched** dropdown and add the following code block to the **JSON Data** text field:
-
-```
-{
-"artist_name": "{artist_name}",
-"track_name": "{track_name}",
-"track_artist": "{track_artist}",
-"album_name": "{album_name}",
-"media_type": "{media_type}",
-"title":  "{title}",
-"duration": "{duration_sec}",
-"username": "{username}",
-"server": "{server_name}",
-"version": "{server_version}",
-"library": "{library_name}",
-"player": "{player}",
-"device": "{device}",
-"platform": "{platform}",
-"action": "{action}",
-"machine_id": "{machine_id}",
-"session_key": "{session_key}"
-}
-```
-
-**Click the Save button to finish.**
-
-Your agent is now configured and ready to scrobble.
-
-# Using Plex Webhooks
-
-* Navigate to your **Account/Settings** and find the **Webhooks** page
-* Click **Add Webhook**
-* URL -- `http://localhost:9078/plex` (substitute your domain if different than the default)
-* **Save Changes**
-
-Plex is now configured to scrobble.

docsite/docs/configuration/sources/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Scrobble Sources",
+  "link": {
+    "type": "doc",
+    "id": "configuration/sources/sources"
+  }
+}

docsite/docs/configuration/sources/azuracast.mdx

@@ -0,0 +1,82 @@
+---
+title: Azuracast
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import AzuracastConfig from '!!raw-loader!@site/../config/azuracast.json.example';
+import ShouldScrobble from "@site/src/components/snippets/_should-scrobble.mdx"
+
+:::tip[Scrobbling Threshold]
+
+Azuracast may not correctly report track length or position. If this is the case you should reduce the "listened to" **duration** using [Scrobble Thresholds](/configuration/sources#scrobble-thresholds) so that multi-scrobbler scrobbles correctly.
+
+:::
+
+The Azuracast server should have **Use High-Performance Now Playing Updates** enabled in _Administration -> System Settings_
+
+#### URL
+
+The URL used by MS to connect to Azuracast has the syntax:
+
+```
+[ws|wss]://HOST:[PORT]
+```
+
+MS will automatically add the path required for websockets, [`/api/live/nowplaying/websocket`](https://www.azuracast.com/docs/developers/now-playing-data/#websockets), to your URL if none is provided. If you use a reverse proxy with a path-based URL or otherwise need a custom path to access the websockets path correctly then explicitly provide it. Examples:
+
+```
+URL From Config                => MS Uses
+
+'ws://192.168.0.101'                 => ws://192.168.0.101/api/live/nowplaying/websocket
+'ws://azura.mydomain.com'            => ws://azura.mydomain.com.com/api/live/nowplaying/websocket
+'wss://mydomain.com/custom/azura/ws' => wss://mydomain.com/custom/azura/ws
+```
+
+#### Scrobble Behavior
+
+:::info
+
+<ShouldScrobble filename="azuracast"/>
+
+:::
+
+Multi-scrobbler will set the default **scrobbling behavior** based on if either of these settings is configured:
+
+* live status (`AZURA_LIVE` or `monitorWhenLive`) or
+* listener count (`AZURA_LISTENERS_NUM` or `monitorWhenListeners`)
+
+If either is configured then MS will automatically scrobble based on when these conditions are met.
+
+If neither is configured automatic scrobble defaults to **off** and you should either manually initiate it or explicitly set the default behavior.
+
+## Configuration
+
+<Tabs groupId="configType" queryString>
+    <TabItem value="env" label="ENV">
+        | Environmental Variable | Required? | Default | Description                                                                                    |
+        | :--------------------- | :-------- | :------ | ---------------------------------------------------------------------------------------------- |
+        | `AZ_URL`               | Yes       |         | Azuracast URL *without station name*                                                           |
+        | `AZ_STATION`           | Yes       |         | The station name shown on the public page                                                      |
+        | `AZURA_LIVE`           | No        | Yes     | Only scrobble when station status is ONLINE                                                    |
+        | `AZURA_LISTENERS_NUM`  | No        | `true`  | Only scrobble if station has any listeners (`true`) or listeners are equal-to/greater-than `X` |
+    </TabItem>
+    <TabItem value="file" label="File">
+
+        <CodeBlock title="CONFIG_DIR/azuracast.json" language="json5">{AzuracastConfig}</CodeBlock>
+
+
+        or <SchemaLink lower objectName="AzuracastSourceConfig"/>
+    </TabItem>
+    <TabItem value="aio" label="AIO">
+
+        <AIOExample data={AzuracastConfig} name="azuracast"/>
+
+
+        or <SchemaLink lower objectName="AzuracastSourceConfig"/>                                                
+    </TabItem>
+</Tabs>
+

docsite/docs/configuration/sources/deezer.mdx

@@ -0,0 +1,153 @@
+---
+title: Deezer
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import DeezerConfig from '!!raw-loader!@site/../config/deezer.json.example';
+import DeezerDeprecatedConfig from '!!raw-loader!@site/../config/deezer-deprecated.json.example';
+
+<Tabs groupId="deezerSource" queryString>
+    <TabItem value="arl" label="Unofficial ARL">
+        :::warning
+
+        This Source uses unofficial methods to access Deezer data that are likely in violation of Deezer's TOS. Deezer may change or remove these methods at any time, breaking functionality. Use this Source at your own risk.
+
+        :::
+
+        :::info
+
+        This Source will work only if you have a **Premium** Deezer account.
+
+        :::
+
+        ### Retrieve ARL
+
+        The `arl` is a browser cookie that Deezer uses to store your login information. Multi-scrobbler uses the `arl` value to make authorized requests to Deezer's API where it can retrieve listening history.
+
+        **After logging into Deezer**, use one of the methods below to retrieve the `arl` cookie value:
+
+        <Tabs groupId="arlRetrival">
+            <TabItem value="chrome" label="Chrome">
+                1. On deezer.com, press F12 to open the Developer Tools window.
+                2. Go to the Applications tab. Press the '>>' More tabs icon if it's hidden.
+                3. Under the Cookies Filter, click deezer.com, then the text bar name `arl`.
+                4. Copy all the contents shown in the **Cookie Value** pane.
+            </TabItem>
+            <TabItem value="firefox" label="Firefox">
+                1. On deezer.com, hit Ctrl+Shift+I to open Developer Tools
+                2. Go to the Storage Tab, then expand Cookies in the sidebar and select deezer.com
+                3. Find the row with `arl` as the name, then double click the Value column and right click -> copy the value
+            </TabItem>
+        </Tabs>
+
+        ## Configuration
+
+        <Tabs groupId="configType" queryString>
+            <TabItem value="env" label="ENV">
+                | Environmental Variable | Required? | Default | Description                                      |
+                | :--------------------- | --------- | ------- | ------------------------------------------------ |
+                | `DEEZER_ARL`           | Yes       |         | The ARL cookie value retrieved from your browser |
+            </TabItem>
+            <TabItem value="file" label="File">
+
+                <CodeBlock title="CONFIG_DIR/deezer.json" language="json5">{DeezerConfig}</CodeBlock>
+
+                or <SchemaLink lower objectName="DeezerSourceConfig"/>
+            </TabItem>
+            <TabItem value="aio" label="AIO">
+
+                <AIOExample data={DeezerConfig} name="deezer"/>
+
+                or <SchemaLink lower objectName="DeezerSourceConfig"/>
+            </TabItem>
+        </Tabs>
+
+        ### Duplicate detection
+
+        Third party integrations with Deezer (Sonos) may cause Deezer to [report the same track many times in listening history.](https://github.com/FoxxMD/multi-scrobbler/pull/296#issuecomment-2922374738) If you experience this issue modify your Deezer Source config (file-based only) to include the option `"fuzzyDiscoveryIgnore": "aggressive"`
+
+        <details>
+
+            <summary>deezer.json example</summary>
+
+            ```json title="deezer.json"
+            [
+                {
+                    "name": "MyDeezer",
+                    "data": {
+                        "arl": "UOsRPjT3U5Dhaaup3x...",
+                    },
+                    "options": {
+                        "fuzzyDiscoveryIgnore": "aggressive"
+                    }
+                }
+            ]
+            ```
+        </details>
+
+        This option comes with some trade-offs: MS will aggressively detect repeated tracks within a window of time that should eliminate all duplicates. However, this will also prevent *intentionally* repeated tracks from being scrobbled. See [this thread](https://github.com/FoxxMD/multi-scrobbler/pull/296#issuecomment-2970417070) for more information on how this works.
+
+    </TabItem>
+    <TabItem value="official" label="Official API">
+
+        :::warning
+
+        **This Source is DEPRECATED because Deezer has dropped official API support.** This Source will **not** be removed but no further support or fixes will be given. [See this issue for more discussion.](https://github.com/FoxxMD/multi-scrobbler/issues/175#issuecomment-2296776625)
+
+        Users cannot create new applications on Deezer Developers and there is no guarantee existing applications will continue to work.
+
+        As a workaround consider:
+        
+        * Using the alternative [Deezer Source that uses unofficial, internal API via ARL](./?deezerSource=arl)
+        * Connect Deezer with Last.fm and then use [Last.fm as a Source](/configuration/sources/lastfm-source)
+
+        :::
+
+        Create a new application at [Deezer Developers](https://developers.deezer.com/myapps)
+
+        * Application Domain must be the same as your multi-scrobbler domain. Default is `localhost:9078`
+        * Redirect URL must end in `deezer/callback`
+        * Default would be `http://localhost:9078/deezer/callback`
+
+        After application creation you should have credentials displayed in the "My Apps" dashboard. You will need:
+
+        * **Application ID**
+        * **Secret Key**
+        * **Redirect URL** (if not the default)
+
+        **If no access token is provided...**
+
+        After starting multi-scrobbler with credentials in-place open the dashboard (`http://localhost:9078`) and find your Deezer source. Click **(Re)authenticate and (re)start polling** to start the login process. After login is complete polling will begin automatically.
+
+        ###### Configuration
+
+        <Tabs groupId="configType" queryString>
+            <TabItem value="env" label="ENV">
+                | Environmental Variable | Required? | Default                                 | Description                       |
+                |------------------------|-----------|-----------------------------------------|-----------------------------------|
+                | `DEEZER_CLIENT_ID`     | Yes       |                                         | Your **Application ID**           |
+                | `DEEZER_CLIENT_SECRET` | Yes       |                                         | Your **Secret Key**               |
+                | `DEEZER_REDIRECT_URI`  | No        | `http://localhost:9078/deezer/callback` | URI must end in `deezer/callback` |
+            </TabItem>
+            <TabItem value="file" label="File">
+
+                <CodeBlock title="CONFIG_DIR/deezer.json" language="json5">{DeezerDeprecatedConfig}</CodeBlock>
+
+
+                or <SchemaLink lower objectName="DeezerSourceConfig"/>
+            </TabItem>
+            <TabItem value="aio" label="AIO">
+
+                <AIOExample data={DeezerDeprecatedConfig} name="deezer"/>
+
+
+                or <SchemaLink lower objectName="DeezerSourceConfig"/>
+            </TabItem>
+        </Tabs>
+
+        </TabItem>
+</Tabs>

docsite/docs/configuration/sources/google-cast.mdx

@@ -0,0 +1,184 @@
+---
+title: Google Cast (Chromecast)
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import ChromecastConfig from '!!raw-loader!@site/../config/chromecast.json.example';
+
+If your media device can be **Cast** to using this button ![Chromecast Icon](https://upload.wikimedia.org/wikipedia/commons/2/26/Chromecast_cast_button_icon.svg) on your phone/computer then multi-scrobbler can monitor it in order to scrobble music you play.
+
+
+:::note 
+
+Google Cast support is **experimental**. You may experience crashes and errors while using this Source. Please open an issue if you experience problems and include all information detailed in the issue template to help debug your issue.
+
+:::
+
+:::note 
+
+This source relies on common, **basic** music data provided by the cast device which will always be less exhaustive than data parsed from full source integrations. If there is an existing [Source](/configuration/sources) it is recommended to configure for it and blacklist the app on Google Cast, rather than relying solely on Google Cast for scrobbling.
+
+:::
+
+#### Connecting Devices
+
+Cast devices can be manually configured using file-based configuration OR automatically discovered using **mDNS.**
+
+###### mDNS Discovery
+
+The host machine running multi-scrobbler must be configured to allow [mDNS traffic on port 5353/UDP](https://book.hacktricks.xyz/network-services-pentesting/5353-udp-multicast-dns-mdns).
+
+<details>
+
+    <summary>OS Specific Instructions</summary>
+
+<Tabs>
+    <TabItem value="linux" label="Linux">
+        **Docker**
+
+        The host machine must have [avahi-daemon](https://avahi.org/) running to circumvent limitations with DNS resolution due to musl in Alpine. Most major linux distributions package avahi and many have it built-in. Once avahi is running you must pass D-Bus and the avahi daemon socket to your container like so:
+
+        ```
+        docker run ... -v /var/run/dbus:/var/run/dbus -v  	/var/run/avahi-daemon/socket:/var/run/avahi-daemon/socket ... foxxmd/multi-scrobbler
+        ```
+
+        **Flatpak/Nodejs**
+
+        No additional steps are required.
+    </TabItem>
+    <TabItem value="windows" label="Windows">
+        **Docker**
+
+        Unsupported at this time.
+
+        **Nodejs**
+
+        No additional steps are required.
+    </TabItem>
+</Tabs>
+
+</details>
+
+#### What Media Does MS Scrobble?
+
+Cast devices report what type of media the current activity is [(see `metadata` property here)](https://developers.google.com/cast/docs/media/messages#MediaInformation). The reported type is dependent on the application playing the media to correctly report it, the cast device does not magically know what the media is. If an application does not report a type it is always classified as `unknown`.
+
+**By default, MS will only track media that is reported as `MusicTrack`.**
+
+##### Allow Unknown Media Type
+
+Media with an Unknown (`Generic`) media type can be explicitly allowed by setting `"allowUnknownMedia": true` in the file-based configuration. This can also be configured to only allow unknown media types for specific applications by using a list of application names.
+
+<details>
+
+    <summary>Example</summary>
+
+    ```json5 title="chromecast.json"
+    [
+      {
+        "name": "MyCast",
+        "type": "chromecast",
+        "data": {
+          // only allow unknown if app name contains any of these phrases
+          "allowUnknownMedia": ["smarttube", "default media receiver"]
+        },
+      }
+    ]
+    ```
+
+</details>
+
+##### Forcing Media Tracking
+
+MS can be forced to track media from an application regardless of media type. This is useful if an application incorrectly reports a media type you are sure should be music. Set `"forceMediaRecognitionOn"` in the file-based configuration to a list of application names that should always be tracked.
+
+<details>
+
+    <summary>Example</summary>
+
+    ```json5 title="chromecast.json"
+    [
+      {
+        "name": "MyCast",
+        "type": "chromecast",
+        "data": {
+          // media from applications that contains these phrases will always be tracked, regardless of media type reported
+          "forceMediaRecognitionOn": ["smarttube", "default media receiver"]
+        },
+      }
+    ]
+    ```
+
+</details>
+
+#### Cast Troubleshooting
+
+Please include any/all logs with raw output if there are any errors encountered as this is critical to diagnosing issues.
+
+To diagnose bad/incomplete track information or strange MS player behavior please turn on **payload logging** and include log output of the source running to help diagnose this issue. Either enable in config using the below example OR enable [Debug Mode.](/configuration#debug-mode)
+
+<details>
+
+    <summary>Example</summary>
+
+    ```json5 title="chromecast.json"
+    [
+      {
+        "name": "MyCast",
+        "type": "chromecast",
+        "data": {
+          //...
+        },
+        "options": {
+          "logPayload": true
+        }
+      }
+    ]
+    ```
+
+</details>
+
+## Configuration
+
+<Tabs groupId="configType" queryString>
+    <TabItem value="env" label="ENV">
+        :::note
+        [Manually configuring cast device connections](#connecting-devices) is only available through file-based config.
+        :::
+
+        | Environmental Variable | Required? | Default |                                     Description                                      |
+        |------------------------|-----------|---------|--------------------------------------------------------------------------------------|
+        | CC_ENABLE              | No        |         | Set to 'true' to enable Cast monitoring without needing to define other ENVs         |
+        | CC_WHITELIST_DEVICES   | No        |         | Only scrobble from these Cast devices. Comma-delimited list. EX mini-home, family-tv |
+        | CC_BLACKLIST_DEVICES   | No        |         | Do not scrobble from these Cast devices. Comma-delimited list                        |
+        | CC_WHITELIST_APPS      | No        |         | Only scrobble from these casted Apps. Comma-delimited list. EX spotify, pandora      |
+        | CC_BLACKLIST_APPS      | No        |         | Do not scrobble from these casted Apps. Comma-delimited list                         |
+    </TabItem>
+    <TabItem value="file" label="File">
+
+        <details>
+
+            <summary>Example</summary>
+
+            <CodeBlock title="CONFIG_DIR/chromecast.json" language="json5">{ChromecastConfig}</CodeBlock>
+
+        </details>
+
+        or <SchemaLink lower objectName="ChromecastSourceConfig"/>
+    </TabItem>
+    <TabItem value="aio" label="AIO">
+        <details>
+
+            <summary>Example</summary>
+
+            <AIOExample data={ChromecastConfig} name="chromecast"/>
+
+        </details>
+
+        or <SchemaLink lower objectName="ChromecastSourceConfig"/>
+    </TabItem>
+</Tabs>

docsite/docs/configuration/sources/icecast.mdx

@@ -0,0 +1,97 @@
+---
+title: Icecast
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import IcecastConfig from '!!raw-loader!@site/../config/icecast.json.example';
+import ShouldScrobble from "@site/src/components/snippets/_should-scrobble.mdx"
+
+Parse metadata from any Icecast Station (streams) to use for scrobbling.
+
+:::note
+
+There is no standard format for presenting track information in an Icecast stream and the majority of streams that do include metadata only use a single string (`StreamTitle`) from which metadata can be parsed.
+
+Multi-scrobbler will do its best to parse Artist/Album/Track information from this data but the quality and consistency for this is solely based on how the Icecast broadcaster chooses to format their tracks.
+
+:::
+
+:::note[Scrobbling Behavior]
+
+Multi-scrobbler cannot automatically determine if you are listening to a Station. Therefore, **automatic scrobbling for Icecast Sources is off by default.**
+
+Use [Should Scrobble Behavior](/configuration/sources#should-scrobble-behavior) to initiate scrobbling or configure automatic scrobble.
+
+:::
+
+:::tip[Scrobbling Threshold]
+
+Icecast does not report track lengths so multi-scrobbler cannot determine if it should scrobble based on percent played. You should instead set a shorter "listened to" **duration** using [Scrobble Thresholds.](/configuration/sources#scrobble-thresholds)
+
+:::
+
+
+#### URL and Sources
+
+The URL should be the URL you would use to stream audio. 
+
+Additional sources are supported based on those found in [`icecast-metadata-stats`](https://github.com/eshaz/icecast-metadata-js/tree/main/src/icecast-metadata-stats#supported-status-apis). To use these with automatic parsing [based on the regular URL](https://github.com/eshaz/icecast-metadata-js/tree/main/src/icecast-metadata-stats#options) include a `sources` array in your config the same way as shown in `icecast-metadata-stats`:
+
+<details>
+
+    <summary>Example</summary>
+
+```json5 title="config.json"
+[
+    {
+      "name": "myIcy",
+      "enable": true,
+      "data": {
+        "url": "http://myIcecast.com/radio",
+        "sources": ["icy", "ogg", "sevenhtml"]
+      }
+    }
+  ]
+  
+```
+</details>
+
+To manually set these sources include the same [`*Endpoint` options](https://github.com/eshaz/icecast-metadata-js/tree/main/src/icecast-metadata-stats#options) found in `icecast-metadata-stats`.
+
+If no `sources` are configured for multi-scrobbler it will automatically try to use `icy` and `ogg`.
+
+## Configuration
+
+<Tabs groupId="configType" queryString>
+    <TabItem value="env" label="ENV">
+        | Environmental Variable | Required? | Default | Description |
+        | :--------------------- | :-------- | :------ | ----------- |
+        | `ICECAST_URL`          | Yes       |         | Icecast URL |
+    </TabItem>
+    <TabItem value="file" label="File">
+        <details>
+
+            <summary>Example</summary>
+
+            <CodeBlock title="CONFIG_DIR/icecast.json" language="json5">{IcecastConfig}</CodeBlock>
+
+        </details>
+
+        or <SchemaLink lower objectName="IcecastSourceConfig"/>
+    </TabItem>
+    <TabItem value="aio" label="AIO">
+        <details>
+
+            <summary>Example</summary>
+
+            <AIOExample data={IcecastConfig} name="icecast"/>
+
+        </details>
+
+        or <SchemaLink lower objectName="IcecastSourceConfig"/>                                                
+    </TabItem>
+</Tabs>

docsite/docs/configuration/sources/jellyfin.mdx

@@ -0,0 +1,67 @@
+---
+title: Jellyfin
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import JellyfinConfig from '!!raw-loader!@site/../config/jellyfin.json.example';
+
+Must be using Jellyfin 10.7 or greater
+
+* Create an **API Key** for multi-scrobbler
+  * In the Jellyfin desktop web UI Navigate to -> Administration -> Dashboard -> API Keys (`http://YOUR_JELLYIN_URL/web/index.html#!/apikeys.html`)
+  * Click `+` button and create a new key with **App name** `multi-scrobbler`
+  * Copy the created API Key value for use in configuration below
+
+
+It is **recommended** to use API Key + username but if you are not an admin for your Jellyfin instance you can also authenticate with your Jellyfin username and **password.**
+
+:::tip[Important Defaults]
+
+By default...
+
+* multi-scrobbler will **only** scrobble for the user authenticated with the API. 
+  * Allowed Users (`usersAllow` or `JELLYFIN_USERS_ALLOW`) are only necessary if you want to scrobble for additional users.
+* multi-scrobbler will **only** scrobble media found in Jellyfin libraries that were labelled as **Music.**
+  * `librariesAllow` or `JELLYFIN_LIBRARIES_ALLOW` will override this
+  * OR use `additionalAllowedLibraryTypes` to allow more types (like `mixed` or `book` for audiobooks)
+* multi-scrobbler will **only** scrobble media Jellyfin detects as **Audio.**
+  * To force multi-scrobbler to scrobble when media is detected as **Unknown** use `"allowUnknown": true` in file/aio configuration.
+
+:::
+
+#### Configuration
+
+<Tabs groupId="configType" queryString>
+    <TabItem value="env" label="ENV">
+        | Environmental Variable     | Required? | Default | Description                                                                                |
+        | -------------------------- | --------- | ------- | ------------------------------------------------------------------------------------------ |
+        | `JELLYFIN_URL`             | **Yes**   |         | The URL of the Jellyfin server IE `http://localhost:8096`                                  |
+        | `JELLYFIN_USER`            | **Yes**   |         | The user to authenticate with the API                                                      |
+        | `JELLYFIN_APIKEY`          | No        |         | The API Key to use for authentication **(Must provide either apikey or password)**         |
+        | `JELLYFIN_PASSWORD`        | No        |         | The password of the user to authenticate for. **(Must provide either apikey or password)** |
+        | `JELLYFIN_USERS_ALLOW`     | No        |         | Comma-separated list of usernames (from Jellyfin) to scrobble for                          |
+        | `JELLYFIN_USERS_BLOCK`     | No        |         | Comma-separated list of usernames (from Jellyfin) to disallow scrobble for                 |
+        | `JELLYFIN_DEVICES_ALLOW`   | No        |         | Comma-separated list of devices to scrobble from                                           |
+        | `JELLYFIN_DEVICES_BLOCK`   | No        |         | Comma-separated list of devices to disallow scrobbles from                                 |
+        | `JELLYFIN_LIBRARIES_ALLOW` | No        |         | Comma-separated list of libraries to allow scrobbles from                                  |
+        | `JELLYFIN_LIBRARIES_BLOCK` | No        |         | Comma-separated list of libraries to disallow scrobbles from                               |
+    </TabItem>
+    <TabItem value="file" label="File">
+
+        <CodeBlock title="CONFIG_DIR/jellyfin.json" language="json5">{JellyfinConfig}</CodeBlock>
+
+        or <SchemaLink lower objectName="JellyApiSourceConfig"/>
+
+    </TabItem>
+    <TabItem value="aio" label="AIO">
+
+        <AIOExample data={JellyfinConfig} name="jellyfin"/>
+
+
+        or <SchemaLink lower objectName="JellyApiSourceConfig"/>
+    </TabItem>
+</Tabs>

docsite/docs/configuration/sources/jriver.mdx

@@ -0,0 +1,76 @@
+---
+title: JRiver
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import JriverConfig from '!!raw-loader!@site/../config/jriver.json.example';
+
+In order for multi-scrobbler to communicate with JRiver you must have [Web Server Interface](https://wiki.jriver.com/index.php/Web_Service_Interface#Documentation_of_Functions) enabled. This can can be in the JRiver GUI:
+
+* Tools -> Options -> Media Network
+  * Check `Use Media Network to share this library...`
+  * If you have `Authentication` checked you will need to provide the **Username** and **Password** in the ENV/File configuration below.
+
+### URL
+
+The URL used to connect to JRiver, set in your [file config as `url`.](#configuration) The URL used to connect ultimately must be formed like this:
+
+```
+Syntax  => [protocol]://[hostname]:[port]/[path]
+Default =>       http://localhost:52199/MCWS/v1/
+```
+
+If any part of this URL is missing multi-scrobbler will use a default value. This also means that if any part of your URL is **not** standard you must explicitly define it.
+
+:::tip[Jriver Settings]
+
+* Make sure the port number matches what is found in `Advanced` section in the Media Network options.
+* If your installation is on the same machine but you cannot connect using `localhost` try `0.0.0.0` instead.
+
+:::
+
+<details>
+    <summary>URL Transform Examples</summary>
+
+    Examples of a given `url` in your file config and the final URL multi-scrobbler will use to connect to JRiver:
+
+    | `url`                                    | Transformed URL                             |
+    |------------------------------------------|---------------------------------------------|
+    | (none set)                               | `http://localhost:52199/MCWS/v1/`           |
+    | `jriver.mydomain.com`                    | `http://jriver.mydomain.com:52199/MCWS/v1/` |
+    | `192.168.0.101:3456`                     | `http://192.168.0.101:3456/MCWS/v1/`        |
+    | `mydomain.com:80/jriverReverse/MCWS/v1/` | `mydomain.com:80/jriverReverse/MCWS/v1/`    |
+
+</details>
+
+## Configuration
+
+<Tabs groupId="configType" queryString>
+    <TabItem value="env" label="ENV">
+    <EnvType>
+        | Environmental Variable | Required |             Default             |                  Description                   |
+        |------------------------|----------|---------------------------------|------------------------------------------------|
+        | JRIVER_URL             | Yes      | http://localhost:52199/MCWS/v1/ | The URL of the JRiver server                   |
+        | JRIVER_USERNAME        | No       |                                 | If authentication is enabled, the username set |
+        | JRIVER_PASSWORD        | No       |                                 | If authenticated is enabled, the password set  |
+    </EnvType>
+    </TabItem>
+    <TabItem value="file" label="File">
+    <FileType>
+        <CodeBlock title="CONFIG_DIR/jriver.json" language="json5">{JriverConfig}</CodeBlock>
+
+        or <SchemaLink lower objectName="JRiverSourceConfig"/>
+    </FileType>
+    </TabItem>
+    <TabItem value="aio" label="AIO">
+    <AIOType>
+        <AIOExample data={JriverConfig} name="jriver"/>
+
+        or <SchemaLink lower objectName="JRiverSourceConfig"/>
+    </AIOType>
+    </TabItem>
+</Tabs>

docsite/docs/configuration/sources/kodi.mdx

@@ -0,0 +1,59 @@
+---
+title: Kodi
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import KodiConfig from '!!raw-loader!@site/../config/kodi.json.example';
+import Config from '@site/src/components/GenericConfiguration.mdx';
+
+In order for multi-scrobbler to communicate with Kodi you must have the [Web Interface](https://kodi.wiki/view/Web_interface) enabled. This can be done in the Kodi GUI:
+
+* Settings -> Services -> Control
+  * Check `Allow remote control via HTTP`
+  * Ensure you have a **Username** and **Password** set, you will need to provide them in the ENV/File configuration below.
+
+### URL
+
+The URL used to connect to Kodi, set in your [file config as `url`.](#configuration) The URL used to connect ultimately must be formed like this:
+
+```
+Syntax  => [protocol]://[hostname]:[port]/[path]
+Default =>       http://localhost:8080/jsonrpc
+```
+
+If any part of this URL is missing multi-scrobbler will use a default value. This also means that if any part of your URL is **not** standard you must explicitly define it.
+
+:::tip[Kodi Settings]
+
+* Make sure the port number matches what is found in **Port** in the Control section mentioned above.
+* If your installation is on the same machine but you cannot connect using `localhost` try `0.0.0.0` instead.
+
+:::
+
+<details>
+    <summary>URL Transform Examples</summary>
+
+    Examples of a given `url` in your file config and the final URL multi-scrobbler will use to connect to Kodi:
+
+    | `url`                                 | Transformed URL                              |
+    |---------------------------------------|----------------------------------------------|
+    | (none set)                            | `http://localhost:8080/jsonrpc`              |
+    | `kodi.mydomain.com`                   | `http://kodi.mydomain.com:8080/jsonrpc`      |
+    | `192.168.0.101:3456`                  | `http://192.168.0.101:3456/jsonprc`          |
+    | `mydomain.com:80/kodiReverse/jsonrpc` | `http://mydomain.com:80/kodiReverse/jsonrpc` |
+
+</details>
+
+## Configuration
+
+<Config config="KodiSourceConfig" fileContent={KodiConfig} name="kodi">
+        | Environmental Variable | Required | Default                       | Description                |
+        |------------------------|----------|-------------------------------|----------------------------|
+        | KODI_URL               | Yes      | http://localhost:8080/jsonrpc | The URL of the Kodi server |
+        | KODI_USERNAME          | No       |                               | The username set           |
+        | KODI_PASSWORD          | No       |                               | The password set           |
+</Config>

docsite/docs/configuration/sources/koito-source.mdx

@@ -0,0 +1,31 @@
+---
+title: Koito
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import KoitoConfig from '!!raw-loader!@site/../config/koito.json.example';
+
+This Source monitors a Koito account's scrobble history and then re-scrobbles discovered tracks to configured [Clients.](/configuration/clients)
+
+:::tip[Other Uses]
+
+To  _scrobble to_ a Koito server, create a [Koito (Client)](/configuration/clients/koito)
+
+:::
+
+See the [Koito (Client)](/configuration/clients/koito) configuration for general setup. The only difference for **Source** configuration:
+
+* Cannot be setup with ENV config 
+* [File/AIO config](/configuration?configType=file#configuration-types) must include `"configureAs": "source"`
+
+#### Configuration
+
+<Config config="KoitoSourceConfig" fileContent={KoitoConfig} name="koito">
+:::note
+        You cannot use ENV variables shown in the [Koito Client config](/configuration/clients/koito) -- multi-scrobbler assumes Koito ENVs are always used for the **client** configuration. You must use the [File or AIO](/configuration?configType=file#configuration-types) config to setup Koito as a Source.
+:::
+</Config>

docsite/docs/configuration/sources/lastfm-endpoint.mdx

@@ -0,0 +1,46 @@
+---
+title: Lastfm (Endpoint)
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import LastfmEndpointConfig from '!!raw-loader!@site/../config/endpointlfm.json.example';
+
+This Source enables multi-scrobbler to accept scrobbles from outside applications as if it was a Last.fm server.
+
+:::tip[Other Uses]
+
+* To **scrobble to** Last.fm, create a [Last.fm (Client)](/configuration/clients/lastfm)
+* To monitor and re-scrobble activity from your Last.fm account, create a [Last.fm (Source)](/configuration/sources/lastfm-source)
+
+:::
+
+### URL
+
+If a **slug** is **not** provided in configuration then multi-scrobbler will accept Last.fm scrobbles at
+
+```
+http://localhost:9078/2.0/
+```
+
+which is the "standard" Last.fm server path for scrobbling
+
+Use a slug only if you need to setup multiple Last.fm Endpoint sources and cannot use different tokens.
+
+If a slug is used then the URL will be:
+
+```
+http://localhost:9078/api/lastfm/mySlug
+```
+
+## Configuration
+
+<Config config="LastFMEndpointSourceConfig" fileContent={LastfmEndpointConfig} name="endpointlfm">
+        | Environmental Variable | Required? | Default | Description                                                                                                        |
+        | :--------------------- | :-------- | ------- | ------------------------------------------------------------------------------------------------------------------ |
+        | `LFMENDPOINT_ENABLE`   | No        |         | Use LFM Endpoint as a Source without any other configuration. Only required if slug/token are not provided as ENVs |
+        | `LFM_SLUG`             | No        |         | (Optional) The URL suffix to use for accepting LFM scrobbles                                                       |
+</Config>

docsite/docs/configuration/sources/lastfm-source.mdx

@@ -0,0 +1,29 @@
+---
+title: Lastfm
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import LastfmConfig from '!!raw-loader!@site/../config/lastfm.json.example';
+
+This Source **monitors your Last.fm scrobble history** and re-scrobbles new activity to configured [Clients.](/configuration/clients)
+
+:::tip[Other Uses]
+
+* To **scrobble to** Last.fm, create a [Last.fm (Client)](/configuration/clients/lastfm)
+* To accept scrobbles from outside applications as if multi-scrobbler was Last.fm, create a [Last.fm (Endpoint)](/configuration/sources/lastfm-endpoint)
+
+:::
+
+To configure this Source use the same registration instructions and configuration data shown in [Last.fm (Client)](/configuration/clients/lastfm) with the difference being `"configureAs": "source"` defined in the File/AIO configuration below.
+
+## Configuration
+
+<Config config="LastfmSourceConfig" fileContent={LastfmConfig} name="lastfm">
+:::note
+        You cannot use ENV variables shown in the [Last.fm Client config](/configuration/clients/lastfm) -- multi-scrobbler assumes Last.fm ENVs are always used for the **client** configuration. You must use the [File or AIO](/configuration?configType=file#configuration-types) config to setup Last.fm as a Source.
+:::
+</Config>

docsite/docs/configuration/sources/listenbrainz-endpoint.mdx

@@ -0,0 +1,68 @@
+---
+title: Listenbrainz (Endpoint)
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import ListenbrainzEndpointConfig from '!!raw-loader!@site/../config/endpointlz.json.example';
+
+This Source enables multi-scrobbler to accept scrobbles from outside applications as if it was a Listenbrainz server.
+
+:::tip[Other Uses]
+
+* To **scrobble to** Listenbrainz, create a [Listenbrainz (Client)](/configuration/clients/listenbrainz)
+* To monitor and re-scrobble activity from your Listenbrainz account, create a [Listenbrainz (Source)](/configuration/sources/listenbrainz-source)
+
+:::
+
+### URL
+
+If a **slug** is **not** provided in configuration then multi-scrobbler will accept Listenbrainz scrobbles at
+
+```
+http://myMultiScrobblerIP:9078/1/submit-listens
+```
+
+which is the "standard" Listenbrainz server path for scrobbling.
+
+In general, you should use `http://myMultiScrobblerIP:9078/1/` as the **base path** when configuring your application to scrobble to multi-scrobbler.
+
+<details>
+
+<summary>URL Setup for Popular Apps</summary>
+
+##### Navidrome
+
+Set the [**ListenBrainz.BaseURL**](https://www.navidrome.org/docs/usage/configuration-options/#advanced-configuration) (env `ND_LISTENBRAINZ_BASEURL`) to `http://myMultiScrobblerIP:9078/1/`
+
+</details>
+
+Use a slug only if you need to setup multiple Listenbrainz Endpoint sources and cannot use different tokens.
+
+If a slug is used then the URL will be:
+
+```
+http://myMultiScrobblerIP:9078/api/listenbrainz/mySlug
+```
+
+:::note
+    Some Listenbrainz applications may require custom Listenbrainz URLs to be a real domain (`example.com`) and/or use SSL (`https://`). In this case you should setup multi-scrobbler behind a reverse proxy to support this functionality. It is out of the scope of this project to do this solely within multi-scrobbler.
+:::
+
+### Token
+
+Most Listenbrainz clients require a token (Authentication Token) to be provided during setup. This value can be anything you want, just make sure to use the same value for `token` in your multi-scrobbler configuration for the endpoint.
+
+
+## Configuration
+
+<Config config="ListenbrainzEndpointSourceConfig" fileContent={ListenbrainzEndpointConfig} name="endpointlz">
+        | Environmental Variable | Required? | Default | Description                                                                                                       |
+        | :--------------------- | :-------- | ------- | ----------------------------------------------------------------------------------------------------------------- |
+        | `LZENDPOINT_ENABLE`    | No        |         | Use LZ Endpoint as a Source without any other configuration. Only required if slug/token are not provided as ENVs |
+        | `LZE_TOKEN`            | No        |         | LZ "Authentication Token" you provided to the scrobbling application                                              |
+        | `LZE_SLUG`             | No        |         | (Optional) The URL suffix to use for accepting LZ scrobbles                                                       |
+</Config>

docsite/docs/configuration/sources/listenbrainz-source.mdx

@@ -0,0 +1,31 @@
+---
+title: Listenbrainz
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import ListenbrainzConfig from '!!raw-loader!@site/../config/listenbrainz.json.example';
+
+This Source monitors a Listenbrainz account's scrobble history and then re-scrobbles discovered tracks to configured clients.
+
+:::tip[Other Uses]
+
+* To **scrobble to** a Listenbrainz server, create a [Listenbrainz (Client)](/configuration/clients/listenbrainz)
+* To accept scrobbles from outside applications as if multi-scrobbler was a Listenbrainz server, create a [Listenbrainz (Endpoint)](/configuration/sources/listenbrainz-endpoint)
+
+:::
+
+You will need to run your own Listenbrainz server or have an account [on the official instance](https://listenbrainz.org/login/).
+
+On your [profile page](https://listenbrainz.org/profile/) find your **User Token** to use in the configuration.
+
+## Configuration
+
+<Config config="ListenBrainzSourceConfig" fileContent={ListenbrainzConfig} name="listenbrainz">
+        :::note
+            You cannot use ENV variables shown in the [Listenbrainz Client config](/configuration/clients/listenbrainz) -- multi-scrobbler assumes Listenbrainz ENVs are always used for the **client** configuration. You must use the [File or AIO](/configuration?configType=file#configuration-types) config to setup Listenbrainz as a Source.
+        :::
+</Config>

docsite/docs/configuration/sources/maloja.mdx

@@ -0,0 +1,29 @@
+---
+title: Maloja
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import MalojaConfig from '!!raw-loader!@site/../config/maloja.json.example';
+
+:::tip[Other Uses]
+
+To  _scrobble to_ a Maloja server, create a [Maloja (Client)](/configuration/clients/maloja)
+
+:::
+
+See the [Maloja (Client)](/configuration/clients/maloja) configuration for general setup. The only difference for **Source** configuration:
+
+* Cannot be setup with ENV config 
+* [File/AIO config](/configuration?configType=file#configuration-types)  must include `"configureAs": "source"`
+
+## Configuration
+
+<Config config="MalojaSourceConfig" fileContent={MalojaConfig} name="maloja">
+        :::note
+            You cannot use ENV variables shown in the [Maloja Client config](/configuration/clients/maloja) -- multi-scrobbler assumes Maloja ENVs are always used for the **client** configuration. You must use the [[File or AIO](/configuration?configType=file#configuration-types) config to setup Maloja as a Source.
+        :::
+</Config>

docsite/docs/configuration/sources/mopidy.mdx

@@ -0,0 +1,102 @@
+---
+title: Mopidy
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import MopidyConfig from '!!raw-loader!@site/../config/mopidy.json.example';
+
+Mopidy is a headless music server that supports playing music from many [standard and non-standard sources such as Pandora, Bandcamp, and Tunein.](https://mopidy.com/ext/)
+
+multi-scrobbler can scrobble tracks played from any Mopidy backend source, regardless of where you listen to them.
+
+:::note
+
+You must have [Mopidy-HTTP extension](https://mopidy.com/ext/http) enabled for this integration to work.
+
+:::
+
+#### URL
+
+The URL used to connect to the Mopidy server, set in your [file config as `url`.](#configuration) The URL used to connect ultimately must be formed like this:
+
+```
+Syntax  => [protocol]://[hostname]:[port]/[path]
+Default =>         ws://localhost:6680/mopidy/ws
+```
+
+If any part of this URL is missing multi-scrobbler will use a default value. This also means that if any part of your URL is **not** standard you must explicitly define it.
+
+:::tip[Mopidy Configuration]
+
+Make sure the hostname and port number match what is found in the Mopidy configuration file `mopidy.conf`:
+
+```ini
+[http]
+hostname = localhost
+port = 6680
+```
+
+:::
+
+<details>
+<summary>URL Transform Examples</summary>
+
+    Examples of a given `url` in your file config and the final URL multi-scrobbler will use to connect to Mopidy:
+
+    | `url`                          | Transformed URL                            |
+    |--------------------------------|--------------------------------------------|
+    | (none set)                     | `ws://localhost:6680/mopidy/ws`            |
+    | `mopidy.mydomain.com`          | `ws://mopidy.mydomain.com:6680/mopidy/ws/` |
+    | `192.168.0.101:3456`           | `ws://192.168.0.101:3456/mopidy/ws/`       |
+    | `mopidy.mydomain.com:80/MOPWS` | `ws://mopidy.mydomain.com:80/MOPWS`        |
+
+</details>
+
+
+### URI Blacklist/Whitelist
+
+If you wish to disallow or only allow scrobbling from some sources played through Mopidy you can specify these using `uriBlacklist` or `uriWhitelist` in your config. multi-scrobbler will check the list to see if any string matches the START of the `uri` on a track. If whitelist is used then blacklist is ignored. All strings are case-insensitive.
+
+<details>
+    <summary>Example</summary>
+    ```json
+    {
+        "uriBlacklist": ["soundcloud"]
+    }
+    ```
+
+    Will prevent multi-scrobbler from scrobbling any Mopidy track that start with a `uri` like `soundcloud:song:MySong-1234`
+</details>
+
+
+### Album Blacklist
+
+For certain sources (Soundcloud) Mopidy does not have all track info (Album) and will instead use "Soundcloud" as the Album name. You can prevent multi-scrobbler from using this bad Album data by adding the fake Album name to this list. Multi-scrobbler will still scrobble the track, just without the bad data. All strings are case-insensitive.
+
+<details>
+    <summary>Example</summary>
+    ```json
+    {
+        "albumBlacklist": ["SoundCloud", "Mixcloud"]
+    }
+    ```
+
+    If a track would be scrobbled like
+    ```
+    Album: Soundcloud, Track: My Cool Track, Artist: A Cool Artist
+    ```
+    then multi-scrobbler will instead scrobble
+    ```
+    Track: My Cool Track, Artist: A Cool Artist
+    ```
+</details>
+
+## Configuration
+
+<Config config="MopidySourceConfig" fileContent={MopidyConfig} name="mopidy">
+No ENV support
+</Config>

docsite/docs/configuration/sources/mpd.mdx

@@ -0,0 +1,28 @@
+---
+title: MPD (Music Player Daemon)
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import MPDConfig from '!!raw-loader!@site/../config/mpd.json.example';
+
+MS communicates with MPD using the [TCP client connection.](https://mpd.readthedocs.io/en/stable/user.html#client-connections)
+
+You should uncomment/create the following settings in your mpd config:
+
+```
+bind_to_address	"any"   # or a specific ipv4/v6 address
+port            "6600"
+```
+
+## Configuration
+
+<Config config="MPDSourceConfig" fileContent={MPDConfig} name="mpd">
+        | Environmental Variable | Required? | Default          | Description |
+        |------------------------|-----------|------------------|-------------|
+        | `MPD_URL`              | No        | `localhost:6600` |             |
+        | `MPD_PASSWORD`         | No        |                  |             |
+</Config>

docsite/docs/configuration/sources/mpris.mdx

@@ -0,0 +1,79 @@
+---
+title: MPRIS
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import MPRISConfig from '!!raw-loader!@site/../config/mpris.json.example';
+
+[MPRIS](https://specifications.freedesktop.org/mpris-spec/latest) is a standard interface for communicating with Music Players on **linux operating systems.**
+
+If you run Linux and have a notification tray that shows what media you are listening to, you likely have access to MPRIS.
+
+![Notification Tray](../mpris.jpg)
+
+multi-scrobbler can listen to this interface and scrobble tracks played by **any media player** that communicates to the operating system with MPRIS.
+
+##### Host Setup
+
+MPRIS communication requires multi-scrobbler to have access to the host's dbus-daemon.
+
+<Tabs groupId="dbus" queryString>
+    <TabItem value="local" label="Local">
+        If multi-scrobbler is running as a [**Local Installation**](../../installation/installation.mdx#nodejs), directly with node/npm, on the same host as MPRIS then no setup is required.
+
+        Remote setup is also possible, see the **Remote Unix Socket** section in the Docker tab.
+    </TabItem>
+    <TabItem value="docker" label="Docker">
+        If multi-scrobbler is running as a [**Docker Container**](../../installation/installation.mdx#docker) some modifications are required...
+
+        ##### Local Unix Socket
+
+        The most secure way is to **run a multi-scrobbler container on the same host as MPRIS.** In this scenario you can simply mount the **user session** dbus unix socket into the container. Make sure [`PUID` and `PGID` ENVs are configured](/installation/#linux-host) so the container has permissions to access the socket. Then, modify your compose stack with these additional values:
+
+        ```yaml title="docker-compose.yaml"
+
+            environment:
+            - DBUS_SESSION_BUS_ADDRESS=unix:path=/run/user/UID/bus 
+
+            volumes:
+            - /run/user/UID/bus:/run/user/UID/bus:ro
+        ```
+
+        ##### Remote Unix Socket
+
+        :::warning
+
+        This method is **insecure.** You should not expose dbus over a network unless access to the port is restricted and the network is trusted.
+
+        :::
+
+        Use [`socat`](https://linux.die.net/man/1/socat) to bidirectionally relay communication from the host's dbus socket to a listening TCP port.
+
+        To make dbus for user with uid `1000` available on port `6644`:
+
+        ```shell
+        socat TCP-LISTEN:6644,reuseaddr,fork UNIX-CONNECT:/run/user/1000/bus
+        ```
+
+        Then, add the following value to multi-scrobbler's ENVs:
+
+        ```
+        DBUS_SESSION_BUS_ADDRESS=tcp:host=yourHostIP,port=6644
+        ```
+
+    </TabItem>
+</Tabs>
+
+## Configuration
+
+<Config config="MPRISSourceConfig" fileContent={MPRISConfig} name="mpris">
+        | Environmental Variable | Required? | Default | Description                                                                      |
+        |------------------------|-----------|---------|----------------------------------------------------------------------------------|
+        | MPRIS_ENABLE           | No        |         | Use MPRIS as a Source (useful when you don't need any other options)             |
+        | MPRIS_BLACKLIST        | No        |         | Comma-delimited list of player names not to scrobble from                        |
+        | MPRIS_WHITELIST        | No        |         | Comma-delimited list of players names to ONLY scrobble from. Overrides blacklist |
+</Config>

docsite/docs/configuration/sources/musikcube.mdx

@@ -0,0 +1,38 @@
+---
+title: Musikcube
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import MusikcubeConfig from '!!raw-loader!@site/../config/musikcube.json.example';
+
+In order to use [Musikcube](https://musikcube.com) configure it to accept [websocket connections](https://github.com/clangen/musikcube/wiki/remote-api-documentation) in **server setup**:
+
+* Enable the **Metadata Server**
+* Set a **Password**
+
+Both of these settings are found in _Musikcube -> (s)ettings -> server setup_
+
+![Server Setup](../musikcube.jpg)
+
+The URL used by MS has the syntax:
+
+```
+[ws|wss]://HOST:[PORT]
+```
+
+The **port** is the same as shown in the server setup screenshot from above, under **metadata server enabled**. If no port is provided to MS it will default to `7905`.
+
+If no URL is provided to MS it will try to use `ws://localhost:7905`
+
+## Configuration
+
+<Config config="MusikcubeSourceConfig" fileContent={MusikcubeConfig} name="musikcube">
+        | Environmental Variable | Required? | Default               | Description                          |
+        |------------------------|-----------|-----------------------|--------------------------------------|
+        | `MC_URL`               | No        | `ws://localhost:7905` | Use port set for **metadata server** |
+        | `MC_PASSWORD`          | Yes       |                       |                                      |
+</Config>

docsite/docs/configuration/sources/plex.mdx

@@ -0,0 +1,79 @@
+---
+title: Plex
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import AzuracastConfig from '!!raw-loader!@site/../config/azuracast.json.example';
+import PlexConfig from '!!raw-loader!@site/../config/plex.json.example';
+
+Find your [**Plex Token**](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/) and make note of the **URL** and **Port** used to connect to your Plex instance.
+
+<details>
+
+<summary>Allowed Users and Defaults</summary>
+
+**Multi-scrobbler will automatically scrobble for these users by default:**
+
+* The User authenticated with the Plex Token
+* and the **Local User**
+
+The Local User (`PLEX_LOCAL_USER`) is how Plex identifies anyone directly accessing the Plex UI from a local IP (who does not need to login).
+
+To allow MS to scrobble for other users use `usersAllow` or `PLEX_USERS_ALLOW` (env) from the below configuration docs. However, because you are overriding the default settings you must also explicitly list the authenticated user and the Local User if you want them to also be able to scrobble.
+
+<details>
+
+<summary>Examples</summary>
+
+###### Defaults
+
+If `usersallow` and `PLEX_USERS_ALLOW` are not defined then the Plex Token authenticated User and Local User will be scrobbled for.
+
+
+###### Only A Specific User
+
+* `"usersallow": ["SomeUser"]` or
+* `PLEX_USERS_ALLOW: SomeUser`
+
+Only the Plex user `SomeUser` will be scrobbled for. The Plex Token authenticated user and the Local User will not be scrobbled for.
+
+###### A Specific User + Defaults
+
+(Assuming the plex authenticated user is `FoxxMD`)
+
+* `"usersallow": ["FoxxMD", "PLEX_LOCAL_USER", "SomeUser"]` or
+* `PLEX_USERS_ALLOW: FoxxMD,PLEX_LOCAL_USER,SomeUser`
+
+The Plex user SomeUser, the Plex Token authenticated user (FoxxMD) and the Local User will be scrobbled for.
+
+</details>
+
+</details>
+
+<details>
+
+<summary>Allowed Libraries and Defaults</summary>
+
+By default multi-scrobbler will only scrobble media found in Plex libraries that are labelled as **Music.**
+  * `librariesAllow` or `PLEX_LIBRARIES_ALLOW` will override this
+
+</details>
+
+#### Configuration
+
+<Config config="PlexApiSourceConfig" fileContent={PlexConfig} name="plex">
+        | Environmental Variable | Required? | Default | Description                                                            |
+        | ---------------------- | --------- | ------- | ---------------------------------------------------------------------- |
+        | `PLEX_URL`             | **Yes**   |         | The URL of the Plex server IE `http://localhost:32400`                 |
+        | `PLEX_TOKEN`           | **Yes**   |         | The **Plex Token** to use with the API                                 |
+        | `PLEX_USERS_ALLOW`     | No        |         | Comma-separated list of usernames (from Plex) to scrobble for          |
+        | `PLEX_USERS_BLOCK`     | No        |         | Comma-separated list of usernames (from Plex) to disallow scrobble for |
+        | `PLEX_DEVICES_ALLOW`   | No        |         | Comma-separated list of devices to scrobble from                       |
+        | `PLEX_DEVICES_BLOCK`   | No        |         | Comma-separated list of devices to disallow scrobbles from             |
+        | `PLEX_LIBRARIES_ALLOW` | No        |         | Comma-separated list of libraries to allow scrobbles from              |
+        | `PLEX_LIBRARIES_BLOCK` | No        |         | Comma-separated list of libraries to disallow scrobbles from           |
+</Config>

docsite/docs/configuration/sources/rocksky-source.mdx

@@ -0,0 +1,39 @@
+---
+title: Rocksky
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import JsonConfig from '!!raw-loader!@site/../config/rocksky.json.example';
+
+:::tip[Other Uses]
+
+* To **scrobble to** Rocksky, create a [Rocksky (Client)](/configuration/clients/rocksky)
+
+:::
+
+[**Rocksky**](https://rocksky.app/) is music tracking and discovery platform built on the AT Protocol (Bluesky).
+
+This Source monitors the Rocksky scrobbles in your PDS and then re-scrobbles discovered tracks to configured clients.
+
+Learn more about how Rocksky scrobbles work in the [Rocksky (Client)](/configuration/clients/rocksky) docs. 
+
+## Setup
+
+Follow the **Setup** instructions in the [Rocksky (Client)](/configuration/clients/rocksky#setup) docs to get access to your Bluesky PDS repository and scrobble data.
+
+## Configuration
+
+See the [Rocksky (Client)](/configuration/clients/rocksky#setup) configuration for general setup. The only difference for **Source** configuration:
+
+* Cannot be setup with ENV config 
+* [File/AIO config](/configuration?configType=file#configuration-types) must include `"configureAs": "source"`
+
+<Config config="RockskyClientConfig" fileContent={JsonConfig} name="rocksky">
+        :::note
+            You cannot use ENV variables shown in the [Rocksky Client config](/configuration/clients/rocksky#configuration) -- multi-scrobbler assumes Rocksky ENVs are always used for the **client** configuration. You must use the [File or AIO](/configuration?configType=file#configuration-types) config to setup Rocksky as a Source.
+        :::
+</Config>

docsite/docs/configuration/sources/sources.mdx

@@ -0,0 +1,155 @@
+---
+sidebar_position: 2
+title: Overview
+toc_max_heading_level: 4
+---
+
+import ScrobbleThreshold from "@site/src/components/snippets/_scrobble-threshold.mdx"
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+
+A **Source** is a data source that contains information about tracks you are playing like a music player or platform. Examples are **Spotify, Jellyfin, Plex, Youtube Music, Airsonic**, etc...
+
+## Sources
+
+| Name                                                                    | Networking                                               | Scrobble SOT                                        | [Multi Device/User](#multi-deviceuser) | [Scrobble Destination](#limiting-scrobble-destination) | [Thresholds](#scrobble-thresholds) | [Should Scrobble](#should-scrobble-behavior) |
+| :---------------------------------------------------------------------- | :------------------------------------------------------- | :-------------------------------------------------- | :------------------------------------- | :----------------------------------------------------- | :--------------------------------- | :------------------------------------------- |
+| [Azuracast](/configuration/sources/azuracast)                           | [Active](./?sourceComm=active#by-communication-method)   | [Activity](./?sot=activity#by-data-source-of-truth) | ❌                                     | ✅                                                     | ✅                                 | ✅                                           |
+| [Deezer](/configuration/sources/deezer)                                 | [Active](./?sourceComm=active#by-communication-method)   | [History](./?sot=history#by-data-source-of-truth)   | ✅                                     | ✅                                                     | ❌                                 | ❌                                           |
+| [Google Cast (Chromecast)](/configuration/sources/google-cast)          | [Active](./?sourceComm=active#by-communication-method)   | [Activity](./?sot=activity#by-data-source-of-truth) | ✅                                     | ✅                                                     | ✅                                 | ❌                                           |
+| [Icecast](/configuration/sources/icecast)                               | [Active](./?sourceComm=active#by-communication-method)   | [Activity](./?sot=activity#by-data-source-of-truth) | ❌                                     | ✅                                                     | ✅                                 | ✅                                           |
+| [Jellyfin](/configuration/sources/jellyfin)                             | [Active](./?sourceComm=active#by-communication-method)   | [Activity](./?sot=activity#by-data-source-of-truth) | ✅                                     | ✅                                                     | ✅                                 | ❌                                           |
+| [JRiver](/configuration/sources/jriver)                                 | [Active](./?sourceComm=active#by-communication-method)   | [Activity](./?sot=activity#by-data-source-of-truth) | ❌                                     | ✅                                                     | ✅                                 | ❌                                           |
+| [Kodi](/configuration/sources/kodi)                                     | [Active](./?sourceComm=active#by-communication-method)   | [Activity](./?sot=activity#by-data-source-of-truth) | ❌                                     | ✅                                                     | ✅                                 | ❌                                           |
+| [Koito](/configuration/sources/koito-source)                            | [Active](./?sourceComm=active#by-communication-method)   | [History](./?sot=history#by-data-source-of-truth)   | ❌                                     | ✅                                                     | ❌                                 | ❌                                           |
+| [Last.fm](/configuration/sources/lastfm-source)                         | [Active](./?sourceComm=active#by-communication-method)   | [History](./?sot=history#by-data-source-of-truth)   | ❌                                     | ✅                                                     | ❌                                 | ❌                                           |
+| [Last.fm (Endpoint)](/configuration/sources/lastfm-endpoint)            | [Ingress](./?sourceComm=ingress#by-communication-method) | [History](./?sot=history#by-data-source-of-truth)   | ❌                                     | ✅                                                     | ❌                                 | ❌                                           |
+| [ListenBrainz](/configuration/sources/listenbrainz-source)              | [Active](./?sourceComm=active#by-communication-method)   | [History](./?sot=history#by-data-source-of-truth)   | ❌                                     | ✅                                                     | ❌                                 | ❌                                           |
+| [ListenBrainz (Endpoint)](/configuration/sources/listenbrainz-endpoint) | [Ingress](./?sourceComm=ingress#by-communication-method) | [History](./?sot=history#by-data-source-of-truth)   | ❌                                     | ✅                                                     | ❌                                 | ❌                                           |
+| [Maloja](/configuration/sources/maloja)                                 | [Active](./?sourceComm=active#by-communication-method)   | [History](./?sot=history#by-data-source-of-truth)   | ❌                                     | ✅                                                     | ❌                                 | ❌                                           |
+| [Mopidy](/configuration/sources/mopidy)                                 | [Active](./?sourceComm=active#by-communication-method)   | [Activity](./?sot=activity#by-data-source-of-truth) | ❌                                     | ✅                                                     | ✅                                 | ❌                                           |
+| [MPD (Music Player Daemon)](/configuration/sources/mpd)                 | [Active](./?sourceComm=active#by-communication-method)   | [Activity](./?sot=activity#by-data-source-of-truth) | ❌                                     | ✅                                                     | ✅                                 | ❌                                           |
+| [Musikcube](/configuration/sources/musikcube)                           | [Active](./?sourceComm=active#by-communication-method)   | [Activity](./?sot=activity#by-data-source-of-truth) | ❌                                     | ✅                                                     | ✅                                 | ❌                                           |
+| [Plex](/configuration/sources/plex)                                     | [Active](./?sourceComm=active#by-communication-method)   | [Activity](./?sot=activity#by-data-source-of-truth) | ✅                                     | ✅                                                     | ✅                                 | ❌                                           |
+| [Rocksky](/configuration/sources/rocksky-source)                        | [Active](./?sourceComm=active#by-communication-method)   | [History](./?sot=history#by-data-source-of-truth)   | ❌                                     | ✅                                                     | ❌                                 | ❌                                           |
+| [Spotify](/configuration/sources/spotify)                               | [Active](./?sourceComm=active#by-communication-method)   | [Activity](./?sot=activity#by-data-source-of-truth) | ✅                                     | ✅                                                     | ✅                                 | ❌                                           |
+| [Subsonic-compatible APIs](/configuration/sources/subsonic)             | [Active](./?sourceComm=active#by-communication-method)   | [Activity](./?sot=activity#by-data-source-of-truth) | ✅                                     | ✅                                                     | ✅                                 | ❌                                           |
+| [teal.fm](/configuration/sources/tealfm-source)                         | [Active](./?sourceComm=active#by-communication-method)   | [History](./?sot=history#by-data-source-of-truth)   | ❌                                     | ✅                                                     | ❌                                 | ❌                                           |
+| [WebScrobbler](/configuration/sources/webscrobbler)                     | [Ingress](./?sourceComm=active#by-communication-method)  | [History](./?sot=history#by-data-source-of-truth)   | ❌                                     | ✅                                                     | ❌                                 | ❌                                           |
+| [VLC](/configuration/sources/vlc)                                       | [Active](./?sourceComm=active#by-communication-method)   | [Activity](./?sot=activity#by-data-source-of-truth) | ❌                                     | ✅                                                     | ✅                                 | ❌                                           |
+| [Yamaha MusicCast](/configuration/sources/yamaha-musiccast)             | [Active](./?sourceComm=active#by-communication-method)   | [Activity](./?sot=activity#by-data-source-of-truth) | ❌                                     | ✅                                                     | ✅                                 | ❌                                           |
+| [Youtube Music](/configuration/sources/youtube-music)                   | [Active](./?sourceComm=active#by-communication-method)   | [History](./?sot=history#by-data-source-of-truth)   | ❌                                     | ✅                                                     | ❌                                 | ❌                                           |
+
+## Features
+
+### Types of Sources
+
+The Sources implemented in multi-scrobbler can be broken down into two categories.
+
+#### By Communication Method
+
+How does this Source get data from the service/application?
+
+<Tabs groupId="sourceComm" queryString>
+    <TabItem value="active" label="Active">
+        The MS Source makes network requests to the service which returns a response with data MS can use to monitor listening activity or scrobbles.
+    </TabItem>
+    <TabItem value="ingress" label="Ingress">
+        The MS Source waits for the service/application to send data to multi-scrobbler.
+
+        These types of Sources require that multi-scrobbler is accessible to the service, generally through an open port or reverse proxy.
+    </TabItem>
+</Tabs>
+
+#### By Data Source of Truth
+
+How does MS determine if/when a song has been played and is scrobbable?
+
+<Tabs groupId="sot" queryString>
+    <TabItem value="activity" label="Listening Activity">
+        These Sources expose some kind of real-time listening data for users, like:
+
+        * player state (paused, stopped, playing)
+        * player position (1:50/2:40)
+        * current listened duration (Track A playing for 1m:20s)
+
+        For theses Sources multi-scrobbler keeps track of the real-time state of your activity and scrobbles a track after it meets certain [scrobble thresholds](#scrobble-thresholds).
+    </TabItem>
+    <TabItem value="history" label="Listening History">
+        Some Sources expose their own version of "this track has been scrobbled."
+
+        * Listenbrainz, Koito, and Last.fm are all scrobble services that have "definitive" histories of scrobbled tracks.
+
+        For these Sources multi-scrobbler monitors the listening history data and scrobbles when it sees a new entry in the list.
+    </TabItem>
+</Tabs>
+
+### Multi-Device/User
+
+Some Sources report which User is playing a track and/or on what device the track is being played. These Sources can be filtered with configuration to only monitor activity for specific devices or users.
+
+### Limiting Scrobble Destination
+
+To limit which Clients a Source will scrobble to use the `clients` property in a Source's [File/AIO configuration](/configuration?configType=file#configuration-types) to specify the **name** property of the Clients that it should scrobble to:
+
+```json5 title="jellyfin.json"
+{
+    "name": "MyJellyfin",
+    "clients": ["myMaloja","koitoA","listenbrainzFoo"]
+    "data": {
+        // ...
+    },
+}
+```
+
+:::note
+
+If `clients` is empty (`"clients": []`) or is omitted then the default is for the Source to scrobble to **all** configured Clients.
+
+:::
+
+:::note
+
+If a Client is configured using [ENV](/configuration?configType=env#configuration-types) then it is given a generated name. Check the multi-scrobbler Dashboard to find their name in a subheader under the Client type. Example:
+
+![Client Name Subheader](../client-subheader.png)
+
+Otherwise, use the `name` property you gave the client in it's File/AIO config.
+
+:::
+
+### Scrobble Thresholds
+
+<ScrobbleThreshold filename="spotify"/>
+
+These can also be configured **globally** for all Sources using ENVs:
+
+```
+SOURCE_SCROBBLE_DURATION=40
+SOURCE_SCROBBLE_PERCENT=20
+```
+
+### Should Scrobble Behavior
+
+:::note
+
+This feature is currently available only for some Sources. Check each Source's documentation to see if it supported.
+
+:::
+
+For _most_ Sources multi-scrobbler can determine if a user is listening and scrobble automatically. For Sources which multi-scrobbler cannot do this or require additional configuration, a user can indicate to MS that it should or should not scrobble. This action can be taken on the Web Dashboard by clicking the link next to **Should Scrobble** found in each Source's status card.
+
+Additionally, for these Sources, the default behavior for Scrobbling can be explicitly set by adding the following value to a Source's `options` in [file or aio config](/configuration?configType=file#configuration-types):
+
+```json5 title="azuracast.json"
+{
+    "data": {
+        // ...
+    },
+    "options": {
+        // set to true to always scrobble automatically
+        // set to false to never scrobble automatically
+        "systemScrobble": true
+    }
+}
+```

docsite/docs/configuration/sources/spotify.mdx

@@ -0,0 +1,105 @@
+---
+title: Spotify
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import SpotifyConfig from '!!raw-loader!@site/../config/spotify.json.example';
+
+<details>
+
+<summary>Spotify and Automix</summary>
+
+If your Spotify player has [Automix](https://community.spotify.com/t5/FAQs/What-is-Automix/ta-p/5257278) enabled and Spotify uses it for your playlist/queue then MS cannot accurately determine when a track will end. This is because the track is "mixed" in your queue with a shorter play time than its actual length and [Spotify does not report this modified play time in its API.](https://community.spotify.com/t5/Spotify-for-Developers/Wrong-duration-ms-of-track-with-Automix/m-p/5429147) This **does not affect MS's ability to scrobble** from Spotify but it will affect the accuracy of the duration MS reports was played.
+
+</details>
+
+#### Authenticate Spotify with Multi-Scrobbler
+
+To access your Spotify history you must [create a Spotify App](https://developer.spotify.com/dashboard) to get a
+Client ID/Secret.
+
+1. **Login to https://developer.spotify.com** with your existing Spotify account and accept Developer Terms
+
+2. Navigate to your Spotify Developer [Dashboard](https://developer.spotify.com/dashboard) and start the **Create App** process
+
+3. Determine the correct **Redirect URI** to use and set it in your App settings
+
+<details>
+
+<summary>Redirect URI Instructions</summary>
+
+A Redirect URI is the URL that Spotify will navigate your **browser** to after you complete authorization. The URL will contain the code necessary for multi-scrobbler to get a Spotify access token.
+
+Spotify [**no longer allows insecure URIs**](https://developer.spotify.com/documentation/web-api/tutorials/migration-insecure-redirect-uri) (start with `http://`) unless the address is `127.0.0.1` -- so `localhost` and internal IPs (`192.168.0.xxx`) no longer work.
+
+Use **one** of the following methods to specify a valid Redirect URI and complete Spotify authentication with multi-scrobbler:
+
+<Tabs groupId="spotifyRedirect" queryString>
+    <TabItem value="https" label="HTTPS">
+        **Use a domain you control, with SSL certificates/HTTPS enabled, to create a valid redirect URI.**
+        
+        For example, if you are already running multi-scrobbler behind a reverse proxy (nginx/traefik/caddy) at `https://scrobbler.mydomain.com` then set the Spotify Redirect URI for your Spotify App, and multi-scrobbler `SPOTIFY_REDIRECT_URI` ENV, to `https://scrobbler.mydomain.com/callback`
+
+        Alternatively, if multi-scrobbler is not accessible behind your domain, then use the [**Echo**](./?spotifyRedirect=echo) method with your own domain instead of 127.0.0.1.
+    </TabItem>
+    <TabItem value="local" label="Run MS Locally">
+        **Run multi-scrobbler, configured for a Spotify Source, from the same machine as your browser in order to get credentials.**
+        
+        In this scenario you can use `http://127.0.0.1:9078/callback` as the Spotify Redirect URI and multi-scrobbler `SPOTIFY_REDIRECT_URI` ENV.
+        
+        After completing authentication, copy the contents of local multi-scrobbler's [configuration folder](/installation#storage) to the final location of where multi-scrobbler will be run.
+    </TabItem>
+    <TabItem value="echo" label="Echo">
+        **Use a docker container on the same machine your browser is on to "intercept" the callback URL from Spotify authentication, then manually finish the process by changing the domain to your multi-scrobbler instance.**
+
+
+        1. Create a container on the same machine as your browser using the [`mendhak/http-https-echo:36`](https://github.com/mendhak/docker-http-https-echo) image. This container runs a simple HTTP server that echos back any request it recieves.
+
+        ```shell
+        docker run --rm -p 127.0.0.1:5079:8080 mendhak/http-https-echo:36
+        ```
+
+        2. Set the Spotify Redirect URI and multi-scrobbler `SPOTIFY_REDIRECT_URI` ENV as `http://127.0.0.1:5079/callback`
+
+        3. In [Authenticate Spotify with Multi-Scrobbler](#authenticate-spotify-with-multi-scrobbler) (outside these Redirect Instructions) go to **Step 4** and continue the instructions
+
+        Eventually, Spotify will redirect you to a web page with a URL like `http://127.0.0.1:5079/callback?code=xxxxxx...`
+
+        ![echo](../echo.png)
+
+        4. In the URL, replace `127.0.0.1:5079` with the address/IP for your multi-scrobbler instance so the URL is similar to `http://192.168.0.101:9078/callback?code=xxxxxx...`. Then navigate to this URL to complete authentication.
+
+    </TabItem>
+
+    <TabItem value="msEcho" label="Echo from echo.multi-scrobbler.app">
+        For your convenience, I run the [`mendhak/http-https-echo:36`](https://github.com/mendhak/docker-http-https-echo) container from the [**Echo**](./?spotifyRedirect=echo) approach on a domain I, the multi-scrobbler developer [FoxxMD](https://github.com/FoxxMD), control and self-host. Please be aware:
+        
+        * I **do not collect personal data** or any querystrings/data sent in requests to this site
+        * It's **not possible** for me to use the code sent by Spotify to this URL without also having your Client ID/Secret
+        * However, there is **always** risk involved with trusting a service you do not control. Evaluate the risk of using this site for yourself.
+
+        Use the [**Echo**](./?spotifyRedirect=echo) approach, starting from **Step 2**, with **https://echo.multi-scrobbler.app/callback** as Spotify Redirect URI and multi-scrobbler `SPOTIFY_REDIRECT_URI` ENV.
+    </TabItem>
+</Tabs>
+
+</details>
+
+4. Save your new App, then copy the Client ID/Secret from the App's Basic Information page.
+
+5. Add the Client ID, Secret, and Redirect URI to the respective field/ENV in the [configuration section below](#configuration)
+
+6. Start multi-scrobbler, then visit the Web Dashboard and click **(Re)authenticate** on the Spotify card to start the auth process
+
+## Configuration
+
+<Config config="SpotifySourceConfig" fileContent={SpotifyConfig} name="spotify">
+    | Environmental Variable  | Required? | Default                          | Description                |
+    | ----------------------- | --------- | -------------------------------- | -------------------------- |
+    | `SPOTIFY_CLIENT_ID`     | Yes       |                                  |                            |
+    | `SPOTIFY_CLIENT_SECRET` | Yes       |                                  |                            |
+    | `SPOTIFY_REDIRECT_URI`  | No        | `http://localhost:9078/callback` | URI must end in `callback` |
+</Config>

docsite/docs/configuration/sources/subsonic.mdx

@@ -0,0 +1,39 @@
+---
+title: Subsonic
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import SubsonicConfig from '!!raw-loader!@site/../config/subsonic.json.example';
+
+This Source can be used for any application that implements the [Subsonic API](http://www.subsonic.org/pages/api.jsp) and supports the [`getNowPlaying`](http://www.subsonic.org/pages/api.jsp#getNowPlaying) endpoint (such as [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/))
+
+:::warning[Known Issues]
+
+* Multiple artists are reported as one value and cannot be separated
+* If using [Airsonic Advanced](https://github.com/airsonic-advanced/airsonic-advanced) the password used (under **Credentials**) must be **Decodable**
+
+:::
+
+:::tip
+
+If your serivce supports scrobbling to **Listenbrainz** (such as Navidrome), considering using a [**Listenbrainz (Endpoint)** Source](/configuration/sources/listenbrainz-endpoint) instead of this one.
+
+Service-specific scrobble implementations tend to be more accurate and provide more information (multiple artists) compared to the Subsonic API.
+
+:::
+
+Use the optional `usersAllow` property with **File** or **AIO** configuration to restrict scrobbling to a list of defined users.
+
+## Configuration
+
+<Config config="SubsonicSourceConfig" fileContent={SubsonicConfig} name="subsonic">
+        | Environmental Variable | Required? | Default | Description                          |
+        |------------------------|-----------|---------|--------------------------------------|
+        | `SUBSONIC_USER`        | Yes       |         |                                      |
+        | `SUBSONIC_PASSWORD`    | Yes       |         |                                      |
+        | `SUBSONIC_URL`         | Yes       |         | Base url of your subsonic-api server |
+</Config>

docsite/docs/configuration/sources/tealfm-source.mdx

@@ -0,0 +1,39 @@
+---
+title: Teal.fm
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import JsonConfig from '!!raw-loader!@site/../config/tealfm.json.example';
+
+:::tip[Other Uses]
+
+* To **scrobble to** an ATProto PDS, create a [teal.fm (Client)](/configuration/clients/tealfm)
+
+:::
+
+[**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).
+
+This Source monitors the teal.fm scrobbles in your PDS and then re-scrobbles discovered tracks to configured clients.
+
+Learn more about how teal.fm scrobbles work in the [teal.fm (Client)](/configuration/clients/tealfm) docs. 
+
+## Setup
+
+Follow the **Setup** instructions in the [teal.fm (Client)](/configuration/clients/tealfm#setup) docs to get access to your Bluesky PDS repository and scrobble data.
+
+## Configuration
+
+See the [teal.fm (Client)](/configuration/clients/tealfm#setup) configuration for general setup. The only difference for **Source** configuration:
+
+* Cannot be setup with ENV config 
+* [File/AIO config](/configuration?configType=file#configuration-types) must include `"configureAs": "source"`
+
+<Config config="TealClientConfig" fileContent={JsonConfig} name="tealfm">
+        :::note
+            You cannot use ENV variables shown in the [teal.fm Client config](/configuration/clients/tealfm#configuration) -- multi-scrobbler assumes teal.fm ENVs are always used for the **client** configuration. You must use the [File or AIO](/configuration?configType=file#configuration-types) config to setup teal.fm as a Source.
+        :::
+</Config>

docsite/docs/configuration/sources/vlc.mdx

@@ -0,0 +1,94 @@
+---
+title: VLC
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import JsonConfig from '!!raw-loader!@site/../config/vlc.json.example';
+
+MS communicates with [VLC](https://www.videolan.org/vlc/) using the [Web (`http`) interface module](https://wiki.videolan.org/VLC_HTTP_requests/)
+
+#### Enable HTTP Interface
+
+Open VLC:
+
+* **Tools** Menu -> Preferences
+  * In the bottom left change **Show Settings** from `Simple` to `All`
+  * In the updated window select `Interface -> Main interfaces`
+     * In the **Extra interface modules** section enable **Web** and verify that `http` is shown in the textbox
+  * Select `Interface -> Main interfaces -> Lua`
+    * In Lua HTTP -> Password -> set a password in this box
+  * Click **Save** at the bottom to persist your changes
+* Restart VLC
+* Verify the HTTP interface is accessible by navigating to `http://localhost:8080` in your browser
+
+If the interface is accessible, after typing in your password, VLC  is now ready to be used by MS.
+
+##### Setting VLC Interface and Port
+
+These can be set by starting VLC from command line with specific options:
+
+* `vlc --http-host yourHostIp:yourPort` or
+* `vlc --http-port yourPort` or
+* modify the configuration file for VLC by editing keys with the same values as from the command line (`http-host` and `http-port`)
+
+
+#### Filename Parsing
+
+If the file being played in VLC does not have ID3 tags/metadata information multi-scrobbler can attempt to extract artist, title, and album information from the raw filename using regular expressions. Mutli-scrobbler will only do this if there is **no other information** reported by VLC about these fields.
+
+To extract this information use [named capture groups](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Regular_expressions/Named_capturing_group) in your expression matching the field that should be extracted: `artist` `title` and/or `album`. MS accepts multiple expressions, the first one that matches a filename will be used.
+
+Example usage in [a file-based config:](/configuration?configType=file#configuration-types)
+
+```json5 title="config/vlc.json" {10-15}
+[
+  {
+    "name": "MyVlc",
+    "enable": true,
+    "data": {
+      // ...
+    },
+    "options": {
+      "filenamePatterns": [
+          // Extracts artist and title from filenames that look like:
+          // My Artist - My Cool title.mp4
+          "/^\\s*(?<artist>.+?) - (?<title>.+?)\\.\\w+$/i"
+        ],
+      // logs to DEBUG when MS tries to extract data from a filename
+      "logFilenamePatterns": true,
+    }
+  }
+]
+```
+
+#### Vlc Information Reporting
+
+If you find that VLC is incorrectly reporting track information (in its interface) but multi-scrobbler is not parsing it correctly it may be due to the _name_ of the fields VLC is reporting. mutli-scrobbler uses the most common field name but does not cover all use cases. Before reporting an issue please turn on metadata logging and include output from your logs while it is turned on:
+
+```json5 title="config/vlc.json" {9-9}
+    [
+      {
+        "name": "MyVlc",
+        "enable": true,
+        "data": {
+          // ...
+        },
+        "options": {
+          "dumpVlcMetadata": true
+        }
+      }
+    ]
+```
+
+## Configuration
+
+<Config config="VLCSourceConfig" fileContent={JsonConfig} name="vlc">
+        | Environmental Variable | Required?  | Default          | Description |
+        |------------------------|------------|------------------|-------------|
+        | `VLC_URL`              | No         | `localhost:8080` |             |
+        | `VLC_PASSWORD`         | Yes        |                  |             |
+</Config>

docsite/docs/configuration/sources/webscrobbler.mdx

@@ -0,0 +1,95 @@
+---
+title: Webscrobbler
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import JsonConfig from '!!raw-loader!@site/../config/webscrobbler.json.example';
+
+After installing the [Webscrobbler extension](https://web-scrobbler.com/) open the preferences/settings for it:
+
+* Under **Accounts**
+  * **Add Webhook**
+    * API URL: `[YourMultiScrobblerInstance]/api/webscrobbler` EX `http://localhost:9078/api/webscrobbler`
+    * Application name: `(whatever you want)`
+
+Reload the extension after adding the webhook.
+
+:::note
+
+* **On Firefox** - Only FQNs (domain.tld), `localhost`, and `127.0.0.1` are supported for API URL due to [firefox requiring https](https://github.com/web-scrobbler/web-scrobbler/issues/4183#issuecomment-1749222006)
+* **On Chromium-based Browsers** - Any domain will work for API URL
+* All other browsers are untested
+
+:::
+
+:::warning
+
+Multi-scrobbler is **not** designed to be publicly accessible from the internet. To use Webscrobbler outside your local network you should be accessing MS through a VPN or through a reverse proxy with some kind of authentication (though this is still not recommended).
+
+:::
+
+### Multiple Users
+
+If you would like use multiple WebScrobbler sources they can be matched using a **slug** at the end of the **API URL.** This requires using [a file-based config.](/configuration?configType=file#configuration-types)
+
+<details>
+
+    <summary>Example</summary>
+
+    ```json title="webscrobbler.json"
+    [
+      {
+        "name": "aUserWS",
+        "clients": [
+          "client1Maloja"
+        ],
+        "data": {
+          "slug": "usera"
+        }
+      },
+      {
+        "name": "bUserWS",
+        "clients": [
+          "client2Maloja"
+        ],
+        "data": {
+          "slug": "userb"
+        }
+      }
+    ]
+    ```
+
+    * To use `aUserWS` source set **API URL** to `http://localhost:9078/api/webscrobbler/usera`
+    * To use `bUserWS` source set **API URL** to `http://localhost:9078/api/webscrobbler/userb`
+
+    :::tip
+
+    `http://localhost:9078/api/webscrobbler` is matched with the first source that _that does not have a slug defined._
+
+    :::
+
+</details>
+
+### Connectors Black/Whitelist
+
+MS can be configured to only scrobble, or NOT scrobble, from some WS connectors. Use the name of the website from the [supported websites](https://web-scrobbler.com/) or from the **Connectors** tab in the extension. 
+
+:::note
+
+This affects **only** MS's behavior and does not affect the general connector behavior you have configured within the WebScrobbler extension.
+
+:::
+
+## Configuration
+
+<Config config="WebscrobblerSourceConfig" fileContent={JsonConfig} name="webscrobbler">
+        | Environmental Variable | Required? | Default | Description                                                              |
+        |------------------------|-----------|---------|--------------------------------------------------------------------------|
+        | WS_ENABLE              | No        |         | Set to 'true' to enable WS without needing to define other ENVs          |
+        | WS_WHITELIST           | No        |         | Only scrobble from these WebScrobbler Connectors. Comma-delimited list   |
+        | WS_BLACKLIST           | No        |         | Do not scrobble from these WebScrobbler Connectors. Comma-delimited list |
+</Config>

docsite/docs/configuration/sources/yamaha-musiccast.mdx

@@ -0,0 +1,37 @@
+---
+title: Yamaha MusicCast
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import JsonConfig from '!!raw-loader!@site/../config/musiccast.json.example';
+
+Monitor [MusicCast](https://usa.yamaha.com/products/contents/audio_visual/musiccast/index.html) device/receivers for music played on Network/USB/CD inputs.
+
+:::tip[Scrobbling Threshold]
+
+Musiccast may not correctly report track length. If this is the case you should reduce the "listened to" **duration** using [Scrobble Thresholds](/configuration/sources#scrobble-thresholds) so that multi-scrobbler scrobbles correctly.
+
+:::
+
+##### URL
+
+If only a domain/IP:PORT is provided to multi-scrobbler it will automatically append the default Musiccast API path. If your Musiccast device is located behind a custom URL (or reverse proxy) you should explicitly provide the base path to use.
+
+EX
+
+    | `url`                                   | Transformed URL                                 |
+    | --------------------------------------- | :---------------------------------------------- |
+    | `http://192.168.0.101`                  | `http://192.168.0.101/YamahaExtendedControl/v1` |
+    | `http://mydomain.com/reverseProxy/cast` | `http://mydomain.com/reverseProxy/cast`         |
+
+## Configuration
+
+<Config config="MusicCastSourceConfig" fileContent={JsonConfig} name="musiccast">
+        | Environmental Variable | Required? | Default | Description              |
+        | :--------------------- | :-------- | ------- | :----------------------- |
+        | `MCAST_URL`            | Yes       |         | The Musiccast device URL |  
+</Config>

docsite/docs/configuration/sources/youtube-music.mdx

@@ -0,0 +1,189 @@
+---
+title: Youtube Music
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+import Tabs from '@theme/Tabs';
+import TabItem from '@theme/TabItem';
+import CodeBlock from '@theme/CodeBlock';
+import JsonConfig from '!!raw-loader!@site/../config/ytmusic.json.example';
+
+:::warning
+
+Communication with YT Music is **unofficial** and not supported or endorsed by Google. This means that **this integration may stop working at any time** if Google decides to change how YT Music works in the browser.
+
+:::
+
+:::tip[Scrobble Troubleshooting]
+
+Due to monitoring being unofficial, listening history from YTM can be inconsistent and can cause missed scrobbles. 
+
+[**See the FAQ**](/FAQ.md#youtube-music-misses-or-duplicates-scrobbles) for a detailed explanation, how to see more details about MS's detection of tracks, and how to properly report an issue.
+
+:::
+
+#### Authentication {#ytm-auth}
+
+Only one of these methods needs to be used.
+
+<Tabs groupId="ytmAuth" queryString>
+    <TabItem value="cookie" label="Cookies">
+
+        Use instructions from 
+        
+        * https://github.com/patrickkfkan/Volumio-YouTube.js/wiki/How-to-obtain-Cookie or 
+        * https://ytmusicapi.readthedocs.io/en/stable/setup/browser.html#copy-authentication-headers 
+        
+        to get the **Cookie** value from a browser.
+
+        It is highly recommended to [get the cookie from an Incognito/Private Session](https://github.com/LuanRT/YouTube.js/issues/803#issuecomment-2504032666) to limit the chance the session is invalidated from normal browsing.
+
+        Add the cookie to your `ytmusic.json` config in `data` or as an ENV: 
+
+        ```json
+            {
+            "type": "ytmusic",
+            "enable": true,
+            "name": "MyYTM",
+            "data": {
+                "cookie": "__Secure-1PSIDTS=sidts-CjEB3EgAEvCd-......"
+            },
+            "options": {
+                "logAuthUpdateChanges": true,
+                "logDiff": true
+            }
+        }
+        ```
+
+        If MS gives you authentication errors (session invalidated) at some point in the future follow the same instructions to get new cookies.
+
+    </TabItem>
+    <TabItem value="oauth" label="OAuth Client">
+        :::warning
+
+        As of Sept 25' OAuth clients no longer seem to have permission to access the YTM service, as reported by the upstream YTM library developer and [several other users.](https://github.com/FoxxMD/multi-scrobbler/issues/345#issuecomment-3258518769)
+
+        If you have existing, working OAuth credentials keep using them but there is no gaurantee they will continue to work.
+
+        If you are setting up the YTM Source for the first time you should first try to use [Cookies](./?ytmAuth=cookie#ytm-auth).
+
+        :::
+
+        [Based on the instructions from here...](https://github.com/LuanRT/YouTube.js/issues/803#issuecomment-2479689924)
+
+        * Login to [Google Cloud console](https://console.cloud.google.com/) (create an account, if necessary)
+          * [Create a new project](https://console.cloud.google.com/projectcreate)
+        * Go to APIs and services.
+            * Configure the OAuth consent screen
+                * Use the old experience if possible
+                * If new is unavoidable then do not fill out any branding and under Authorized Domains you can delete the empty one (in order to save)
+                * Add yourself as an authorized user
+            * Navigate to Credentials
+                * Create Credentials -> choose "OAuth client ID"
+                    *  Application Type is **Web Application**
+                    * **Name** is whatever you want, leave Authorization Javascript origins blank
+                    * Authorized redirect URIs
+                        * This must be **exactly** the same as what is displayed in MS! For now leave it blank so we can generate it from MS first
+                * Create
+                    * In the newly created client popup save the **Client ID** and **Client Secret**, then copy them into `ytmusic.json` or appropriate ENVs:
+
+        ```json
+        {
+            "type": "ytmusic",
+            "enable": true,
+            "name": "MyYTM",
+            "data": {
+                "clientId": "8910....6jqupl.apps.googleusercontent.com",
+                "clientSecret": "GOCSPX-WGXL6BSuQ343..."
+            },
+            "options": {
+                "logAuthUpdateChanges": true,
+                "logDiff": true
+            }
+        }
+        ```
+
+        Now, start MS and during the YTMusic startup it will log something like this:
+
+        ```
+        Will use custom OAuth Client:
+        Client ID: ...
+        Client Secret: ...
+        Redirect URI: http://localhost:9078/api/ytmusic/callback?name=MyYTM
+        ```
+
+        If the beginning of the Redirect URI (before `api`) is EXACTLY how you would reach the MS dashboard from your browser (EX `http://localhost:9078`) then edit your google oauth client section for `Authorized redirect URIs` and add the URL MS has displayed.
+
+        If it is NOT EXACTLY the same you either need to set MS's [base url](https://foxxmd.github.io/multi-scrobbler/docs/configuration/#base-url) or you can provide your own (Custom) Redirect URI for MS to use by setting it in `ytmusic.json` or ENV.
+
+        <details>
+
+            <summary>Using a Custom Redirect URI</summary>
+
+                The three parts of the URL that must be the same:
+
+                * it must start with `api` (after domain or subdirectory IE `my.domain.tld/api...` or `whatever.tld/subDir/api...`
+                * it must end in `ytmusic/callback`
+                * It must include `name=[NameOfSource]` in the query string
+
+                Remember to add your custom URL to the `Authorized redirect URIs`  section in the google oauth client!
+
+                ```json
+                {
+                    "type": "ytmusic",
+                    "enable": true,
+                    "name": "MyYTM",
+                    "data": {
+                        "clientId": "8910....6jqupl.apps.googleusercontent.com",
+                        "clientSecret": "GOCSPX-WGXL6BSuQ343...",
+                        "redirectUri": "http://my.custom.domain/api/ytmusic/callback?name=MyYTM"
+                    },
+                    "options": {
+                        "logAuthUpdateChanges": true,
+                        "logDiff": true
+                    }
+                }
+                ```
+
+        </details>
+
+        AFTER changing the Authorized redirect URIs on Google Cloud console you may need to wait a few minutes for it to take affect. Then restart MS. From the dashboard click `(Re)authenticate` on the YTmusic source card and follow the auth flow:
+
+        * On the screen about "testing" make sure you hit **Continue** (not Back To Safety)
+        * Make sure to select ALL scopes/permissions/grants it asks you about
+          * `Select what [YourAppName] can access` -> Select all
+
+        Once the flow is finished MS will get the credentials and start polling automatically. You should not need to re-authenticate again after restarting MS as it saves the credentials to the `/config` folder.
+            
+    </TabItem>
+    <TabItem value="ytt" label="YoutubeTV">
+
+        :::warning
+
+        Using the built-in YoutubeTV authentication is unlikely to work due to [Google restricting what permissions TV clients can have](https://github.com/yt-dlp/yt-dlp/issues/11462#issuecomment-2471703090). This authentication method should not be used.
+        
+        :::   
+
+        To authenticate start multi-scrobbler with an empty YT Music configuration. An authentication URL/code will be logged in additon to being available from the dashboard.
+
+        ```
+        ERROR: Sign in with the code 'CLV-KFA-BVKY' using the authentication link on the dashboard or https://www.google.com/device
+        ```
+
+        Visit the authentication URL and enter the code that was provided (also available on the dashboard). After completing the setup flow MS will log `Auth success` and the YT Music dashboard card will display as **Idle** after refreshing. Click the **Start** link to begin monitoring.
+
+    </TabItem>
+</Tabs>
+
+## Configuration
+
+<Config config="YTMusicSourceConfig" fileContent={JsonConfig} name="ytmusic">
+| Environmental Variable | Required? | Default |                  Description                  |
+|------------------------|-----------|---------|-----------------------------------------------|
+| YTM_COOKIE             | No        |         | Value for Cookie Authentication               |
+| YTM_CLIENT_ID          | No        |         | Client ID for OAuth Athentication             |
+| YTM_CLIENT_SECRET      | No        |         | Client Secret for OAuth Athentication         |
+| YTM_REDIRECT_URI       | No        |         | A custom redirect URI for OAuth Athentication |
+| YTM_LOG_DIFF           | No        | false   | Log YTM history changes                       |
+</Config>

docsite/docs/configuration/transforms.mdx

@@ -1,483 +0,0 @@
----
-sidebar_position: 4
-title: Scrobble Modification
-toc_max_heading_level: 4
----
-
-Multi-scrobbler configs support the ability to modify scrobble data in an automated fashion by matching and replacing strings in **title, artists, and album** at many different times in multi-scrobbler's lifecycle.
-
-### Why?
-
-You may need to "clean up" data from a Source or before sending to a scrobble Client due to any number of reasons:
-
-* ID3 tags in your music collection are dirty or have repeating garbage IE `[YourMusicSource.com] My Artist - My Title`
-* A Source's service often incorrectly adds data to some field IE `My Artist - My Title (Album Version)` when the title should just be `My Title`
-* An Artist you listen to often is spelled different between a Source and a Client which causes duplicate scrobbles
-
-In any scenario where a repeating pattern can be found in the data it would be nice to be able to fix it before the data gets downstream or to help prevent duplicate scrobbling. Multi-scrobbler can help you do this.
-
-## Overview
-
-### Journey of a Scrobble
-
-First, let's recap the lifecycle of a scrobble in multi-scrobbler:
-
-**Sources** are the beginning of the journey for a **Play** (song you've listened to long enough to be scrobblable)
-
-* A Source finds a new valid **Play**
-* The Source **compares** this new Play to all the other Plays it has already seen, if the Play is unique (title/artist/album/listened datetime) then...
-* The Source **discovers** the Play, adds it to Plays it has seen already, and broadcasts the Play should be scrobbled to all Clients
-
-Scrobble **Clients** listen for discovered Plays from Sources, then...
-
-* A Client receives a **Play** from a Source
-* The Client **compares** this Play to all the other scrobbles it has already seen, if the Play is unique (title/artist/album/listened datetime) then...
-* The Client **scrobbles** the Play downstream to the scrobble service and adds it as a Scrobble it has seen already
-
-### Lifecyle Hooks
-
-You'll notice there is a pattern above that looks like this:
-
-* **Before** data is compared
-* Data is **compared**
-* **After** data is compared
-
-These points, during both Source and Client processes, are when you can hook into the scrobble lifecycle and modify it.
-
-#### TLDR
-
-In more concrete terms this is the structure of hooks within a configuration (can be used in any **Source** or **Client**):
-
-```json5 title="lastfm.json" {10-14}
-[
-  {
-    "name": "myLastFm",
-    "enable": true,
-    "configureAs": "source",
-    "data": {
-      // ...
-    },
-    "options": {
-      "playTransform": {
-        "preCompare": {/* ... */},
-        "compare": {/* ... */},
-        "postCompare": {/* ... */}
-      }
-    }
-  }
-]
-```
-
-##### Hook
-
-For **Sources**:
-
-* `preCompare` - modify Play data immediately when received
-* `compare` - temporarily modify Play data when it is being compared to see if Play was already discovered
-* `postCompare` - modify Play data before sending to scrobble **Clients**
-
-For **Clients**:
-
-* `preCompare` - modify Play data immediately when received
-* `compare` - temporarily modify Play data when it is being compared to see if it was already scrobbled
-* `postCompare` - modify Play data before scrobbling it to downstream service and adding to already seen scrobbles
-
-:::tip
-
-Keep in mind that modifying Scrobble/Play data earlier in the lifecycle will affect that data at all times later in the lifecycle.
-
-For example, to modify the track so it's the same anywhere it is processed in multi-scrobbler you only need to modify it in the **Source's** `preCompare` hook because all later processes will receive the data with the modified track.
-
-:::
-
-### Modification Parts
-
-
-Each [**hook**](#hook) (`preCompare` etc...) is an object that specifies what part of the **Play** to modify:
-
-```json5
-{
-    "title": [/* ... */],
-    "artists": [/* ... */],
-    "album": [/* ... */]
-}
-```
-
-##### Expression
-
-and then a **list** what pattern/replacements (expressions) to use for the modification by using either simple strings or `search-replace` objects:
-
-```json5
-[
-  "badTerm", // remove all instances of 'badTerm'
-  {
-    "search": "anotherBadTerm", // and also match all instances of 'anotherBadTerm'
-    "replace": "goodTerm" // replace with the string 'goodTerm'
-  }
-]
-```
-
-Putting it all together:
-
-```json5 title="lastfm.json"
-[
-  {
-    "name": "myLastFm",
-    "enable": true,
-    "configureAs": "source",
-    "data": {
-      // ...
-    },
-    "options": {
-      "playTransform": {
-        "preCompare": {
-          "title": [
-            [
-              "badTerm",
-              {
-                "search": "badTerm",
-                "replace": "goodTerm"
-              }
-            ]
-          ]
-        },
-      }
-    }
-  }
-]
-```
-
-:::note
-
-If the value of the field (title, an artist, album) is an empty string after transforming then the field is **removed.**
-
-:::
-
-:::tip
-
-Modifications can also be applied to **all Sources** or **all Clients** when using the [AIO Config](./configuration.mdx?configType=aio#configuration-types) `config.json` by setting `playTransform` in `sourceDefaults` or `clientDefaults`:
-
-<details>
-
-    <summary>Example</summary>
-```json5 title="config.json"
-{
-  "sourceDefaults": { // will apply playTransform to all sources
-    "playTransform": {
-      "preCompare": {
-        "title": [
-          "(Album Version)"
-        ]
-      }
-    }
-  },
-  "sources": [/* ... */],
-  "clients": [/* ... */]
-}
-```
-</details>
-
-:::
-
-#### Compare Hook
-
-The `compare` [hook](#hook) is slightly different than `preCompare` and `postCompare`. It consists of an object where you define which side(s) of the comparison should be modified. It also **does not modify downstream data!** Instead, the modifications are made only for use in the comparison.
-
-```json5 title="lastfm.json"
-[
-  {
-    "name": "myLastFm",
-    // ...
-    "options": {
-      "playTransform": {
-        "compare": {
-          "candidate": {/* ... */}, // modify the "new" Play being compared
-          "existing": {/* ... */}, // modify all "existing" Play/Scrobbles the new Play is being compared against
-        },
-      }
-    }
-  }
-]
-```
-
-#### Regular Expressions
-
-In addition to plain strings [expressions](#expression) that are matched and removed you can also use Regular Expressions. Write your regex like you normally would, but as a string, and it'll automatically be parsed:
-
-```json5
-[
-  "/^\(\w+.com)/i", // matches any string that starts with '(YourMusic.com)' and removes it
-  {
-    "search": "/^\(\w+.com)/i", // matches any string that starts with '(YourMusic.com)'
-    "replace": "[MySite.com]" // replace with the string '[MySite.com]'
-  }
-]
-```
-
-The `replace` property uses javascript's [`replace()` function and so can use any special string characters.](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/replace#specifying_a_string_as_the_replacement)
-
-### Conditional Modification
-
-#### "When" Condition
-
-Top-level hooks **and** individual rules also support a `when` key for testing **if they should be run.**
-
-The `when` key is similar to a normal [modification](#modification-parts) except:
-
-* the keys accept a single string instead of an array
-* the `when` key data is an array instead of a single object
-
-All parts of an individual `when` clause must test true to "pass" but if **any** `when` clauses pass the hook/rule is processed. Example `when` data:
-
-```json5
-{
-  "when": [
-    {
-      "artist": "Elephant Gym", // both of these must match the Play object (AND)
-      "album": "Dreams" // both of these must match the Play object (AND)
-    },
-    // OR
-    {
-      "title": "/(Remastered)$/", // both of these must match the Play object (AND)
-      "album": "Various Artists" // both of these must match the Play object (AND)
-    }
-  ]
-}
-```
-
-More succinctly:
-
-* All parts (`artist` `album` `title`) of a `when` are `AND` conditions
-* All part-objects in the `when` array are `OR` conditions
-
-<details>
-
-<summary>Example of top-level hook with when condition</summary>
-
-```json5
-{
-  // IF the artist is Elephant Gym 
-  // THEN Run preCompare hook ELSE skip this hook
-  //
-  //    Run search-replace on album
-  //    Run regex title remove
-  "sourceDefaults": {
-    "playTransform": {
-      "preCompare": {
-        "when": [
-          {
-            "artist": "/Elephant Gym/"
-          }
-        ],
-        "album": [
-          {
-            "search": "Dreams",
-            "replace": "夢境"
-          }
-        ],
-        "title": ["/\s\-\s滾石40\s滾石撞樂隊\s40團拚經典(.+)$/i"]
-      },
-    }
-  }
-}
-```
-
-</details>
-
-<details>
-
-<summary>Example of individual rule with when condition</summary>
-
-```json5
-{
-  // Always run preCompare
-  //
-  //   On search-replace in title...
-  //     IF artist matches "Elephant Gym"
-  //     THEN Run regex search-replace ELSE skip this rule
-  //
-  //   Run live|remastered regex remove
-  "sourceDefaults": {
-    "playTransform": {
-      "preCompare": {
-        "title": [
-          {
-            "search": "/\\s\\-\\s滾石40\\s滾石撞樂隊\\s40團拚經典(.+)$/i",
-            "replace": "",
-            "when": [
-              {
-                "artist": "/Elephant Gym/"
-              }
-            ]
-          },
-          "/(\\s\\-\\s|\\s)(feat\\.(.+)|live|remastered(.+))$/i"
-        ],
-      }
-    }
-  }
-}
-```
-
-</details>
-
-#### Top-level Hook array
-
-Top-level hooks can also be an array of hooks. This makes creating multiple scenarios for top-level `when`-gated hooks easier. All hooks in the array will be run (assuming their `when`'s pass, if they exist) and their **input will be the Play object output of the previous hook in the array.**
-
-<details>
-
-<summary>Example</summary>
-
-```json5
-{
-  "sourceDefaults": {
-    "playTransform": {
-      "preCompare": [
-        // first lifecycle hook of preCompare to run
-        {
-          "title": [
-            {
-              "search": "something",
-              "replace": "else unique"
-            }
-          ]
-        },
-        // second lifecycle hook of preCompare to run
-        {
-          "title": [
-            {
-              "search": "else unique",
-              "replace": "very demure"
-            }
-          ]
-        },
-      ]
-    }
-  }
-}
-```
-
-</details>
-
-### Logging
-
-MS can log the output of hook transformations if/when they occur. In the `playTransform` object of a Source/Client config use `log`:
-
-* `"log": true` => Output original play + final transformed output of last hook in the array
-* `"log": "all"` => Output original play + final transformed output of **each** hook in the array
-
-```json5
-{
-  "name": "myThing",
-  "data": {/*...*/},
-  "options": {
-    "playTransform": {
-      "preCompare": {/*...*/},
-      "log": true
-    }
-  }
-}
-```
-
-## Examples
-
-### Remove phrase from Title in all new Plays
-
-Removes the phrase `(Album Version)` from the Title of a Play
-
-
-<details>
-
-    <summary>Example</summary>
-```json5 title="config.json"
-{
-  "sourceDefaults": {
-    "playTransform": {
-      "preCompare": {
-        "title": [
-          "(Album Version)"
-        ]
-      }
-    }
-  }
-}
-
-```
-</details>
-
-### Remove all parenthesized content from the end of a title
-
-<details>
-
-    <summary>Example</summary>
-```json5 title="lastfm.json"
-[
-  {
-    "name": "myLastFm",
-    // ...
-    "options": {
-      "playTransform": {
-        "compare": {
-          "candidate": {
-          "title": [
-              "/(\(.+\))\s*$/"
-            ]
-          },
-          "existing": {
-          "title": [
-              "/(\(.+\))\s*$/"
-            ]
-          },
-        },
-      }
-    }
-  }
-]
-```
-</details>
-
-### Rename misspelled artist in all new Plays
-
-<details>
-
-    <summary>Example</summary>
-```json5 title="config.json"
-{
-  "sourceDefaults": {
-    "playTransform": {
-      "preCompare": {
-        "artists": [
-          {
-            "search": "Boz Skaggs",
-            "replace": "Boz Scaggs"
-          }
-        ]
-      }
-    }
-  }
-}
-```
-</details>
-
-### Remove "Various Artists" albums in all new Plays
-
-<details>
-
-    <summary>Example</summary>
-```json5 title="config.json"
-{
-  "sourceDefaults": {
-    "playTransform": {
-      "preCompare": {
-        "album": [
-          {
-            "search": "Various Artists",
-            "replace": ""
-          }
-        ]
-      }
-    }
-  }
-}
-```
-</details>

docsite/docs/configuration/transforms/_category_.json

@@ -0,0 +1,7 @@
+{
+  "label": "Enhance Scrobbles",
+  "link": {
+    "type": "doc",
+    "id": "configuration/transforms/transforms"
+  }
+}