chore: Bump for release

feat: Enrich Listenbrainz submit payload

.devcontainer/devcontainer.json

@@ -0,0 +1,38 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/javascript-node
+{
+	"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-20-bookworm",
+
+	// 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,3000],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "npm install",
+
+	// Configure tool-specific properties.
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"hbenl.vscode-mocha-test-adapter",
+				"dbaeumer.vscode-eslint",
+				"unifiedjs.vscode-mdx"
+			]
+		}
+	},
+	"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

@@ -2,6 +2,7 @@
 node_modules
 npm-debug.log
 Dockerfile
+*.Dockerfile
 .dockerignore
 .gitignore
 .github
@@ -10,5 +11,20 @@ Dockerfile
 .idea
 config/*.json
 config/*.bak
+config/*.p8
 /docs
 /logs
+.flatpak-builder
+**/generated-sources.*
+flatpak/.flatpak-builder
+docsite/build
+docsite/node_modules
+docsite/.docusaurus
+docsite/.cache-loader
+build
+*.secrets
+.devcontainer
+.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/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/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.4.0 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

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

.github/act/.env.example

@@ -0,0 +1,5 @@
+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/.secrets.example

@@ -0,0 +1,3 @@
+DOCKER_PASSWORD=
+DOCKER_USERNAME=
+GITHUB_TOKEN=

.github/act/README.md

@@ -0,0 +1,53 @@
+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. 
+
+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
+
+```shell
+act -W '.github/act/actTest.yml' -e '.github/act/actBranchEvent.json'
+```
+
+
+### Test Tag (Release) Push
+
+```shell
+act -W '.github/act/actTest.yml' -e '.github/act/actTagEvent.json'
+```
+
+
+### Test Tag (Pre-Release) Push
+
+```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

@@ -0,0 +1,4 @@
+{
+  "ref": "refs/heads/master",
+  "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/actTagEvent.json

@@ -0,0 +1,8 @@
+{
+  "ref": "refs/tags/0.8.4",
+  "ref_name": "0.8.4",
+  "before": "0000000000000000000000000000000000000000",
+  "after": "005dae76ab51799d3d55112738e301cb1af0dafd",
+  "sha": "005dae76ab51799d3d55112738e301cb1af0dafd",
+  "base_ref": "refs/heads/master"
+}

.github/act/actTagPreEvent.json

@@ -0,0 +1,8 @@
+{
+  "ref": "refs/tags/0.8.5-gh-runner",
+  "ref_name": "0.8.5-gh-runner",
+  "before": "0000000000000000000000000000000000000000",
+  "after": "005dae76ab51799d3d55112738e301cb1af0dafd",
+  "sha": "005dae76ab51799d3d55112738e301cb1af0dafd",
+  "base_ref": "refs/heads/master"
+}

.github/act/actTest.yml

@@ -0,0 +1,105 @@
+name: Publish Docker image to Dockerhub
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - 'master'
+    tags:
+      - '*.*.*'
+    # don't trigger if just updating docs
+    paths-ignore:
+      - 'README.md'
+      - '.github/**'
+      - 'flatpak/**'
+  # use release instead of tags once version is correctly parsed
+  # https://github.com/docker/metadata-action/issues/422
+  # https://github.com/docker/metadata-action/issues/240
+#  release:
+#    types: [ published ]
+
+jobs:
+
+  push_to_registry:
+    name: Build and push container images
+    if: github.event_name != 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v4
+
+      - name: Debug
+        run: echo $JSON
+        env:
+          JSON: ${{ toJSON(github) }}
+
+      - name: Set git state to ENV
+        id: vars
+        # 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: Check App Version
+        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 $APP_VERSION
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+         # 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
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+        id: qemu
+        if: ${{ !env.NO_DOCKER_BUILD }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+        if: ${{ steps.qemu.outcome == 'success' }}
+        continue-on-error: true
+
+      - name: Build and push Docker image
+        if: ${{ steps.qemu.outcome == 'success' }}
+        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 ) }}
+        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: false
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64,linux/arm64

.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/pull_request_template.md

@@ -0,0 +1,19 @@
+## Checklist before requesting a review
+
+- [ ] I have read the [contributing guidelines.](../CONTRIBUTING.md)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## Describe your changes
+
+
+
+## Issue number and link, if applicable
+

.github/workflows/dependabotTest.yml

@@ -0,0 +1,16 @@
+name: Test Dependabot PR
+
+on:
+  pull_request_target:
+    types:
+      - synchronize
+      - reopened
+      - opened
+    branches:
+      - 'master'
+
+jobs:
+  test:
+    name: Tests / Build / Sanity Run
+    if: github.actor == 'dependabot[bot]'
+    uses: ./.github/workflows/testAndSanity.yml

.github/workflows/dockerhub.yml

@@ -1,55 +0,0 @@
-name: Publish Docker image to Dockerhub
-
-on:
-  push:
-    branches:
-      - 'master'
-      - 'develop'
-    tags:
-      - '*.*.*'
-    # don't trigger if just updating docs
-    paths-ignore:
-      - '**.md'
-
-jobs:
-  push_to_registry:
-    name: Push Docker image to Docker Hub
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out the repo
-        uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b
-
-      - name: Log in to Docker Hub
-        if: github.event_name != 'pull_request'
-        uses: docker/login-action@dd4fa0671be5250ee6f50aedf4cb05514abda2c7
-        with:
-          username: ${{ secrets.DOCKER_USERNAME }}
-          password: ${{ secrets.DOCKER_PASSWORD }}
-      
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta
-        uses: docker/metadata-action@f2a13332ac1ce8c0a71aeac48a150dbb1838ab67
-        with:
-          images: foxxmd/multi-scrobbler
-          # generate Docker tags based on the following events/attributes
-          tags: |
-            type=raw,value=latest,enable=${{ endsWith(github.ref, 'master') }}
-            type=ref,event=branch,enable=${{ !endsWith(github.ref, 'master') }}
-            type=semver,pattern={{version}}
-          flavor: |
-            latest=false
-
-      - name: Set up QEMU
-        uses: docker/setup-qemu-action@27d0a4f181a40b142cce983c5393082c365d1480
-
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@94ab11c41e45d028884a99163086648e898eed25
-
-      - name: Build and push Docker image
-        uses: docker/build-push-action@ac9327eae2b366085ac7f6a2d02df8aa8ead720a
-        with:
-          context: .
-          push: ${{ github.event_name != 'pull_request' }}
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
-          platforms: linux/amd64,linux/arm64,linux/arm/v7

.github/workflows/docsDeploy.yml

@@ -0,0 +1,52 @@
+name: Deploy to GitHub Pages
+
+on:
+  workflow_dispatch:
+  release:
+    types: [released]
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+
+jobs:
+  deploy:
+    name: Deploy to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: npm
+
+      - 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 }}
+          GSITEVERIFICATION: ${{ vars.GSITEVERIFICATION }}
+          DOCS_BASE: '/multi-scrobbler'
+        run: npm run build
+        working-directory: ./docsite
+
+      # 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
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          # Build output to publish to the `gh-pages` branch:
+          publish_dir: ./docsite/build
+          # The following lines assign commit authorship to the official
+          # GH-Actions bot for deploys to `gh-pages` branch:
+          # https://github.com/actions/checkout/issues/13#issuecomment-724415212
+          # The GH actions bot is used by default if you didn't specify the two fields.
+          # You can swap them out with your own user credentials.
+          user_name: github-actions[bot]
+          user_email: 41898282+github-actions[bot]@users.noreply.github.com

.github/workflows/packagesDeleteUntagged.yml

@@ -0,0 +1,21 @@
+name: Delete Untagged Packages
+on:
+  schedule:
+    - cron: '30 1 * * 0'
+  workflow_run:
+    workflows: ["Publish Docker image to Dockerhub"]
+    types:
+      - completed
+  workflow_dispatch:
+jobs:
+  delete-untagged:
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+    steps:
+      - uses: dataaxiom/ghcr-cleanup-action@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+# maybe set up for PR close later
+# https://github.com/dataaxiom/ghcr-cleanup-action?tab=readme-ov-file#delete-image-when-pull-request-is-closed

.github/workflows/pr.yml

@@ -0,0 +1,222 @@
+name: PR Workflow
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.head.sha }}
+  cancel-in-progress: true
+
+on:
+  pull_request_target:
+    types:
+      - labeled
+      - synchronize
+      - reopened
+      - opened
+    branches:
+      - 'master'
+
+jobs:
+  test:
+    if: contains(github.event.pull_request.labels.*.name, 'safe to test')
+    uses: ./.github/workflows/testAndSanity.yml
+    with:
+      ref: ${{ github.event.pull_request.head.sha }}
+
+  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
+    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 
+
+      # 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@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+  
+      - name: Login to GitHub Container Registry
+        if: ${{ vars.GHCR_SLUG != '' }}
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      # metadata extract for docker labels/image names is done in merge job
+
+      - name: Set up Buildx
+        uses: docker/setup-buildx-action@v3
+
+      # 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:
+          # 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@v4
+        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@v4
+        with:
+          path: /tmp/digests
+          pattern: digests-*
+          merge-multiple: true
+
+      - name: Login to Docker Hub
+        if: ${{ vars.DOCKERHUB_SLUG != '' }}
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Login to GitHub Container Registry
+        if: ${{ vars.GHCR_SLUG != '' }}
+        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)
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            ${{ 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
+          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 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 ' *)
+      
+      - 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 ' *)    
+      
+      - name: Inspect image dockerhub
+        if: ${{ vars.DOCKERHUB_SLUG != '' }}
+        run: |
+          docker buildx imagetools inspect ${{ vars.DOCKERHUB_SLUG }}:${{ steps.meta.outputs.version }}
+
+      - name: Inspect image ghcr
+        if: ${{ vars.GHCR_SLUG != '' }}
+        run: |
+            docker buildx imagetools inspect ${{ vars.GHCR_SLUG }}:${{ steps.meta.outputs.version }}   
+
+
+  combine-and-comment:
+    name: Leave comment
+    runs-on: ubuntu-latest
+    needs: release-snapshot
+    if: contains(github.event.pull_request.labels.*.name, 'safe to test')
+    steps:
+      - name: Create comment
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          recreate: true
+          header: "pr-release"
+          message: |
+            #### :package: A new release has been made for this pull request.
+
+            To play around with this PR, pull an image:
+            * `foxxmd/multi-scrobbler:pr-${{ github.event.number }}`
+
+            Images are available for x86_64 and ARM64.
+
+            > Latest commit: ${{ github.event.pull_request.head.sha }}

.github/workflows/publishImage.yml

@@ -0,0 +1,228 @@
+# 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:
+    branches:
+      - 'master'
+    tags:
+      - '*.*.*'
+    # don't trigger if just updating docs
+    paths-ignore:
+      - 'README.md'
+      - '.github/**'
+      - 'flatpak/**'
+  # use release instead of tags once version is correctly parsed
+  # https://github.com/docker/metadata-action/issues/422
+  # https://github.com/docker/metadata-action/issues/240
+#  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:
+    if: github.event_name != 'pull_request'
+    uses: ./.github/workflows/testAndSanity.yml
+
+  build:
+    name: Build OCI Images
+    if: ${{ github.event_name != 'pull_request' && (vars.DOCKERHUB_SLUG != '' ||  vars.GHCR_SLUG != '') }}
+    needs: test
+    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 
+
+      - name: Check out the repo
+        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: Login to Docker Hub
+        if: ${{ github.event_name != 'pull_request' && vars.DOCKERHUB_SLUG != '' }}
+        uses: docker/login-action@v3
+        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@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      
+      # metadata extract for docker labels/image names is done in merge job
+      
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      
+      # 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 }}
+          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@v4
+        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@v4
+        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@v3
+        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@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)
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            ${{ 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
+
+            # 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
+            
+            # 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 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 ' *)
+      
+      - 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 ' *)    
+      
+      - name: Inspect image dockerhub
+        if: ${{ vars.DOCKERHUB_SLUG != '' }}
+        run: |
+          docker buildx imagetools inspect ${{ vars.DOCKERHUB_SLUG }}:${{ steps.meta.outputs.version }}
+
+      - name: Inspect image ghcr
+        if: ${{ vars.GHCR_SLUG != '' }}
+        run: |
+            docker buildx imagetools inspect ${{ vars.GHCR_SLUG }}:${{ steps.meta.outputs.version }}   

.github/workflows/testAndSanity.yml

@@ -0,0 +1,65 @@
+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@v4
+        with:
+          ref: ${{ inputs.ref }}
+      - name: Use Node.js
+        uses: actions/setup-node@v4
+        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

@@ -1,7 +1,7 @@
 # Created by .ignore support plugin (hsz.mobi)
 ### Node template
 # Logs
-logs
+/logs
 *.log
 npm-debug.log*
 yarn-debug.log*
@@ -118,6 +118,7 @@ dist
 .pnp.*
 
 config/*.json
+config/yti-*
 *.txt
 .idea/
 
@@ -125,3 +126,13 @@ src/**/**.js
 src/**/**.js.map
 
 *.bak
+*.p8
+.flatpak-builder
+flatpak/generated-sources.json
+*.secrets
+
+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

@@ -0,0 +1,7 @@
+{
+  "reporter": "dot",
+  "extension": "ts",
+  "import": "tsx/esm",
+  "spec": "./src/backend/tests/**/*.test.ts",
+  "exit": true
+}

.nvmrc

@@ -1 +1 @@
-lts/hydrogen
+v18.19.1

.nycrc.json

@@ -0,0 +1,24 @@
+{
+  "extends": "@istanbuljs/nyc-config-typescript",
+  "exclude": [
+    "node_modules/",
+    "**/src/backend/common/schema/**",
+    "**/src/backend/tests/**",
+    "register.js",
+    "**/src/server/**/*.d.ts",
+    "**/src/client/**"
+  ],
+  "include": [
+    "**/src/backend/**/*.ts",
+    "**/src/**/backend/*.js",
+    "**/src/**/backend/*.js.map"
+  ],
+  "extension": [
+    ".ts"
+  ],
+  "reporter": [
+    "text-summary",
+    "html"
+  ],
+  "report-dir": "./coverage"
+}

.vscode/launch.json

@@ -0,0 +1,123 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "dev",
+            "type": "node",
+            "request": "launch",
+            // Debug app in VSCode
+            "program": "${workspaceFolder}/src/backend/index.ts",
+            "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen",
+            "skipFiles": [
+                "<node_internals>/**",
+                // Ignore all dependencies (optional)
+                "${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",
+            "request": "launch",
+            // Debug current file in VSCode
+            "program": "${file}",
+            "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen",
+            "skipFiles": [
+                "<node_internals>/**",
+                // Ignore all dependencies (optional)
+                "${workspaceFolder}/node_modules/**",
+            ],
+        },
+        {
+            "name": "schema",
+            "type": "node",
+            "request": "launch",
+            // Debug app in VSCode
+            "program": "${workspaceFolder}/src/backend/utils/SchemaStaticUtil.ts",
+            "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
+            "console": "integratedTerminal",
+            "internalConsoleOptions": "neverOpen",
+            "skipFiles": [
+                "<node_internals>/**",
+                // Ignore all dependencies (optional)
+                //"${workspaceFolder}/node_modules/**",
+            ],
+            "resolveSourceMapLocations": [
+                "${workspaceFolder}/src/**/*",
+                "${workspaceFolder}/node_modules/**/*"
+            ]
+        },
+        {
+            "args": [
+                "-u",
+                "bdd",
+                "--timeout",
+                "999999",
+                "--reporter",
+                "spec",
+                "--colors",
+                "--config", 
+                "${workspaceRoot}/.mocharc.json",
+                "--recursive",
+                "${workspaceFolder}/src/backend/tests/**/*.test.ts"
+            ],
+            "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
+            "internalConsoleOptions": "openOnSessionStart",
+            "name": "Mocha Tests",
+            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+            "request": "launch",
+            "skipFiles": [
+                "<node_internals>/**",
+                // Ignore all dependencies (optional)
+                "${workspaceFolder}/node_modules/**",
+            ],
+            "type": "node"
+        },
+        {
+            "args": [
+                "-u",
+                "bdd",
+                "--timeout",
+                "999999",
+                "--reporter",
+                "spec",
+                "--colors",
+                "--config", "${workspaceRoot}/.mocharc.json",
+                "${file}"
+            ],
+            "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/tsx",
+            "internalConsoleOptions": "openOnSessionStart",
+            "name": "Mocha Test on File",
+            "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+            "request": "launch",
+            "skipFiles": [
+                "<node_internals>/**",
+                // Ignore all dependencies (optional)
+                "${workspaceFolder}/node_modules/**",
+            ],
+            "type": "node"
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "mochaExplorer.require": "tsx/esm",
+    "mochaExplorer.timeout": 1200000,
+    "mochaExplorer.exit": true
+}

.vscode/tasks.json

@@ -0,0 +1,37 @@
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "typescript",
+			"tsconfig": "src/backend/tsconfig.json",
+			"problemMatcher": [
+				"$tsc"
+			],
+			"group": {
+				"kind": "build",
+				"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": []
+		  }
+	]
+}

CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Creating a Pull Request
+
+Please follow these guidelines when contributing code to this repository:
+
+* Use [conventional commit](https://www.conventionalcommits.org/en/v1.0.0/#summary) format when creating commits.
+* Preferably, please use a [feature branch](https://stackoverflow.com/a/39586780/1469797) instead of committing directly to `master`.
+* Ensure that if your code is covered by [an existing test](./src/backend/tests) that you have updated the test accordingly

Dockerfile

@@ -1,53 +1,115 @@
-FROM lsiobase/alpine:3.17 as base
+FROM ghcr.io/linuxserver/baseimage-debian:bookworm AS base
 
 ENV TZ=Etc/GMT
+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
 RUN \
+    ARCH= OPENSSL_ARCH= && dpkgArch="$(dpkg --print-architecture)" \
+        && case "${dpkgArch##*-}" in \
+          amd64) ARCH='x64' OPENSSL_ARCH='linux-x86_64';; \
+          ppc64el) ARCH='ppc64le' OPENSSL_ARCH='linux-ppc64le';; \
+          s390x) ARCH='s390x' OPENSSL_ARCH='linux*-s390x';; \
+          arm64) ARCH='arm64' OPENSSL_ARCH='linux-aarch64';; \
+          armhf) ARCH='armv7l' OPENSSL_ARCH='linux-armv4';; \
+          i386) ARCH='x86' OPENSSL_ARCH='linux-elf';; \
+          *) echo "unsupported architecture"; exit 1 ;; \
+        esac && \
+        set -ex && \
   echo "**** install build packages ****" && \
-  apk add --no-cache \
-    alpine-base \
-    git \
-    nodejs \
-    npm \
-    openssh && \
+    apt-get update && \
+    apt-get install --no-install-recommends -y \
+        #ca-certificates \
+        xz-utils \
+        avahi-utils \
+        curl && \
+  echo "**** Fetch and install node****" && \
+    # get node/npm directly from nodejs dist \
+    # https://github.com/nodejs/docker-node/blob/main/18/bookworm-slim/Dockerfile#L41
+    curl -fsSLO --compressed "https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION-linux-$ARCH.tar.xz" && \
+    tar -xJf "node-v$NODE_VERSION-linux-$ARCH.tar.xz" -C /usr --strip-components=1 --no-same-owner && \
+    rm "node-v$NODE_VERSION-linux-$ARCH.tar.xz" && \
+    ln -s /usr/bin/node /usr/bin/nodejs && \
+    npm update -g npm && \
   echo "**** cleanup ****" && \
-  rm -rf \
-    /root/.cache \
-    /tmp/*
+    # https://github.com/nodejs/docker-node/blob/main/18/bookworm-slim/Dockerfile#L49
+    # Remove unused OpenSSL headers to save ~34MB
+    # (does not affect arm64 issue below)
+    find /usr/include/node/openssl/archs -mindepth 1 -maxdepth 1 ! -name "$OPENSSL_ARCH" -exec rm -rf {} \; && \
+    apt-get purge --auto-remove -y perl xz-utils && \
+    apt-get autoclean && \
+    apt-get autoremove && \
+      rm -rf \
+        /config/.cache \
+        /root/cache \
+        /var/lib/apt/lists/* \
+        /var/tmp/* \
+        /tmp/*
 
 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
 
-COPY docker/root/ /
+COPY docker/root /
 
 WORKDIR /app
 
-FROM base as build
+FROM base AS build
 
-# copy NPM dependencies and install
-COPY --chown=abc:abc package*.json ./
-COPY --chown=abc:abc tsconfig.json .
+COPY --chown=abc:abc package*.json tsconfig.json ./
+COPY --chown=abc:abc patches ./patches
+COPY --chown=abc:abc docsite/package*.json tsconfig.json ./docsite/
 
-RUN npm install
+# for debugging, so the build fails faster when timing out (arm64)
+#RUN npm config set fetch-retries 1 && \
+#    npm config set fetch-retry-mintimeout 5000 && \
+#    npm config set fetch-retry-maxtimeout 5000
+
+# https://www.npmjs.com/package/tls-test
+# used to test that the OS supports downloading packages over HTTPS with TLS 1.2 enforced
+# -- this always succeeds but a good sanity check
+#RUN npm install -g https://tls-test.npmjs.com/tls-test-1.0.0.tgz
+
+# 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 run install:parallel \
+    && chown -R root:root node_modules \
+    && chown -R root:root docsite/node_modules
 
 COPY --chown=abc:abc . /app
 
-RUN npm run build && rm -rf node_modules
+# need to set before build so server/client build is optimized and has constants (if needed)
+ENV NODE_ENV=production
 
-FROM base as app
+RUN npm run build:parallel && rm -rf node_modules && rm -rf docsite/node_modules
 
-COPY --from=build --chown=abc:abc /app /app
+FROM base AS app
 
-ENV NODE_ENV="production"
+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
+COPY --from=build --chown=abc:abc /app/docsite /app/docsite
+COPY --from=base /usr/bin /usr/bin
+COPY --from=base /usr/lib /usr/lib
 
-RUN npm install --omit=dev \
+ENV NODE_ENV=production
+ENV IS_DOCKER=true
+
+# https://stackoverflow.com/a/63640896/1469797
+ARG APP_BUILD_VERSION
+ENV APP_VERSION=$APP_BUILD_VERSION
+
+RUN npm ci --omit=dev --no-audit \
     && npm cache clean --force \
-    && chown abc:abc node_modules \
-    && rm -rf node_modules/ts-node \
-    && rm -rf node_modules/typescript
+    && chown -R abc:abc node_modules \
+    && rm -rf /root/.cache
+
 
 ARG webPort=9078
 ENV PORT=$webPort

README.md

@@ -3,31 +3,55 @@
 [![Latest Release](https://img.shields.io/github/v/release/foxxmd/multi-scrobbler)](https://github.com/FoxxMD/multi-scrobbler/releases)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Docker Pulls](https://img.shields.io/docker/pulls/foxxmd/multi-scrobbler)](https://hub.docker.com/r/foxxmd/multi-scrobbler)
+[![Docs](https://img.shields.io/badge/Read%20The%20Docs-1082c2)](https://foxxmd.github.io/multi-scrobbler/)
+
+
+<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)
 
 * Supports scrobbling from many **Sources**
-  * [Spotify](/docs/configuration.md#spotify)
-  * [Plex](/docs/configuration.md#plex) or [Tautulli](/docs/configuration.md#tautulli)
-  * [Subsonic-compatible APIs](/docs/configuration.md#subsonic) (like [Airsonic](https://airsonic.github.io/))
-  * [Jellyfin](/docs/configuration.md#jellyfin)
-  * [Youtube Music](/docs/configuration.md#youtube-music)
-  * [Last.fm](/docs/configuration.md#lastfm-source)
-  * [ListenBrainz](/docs/configuration.md#listenbrainz--source-)
-  * [Deezer](/docs/configuration.md#deezer)
-  * [MPRIS (Linux Desktop)](/docs/configuration.md#mpris)
-  * [Mopidy](/docs/configuration.md#mopidy)
-  * [JRiver](/docs/configuration.md#jriver)
+  * [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)
+  * [Last.fm (Endpoint)](https://foxxmd.github.io/multi-scrobbler/docs/configuration#lastfm-endpoint)
+  * [ListenBrainz](https://foxxmd.github.io/multi-scrobbler/docs/configuration#listenbrainz-source)
+  * [Koito](https://foxxmd.github.io/multi-scrobbler/docs/configuration#listenbrainz-source) using Listenbrainz Source
+  * [ListenBrainz (Endpoint)](https://foxxmd.github.io/multi-scrobbler/docs/configuration#listenbrainz-endpoint)
+  * [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)
+  * [Azuracast](https://foxxmd.github.io/multi-scrobbler/docs/configuration#azuracast)
+  * [Yamaha MusicCast](https://foxxmd.github.io/multi-scrobbler/docs/configuration#yamaha-musiccast)
+  * [Icecast](https://foxxmd.github.io/multi-scrobbler/docs/configuration#icecast)
 * Supports scrobbling to many **Clients**
-  * [Maloja](/docs/configuration.md#maloja)
-  * [Last.fm](/docs/configuration.md#lastfm)
-  * [ListenBrainz](/docs/configuration.md#listenbrainz)
-* Monitor status of Sources and Clients using [webhooks (Gotify or Ntfy)](/docs/configuration.md#webhook-configurations) or [healthcheck endpoint](/docs/configuration.md#health-endpoint)
+  * [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)
+  * [Koito](https://foxxmd.github.io/multi-scrobbler/docs/configuration#listenbrainz) using Listenbrainz Client
+* 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 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
-* Docker images for x86/ARM
+* Modify data before scrobbling with [regular expression or search patterns](https://foxxmd.github.io/multi-scrobbler/docs/configuration/transforms)
+* Install using [Docker images for x86/ARM](https://foxxmd.github.io/multi-scrobbler/docs/installation#docker) or [locally with NodeJS](https://foxxmd.github.io/multi-scrobbler/docs/installation#nodejs)
+
+[**Quick Start Guide**](https://foxxmd.github.io/multi-scrobbler/docs/quickstart)
+
+<img src="/assets/status-ui.png" width="800">
 
 **Why should I use this over a browser extension and/or mobile app scrobbler?**
 
@@ -38,9 +62,7 @@ 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**](/docs/configuration.md#lastfm--source-) or [Listenbrainz as a **Source**](/docs/configuration.md#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.
-
-<img src="/assets/status-ui.jpg" width="800">
+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.
 
 ## How Does multi-scrobbler (MS) Work?
 
@@ -65,13 +87,17 @@ Client configurations consist of:
 * A friendly name.
 * Any data needed to communicate or authenticate with the Client.
 
+## Quick Start
+
+[See the **Quick Start Guide**](https://foxxmd.github.io/multi-scrobbler/docs/quickstart)
+
 ## Installation
 
-[See the **Installation** documentation](/docs/installation.md)
+[See the **Installation** documentation](https://foxxmd.github.io/multi-scrobbler/docs/installation)
 
 ## Configuration
 
-[See the **Configuration** documentation](/docs/configuration.md)
+[See the **Configuration** documentation](https://foxxmd.github.io/multi-scrobbler/docs/configuration)
 
 ## Usage
 
@@ -86,7 +112,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](/docs/FAQ.md) before creating an issue!
+Having issues with connections or configuration? Check the [FAQ](https://foxxmd.github.io/multi-scrobbler/docs/FAQ) before creating an issue!
+
+## Development
+
+[Detailed architecture and development guides for Sources/Clients](https://foxxmd.github.io/multi-scrobbler/docs/development/dev-common)
 
 ## License
 

alpine.Dockerfile

@@ -0,0 +1,71 @@
+FROM lsiobase/alpine:3.18 as base
+
+ENV TZ=Etc/GMT
+
+RUN \
+  echo "**** install build packages ****" && \
+  apk add --no-cache \
+    avahi \
+    avahi-tools \
+    nodejs \
+    npm \
+    && \
+  echo "**** cleanup ****" && \
+  rm -rf \
+    /root/.cache \
+    /tmp/*
+
+RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
+
+ARG data_dir=/config
+VOLUME $data_dir
+ENV CONFIG_DIR=$data_dir
+
+COPY docker/root/ /
+
+WORKDIR /app
+
+FROM base as build
+
+# copy dep/TS config and install dev dependencies
+COPY --chown=abc:abc package*.json tsconfig.json ./
+COPY --chown=abc:abc patches ./patches
+
+RUN npm ci \
+    && chown -R root:root node_modules
+#RUN yarn install
+
+COPY --chown=abc:abc . /app
+
+# need to set before build so server/client build is optimized and has constants (if needed)
+ENV NODE_ENV=production
+
+RUN npm run docs:install && npm run build && rm -rf node_modules && rm -rf docsite/node_modules
+
+FROM base as app
+
+#COPY --chown=abc:abc package.json yarn.lock ./
+COPY --chown=abc:abc package*.json ./
+COPY --chown=abc:abc patches ./patches
+COPY --from=build --chown=abc:abc /app/dist /app/dist
+COPY --from=build --chown=abc:abc /app/src /app/src
+COPY --from=build --chown=abc:abc /app/docsite /app/docsite
+COPY --from=base /usr/local/bin /usr/local/bin
+COPY --from=base /usr/local/lib /usr/local/lib
+
+ENV NODE_ENV=production
+ENV IS_DOCKER=true
+ENV COLORED_STD=true
+
+# https://stackoverflow.com/a/63640896/1469797
+ARG APP_BUILD_VERSION
+ENV APP_VERSION=$APP_BUILD_VERSION
+
+RUN npm ci --omit=dev \
+    && npm cache clean --force \
+    && chown -R abc:abc node_modules \
+    && rm -rf node_modules/@types
+
+ARG webPort=9078
+ENV PORT=$webPort
+EXPOSE $PORT

assets/icon.svg

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" width="128" height="128" viewBox="0 0 128 128">
+  <defs>
+    <style>
+      .cls-1 {
+        fill: #c34a36;
+      }
+    </style>
+  </defs>
+  <path class="cls-1" d="M76.94,65.49c.87-7.85-5.27-14.51-12.94-14.51-4.56,0-8.57,2.36-10.9,5.91h-4.55c2.36-5.11,7.17-8.87,12.95-9.71V20c0-11.05-8.95-20-20-20H5C2.24,0,0,2.24,0,5V123c0,2.76,2.24,5,5,5H41.5c11.05,0,20-8.95,20-20v-27.17c-5.78-.84-10.59-4.6-12.95-9.72h4.55c2.59,3.96,7.27,6.43,12.46,5.82,6.08-.71,10.71-5.37,11.39-11.45ZM15.3,94.39c0,1.1-.9,2-2,2s-2-.9-2-2V33.61c0-1.1,.9-2,2-2s2,.9,2,2v60.78Zm11.12,14.55c0,1.1-.9,2-2,2s-2-.9-2-2V19.06c0-1.1,.9-2,2-2s2,.9,2,2V108.94Zm37.58-39.53c-2.28,0-4.23-1.41-5.02-3.41h-21.43v28.39c0,1.1-.9,2-2,2s-2-.9-2-2V33.61c0-1.1,.9-2,2-2s2,.9,2,2v28.39h21.43c.93-2.33,3.42-3.86,6.18-3.29,2.05,.42,3.7,2.08,4.13,4.12,.73,3.5-1.92,6.58-5.29,6.58Z"/>
+  <path class="cls-1" d="M123,0h-36.5c-11.05,0-20,8.95-20,20v27.18c7.55,1.12,13.5,7.2,14.4,14.82h9.55v-28.28c0-1,.68-1.92,1.66-2.08,1.25-.2,2.34,.76,2.34,1.97v60.67c0,1-.68,1.92-1.66,2.08-1.25,.2-2.34-.76-2.34-1.97v-28.39h-9.55c-.9,7.62-6.84,13.7-14.4,14.82v27.18c0,11.05,8.95,20,20,20h36.5c2.76,0,5-2.24,5-5V5c0-2.76-2.24-5-5-5Zm-17.42,108.94c0,1.1-.9,2-2,2s-2-.9-2-2V19.06c0-1.1,.9-2,2-2s2,.9,2,2V108.94Zm11.12-14.55c0,1.1-.9,2-2,2s-2-.9-2-2V33.61c0-1.1,.9-2,2-2s2,.9,2,2v60.78Z"/>
+</svg>

cliff.toml

@@ -0,0 +1,67 @@
+# configuration file for git-cliff (0.1.0)
+
+[changelog]
+# changelog header
+header = """
+# Changelog
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://tera.netlify.app/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | replace(from="v", to="") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | upper_first }}
+    {% for commit in commits
+    | filter(attribute="scope")
+    | sort(attribute="scope") %}
+        - *({{commit.scope}})* {{ commit.message | upper_first }}
+        {%- if commit.breaking %}
+        {% raw %}  {% endraw %}- **BREAKING**: {{commit.breaking_description}}
+        {%- endif -%}
+    {%- endfor -%}
+    {%- for commit in commits %}
+        {%- if commit.scope -%}
+        {% else -%}
+            - *(No Category)* {{ commit.message | upper_first }}
+            {% if commit.breaking -%}
+            {% raw %}  {% endraw %}- **BREAKING**: {{commit.breaking_description}}
+            {% endif -%}
+        {% endif -%}
+    {% endfor -%}
+{% endfor %}
+"""
+# remove the leading and trailing whitespaces from the template
+trim = true
+# changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+
+[git]
+# allow only conventional commits
+# https://www.conventionalcommits.org
+conventional_commits = true
+# regex for parsing and grouping commits
+commit_parsers = [
+    { message = "^feat", group = "Features"},
+    { message = "^fix", group = "Bug Fixes"},
+    { message = "^doc", group = "Documentation"},
+    { message = "^perf", group = "Performance"},
+    { message = "^refactor", group = "Refactor"},
+    { message = "^style", group = "Styling"},
+    { message = "^test", group = "Testing"},
+    { message = "^chore\\(release\\): prepare for", skip = true},
+    { message = "^chore", group = "Miscellaneous Tasks"},
+    { body = ".*security", group = "Security"},
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# glob pattern for matching git tags
+tag_pattern = "[0-9]*"
+# regex for skipping tags
+skip_tags = "v0.1.0-beta.1"

config/README.md

@@ -8,5 +8,5 @@ These are **NOT** exhaustive examples. You should consult the  **configuration**
 
 Documentation at
 
-* [internal docs](/docs/configuration.md)
-* External Link: https://github.com/FoxxMD/multi-scrobbler/blob/master/docs/configuration.md
+* [internal docs](../docsite/docs/configuration/configuration.mdx)
+* External Link: https://foxxmd.github.io/multi-scrobbler/docs/configuration

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/chromecast.json.example

@@ -0,0 +1,11 @@
+[
+  {
+    "name": "MyCast",
+    "data": {
+      "blacklistedDevices": [],
+      "whitelistedDevices": [],
+      "blacklistedApps": [],
+      "whitelistedApps": []
+    }
+  }
+]

config/config.json.example

@@ -1,6 +1,15 @@
 {
+  "debugMode": false,
+  "disableWeb": false,
   "sourceDefaults": {
-    "maxPollRetries": 0,
+    "logPayload": false,
+    "logFilterFailure": "warn",
+    "logPlayerState": false,
+    "scrobbleThresholds": {
+      "duration": 30,
+      "percent": 50
+    },
+    "maxPollRetries": 1,
     "maxRequestRetries": 1,
     "retryMultiplier": 1.5
   },
@@ -11,6 +20,7 @@
   "sources": [
     {
       "type": "spotify",
+      "enable": true,
       "clients": ["myConfig"],
       "name": "mySpotifySource",
       "data": {
@@ -23,6 +33,7 @@
   "clients": [
     {
       "type": "maloja",
+      "enable": true,
       "name": "myConfig",
       "data": {
         "url": "http://localhost:42010",

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,12 +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

@@ -1,13 +1,26 @@
 [
   {
     "name": "MyJellyfin",
+    "enable": true,
     "clients": [],
     "data": {
-      "users": ["FoxxMD"],
-      "servers": ["myServer","anotherServer"],
-      "options": {
-        "logPayload": false
-      }
+      "url": "http://localhost:8096",
+      "user": "FoxxMD",
+      "apiKey": "c9fae8756fbf481ebd9c5bb56bd6540c",
+
+      // 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/jriver.json.example

@@ -1,6 +1,7 @@
 [
   {
     "name": "MyJriver",
+    "enable": true,
     "data": {
       "url": "0.0.0.0",
       "username": "auser",

config/kodi.json.example

@@ -0,0 +1,11 @@
+[
+  {
+    "name": "MyKodi",
+    "enable": true,
+    "data": {
+      "url": "http://localhost:8080/jsonrpc",
+      "username": "myUser",
+      "password": "myPassword"
+    }
+  }
+]

config/lastfm.json.example

@@ -1,11 +1,22 @@
 [
   {
-    "name": "myLastFm",
+    "name": "myLastFmClient",
+    "enable": true,
     "configureAs": "client",
     "data": {
       "apiKey": "a89cba1569901a0671d5a9875fed4be1",
       "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,10 +1,30 @@
 [
   {
-    "name": "brainz",
-    "configureAs": "client"
+    "name": "brainzClient",
+    "enable": true,
+    "configureAs": "client",
     "data": {
       "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
       "username": "FoxxMD"
     }
-  }
+  },
+  {
+    "name": "brainzSource",
+    "enable": true,
+    "configureAs": "source",
+    "data": {
+      "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
+      "username": "FoxxMD"
+    }
+  },
+  {
+    "name": "koitoClient",
+    "enable": true,
+    "configureAs": "client",
+    "data": {
+      "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
+      "username": "FoxxMD",
+      "url": "http://192.168.0.100:4110/apis/listenbrainz/1"
+    }
+  },
 ]

config/maloja.json.example

@@ -1,6 +1,7 @@
 [
   {
     "name": "myMaloja",
+    "enable": true,
     "data": {
       "url": "http://localhost:42010",
       "apiKey": "myMalojaKey"

config/mopidy.json.example

@@ -1,6 +1,7 @@
 [
   {
     "name": "MyMopidy",
+    "enable": true,
     "data": {
       "url": "localhost",
       "uriBlacklist": [],

config/mpd.json.example

@@ -0,0 +1,13 @@
+[
+  {
+    "enable": true,
+    "name": "MyMPD",
+    "data": {
+      "url": "192.168.0.100:6600",
+      "password": "MY_PASSWORD"
+    },
+    "options": {
+      "disableDiscovery": false
+    }
+  }
+]

config/mpris.json.example

@@ -1,6 +1,7 @@
 [
   {
     "name": "ubuntu",
+    "enable": true,
     "data": {
       "whitelist": ["vlc", "mpd"],
       "blacklist": ["spotify"]

config/musiccast.json.example

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

config/musikcube.json.example

@@ -0,0 +1,11 @@
+[
+  {
+    "type": "musikcube",
+    "enable": true,
+    "name": "musikcube",
+    "data": {
+      "url": "ws://localhost:7905",
+      "password": "MY_PASSWORD"
+    }
+  }
+]

config/plex.json.example

@@ -1,11 +1,21 @@
 [
   {
-    "name": "MyPlex",
+    "name": "MyPlexApi",
+    "enable": true,
     "clients": [],
     "data": {
-      "user": ["username@gmail.com","anotherUser@gmail.com"],
-      "libraries": ["music","my podcasts"],
-      "servers": ["myServer","anotherServer"]
-    }
+      "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"
+      }
   }
 ]

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/spotify.json.example

@@ -1,6 +1,7 @@
 [
   {
     "name": "MySpotify",
+    "enable": true,
     "clients": [],
     "data": {
       "clientId": "a89cba1569901a0671d5a9875fed4be1",

config/subsonic.json.example

@@ -1,10 +1,11 @@
 [
   {
     "name": "MySubsonic",
+    "enable": true,
     "data": {
       "url": "http://localhost:4040/airsonic",
       "user": "yourUser",
-      "password": "yourPassword",
+      "password": "yourPassword"
     }
   }
 ]

config/tautulli.json.example

@@ -1,11 +1,15 @@
 [
   {
     "name": "MyTautuilli",
+    "enable": true,
     "clients": [],
     "data": {
       "user": ["username@gmail.com","anotherUser@gmail.com"],
       "libraries": ["music","my podcasts"],
-      "servers": ["myServer","anotherServer"]
+      "servers": ["myServer","anotherServer"],
+      "options": {
+        "logFilterFailure": "warn"
+      }
     }
   }
 ]

config/vlc.json.example

@@ -0,0 +1,10 @@
+[
+  {
+    "enable": true,
+    "name": "MyVlc",
+    "data": {
+      "url": "localhost:8080",
+      "password": "changeme"
+    }
+  }
+]

config/webscrobbler.json.example

@@ -0,0 +1,10 @@
+[
+  {
+    "name": "MyWebScrobbler",
+    "data": {
+      "slug": "MyOptionalSlug",
+      "whitelist": [],
+      "blacklist": []
+    }
+  }
+]

config/ytmusic.json.example

@@ -1,10 +1,19 @@
 [
   {
     "name": "MyYTMusic",
+    "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,19 +1,24 @@
-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
-    #- 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
-  volumes:
-    - /path_on_host/multi-scrobbler-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 on
-  restart: unless-stopped
+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
+      #- 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/root/etc/s6-overlay/s6-rc.d/svc-node/run

@@ -4,5 +4,7 @@
 
 # NODE_ARGS can be passed by ENV in docker command like "docker run foxxmd/multi-scrobbler -e NODE_ARGS=--optimize_for_size"
 echo -e "\nmulti-scrobbler is starting!"
+export NODE_ENV=production
+cd /app || exit
 exec \
-	  s6-setuidgid abc /usr/bin/node $NODE_ARGS /app/src/index.js run
+	  s6-setuidgid abc /usr/bin/node $NODE_ARGS /app/node_modules/.bin/tsx /app/src/backend/index.ts

docs/FAQ.md

@@ -1,122 +0,0 @@
-* [Connection Issues](#connection-issues)
-  * [Plex/Tautulli/Jellyfin don't connect](#plextautullijellyfin-dont-connect)
-  * [Jellyfin has warnings about undefined or missing data](#jellyfin-has-warnings-about-undefined-or-missing-data)
-  * [Spotify/Deezer/LastFM won't authenticate](#spotifydeezerlastfm-wont-authenticate)
-* [Configuration Issues](#configuration-issues)
-  * [Config could not be parsed](#config-could-not-be-parsed)
-
-# Connection Issues
-
-## Plex/Tautulli/Jellyfin don't connect
-
-These three [sources](/README.md#source) are **ingress-based** which means that multi-scrobbler waits for the Plex/Tautulli/Jellyfin server to contact multi-scrobbler, as opposed to multi-scrobbler contacting the server.
-
-multi-scrobbler will log information about any server that connects to it for these three 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
-```
-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
-```
-**So, if you do not see either of these in your logs then Plex/Tautulli/Jellyfin 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.
-
-### Troubleshooting 
-
-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.
-
-#### Check Host name and URL
-
-The URLs examples in the [configuration](/docs/configuration.md) documentation assume you are running Plex/Tautulli/Jellyfin 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`
-
-#### Check Firewall and Port Forwarding
-
-If the machine multi-scrobbler is running on has a firewall ensure that port **9078** is open. Or if it is in another network entirely make sure your router is forwarding this port and it is open to the correct machine.
-
-#### 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
-
-## Jellyfin has warnings about undefined or missing data
-
-Make sure you have 
-* [Configured the webhook plugin correctly](/docs/configuration.md#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.
-
-
-## Spotify/Deezer/LastFM won't authenticate
-
-Ensure any **client id** or **secrets** are correct in your configuration.
-
-The callback/redirect URL for these services must be:
-
-* the same address you would use to access the multi-scrobbler web interface
-  * the web-interface must be accessible from the browser you are completing authentication from.
-
-If multi-scrobbler is not running on the same machine your browser is on then the default/example addresses (`http://localhost...`) **will not work.** You must determine the address you can reach the web interface at (such as `http://192.168.0.140:9078`) then use that in place of `localhost` in the callback URLs.
-
-EX `http://localhost:9078/lastfm/callback` -> `http://192.168.0.220:9078/lastfm/callback`
-
-# Configuration Issues
-
-## Config could not be parsed
-
-If you see something like this in your logs:
-
-```
-2023-02-19T10:05:42-06:00 warn   : [App] App config file exists but could not be parsed!
-2023-02-19T10:05:42-06:00 error  : [App] Exited with uncaught error
-2023-02-19T10:05:42-06:00 error  : [App] Error: config.json could not be parsed
-```
-
-It means the JSON in your configuration file is not valid. Copy and paste your configuration into a site like [JSONLint](https://jsonlint.com/) to find out where errors you have and fix them.

docs/configuration.md

@@ -1,692 +0,0 @@
-* [Configuration Overview](#configuration-overview)
-  * [ENV-Based Configuration](#env-based-configuration)
-  * [File-Based Configuration](#file-based-configuration)
-    * [All-in-One File Configuration](#all-in-one-file-configuration)
-    * [Specific File Configuration](#specific-file-configuration)
-* [Source Configurations](#source-configurations)
-  * [Spotify](#spotify)
-  * [Plex](#plex)
-  * [Tautulli](#tautulli)
-  * [Subsonic](#subsonic)
-  * [Jellyfin](#jellyfin)
-  * [Last.fm (Source)](#lastfm--source-)
-  * [Listenbrainz (Source)](#listenbrainz--source-)
-  * [Deezer](#deezer)
-  * [Youtube Music](#youtube-music)
-  * [MPRIS (Linux Desktop)](#mpris)
-  * [Mopidy](#mopidy)
-  * [JRiver](#jriver)
-* [Client Configurations](#client-configurations)
-  * [Maloja](#maloja)
-  * [Last.fm](#lastfm)
-  * [Listenbrainz](#listenbrainz)
-* [Monitoring](#monitoring)
-  * [Webhooks](#webhook-configurations)
-  * [Health Endpoint](#health-endpoint)
-
-# Configuration Overview
-
-[**Sources** and **Clients**](/README.md#how-does-multi-scrobbler-ms-work) are configured using environmental (ENV) variables and/or json files.
-
-**MS will parse configuration from both configuration types.** You can mix and match configurations but it is generally better to stick to one or the other.
-
-TIP: Check the [**FAQ**](/docs/FAQ.md) if you have any issues after configuration!
-
-## ENV-Based Configuration
-
-This is done by passing environmental variables and so does not require any files to run MS.
-
-* Using a docker container EX `docker run -e "SPOTIFY_CLIENT_ID=yourId" -e "SPOTIFY_CLIENT_SECRET=yourSecret" ...`
-* Using a local installations by exporting variables before running MS EX `SPOTIFY_CLIENT_ID=yourId SPOTIFY_CLIENT_SECRET=yourSecret node index.js`
-
-Use ENV-based configuration if:
-
-* You are the only person for whom MS is scrobbling for
-* You have a very simple setup for MS such as one scrobble [Client](/README.md#client) and one [Source](/README.md#source) IE Plex -> Maloja
-
-## File-Based Configuration
-
-MS will parse configuration files located in the directory specified by the `CONFIG_DIR` environmental variable. This variable defaults to:
-
-* Local installation -> `PROJECT_DIR/config`
-* Docker -> `/config` (in the container) -- see the [install docs](/docs/installation.md#docker) for how to configure this correctly
-
-Use File-based configuration if:
-
-* You have many [Sources](/README.md#source)
-* You have many of each type of **Source** you want to scrobble from IE 2x Plex accounts, 3x Spotify accounts, 1x
-  Funkwhale...
-* You have more than one scrobble **Client** you want to scrobble to IE multiple Maloja servers
-* You want only some **Sources** to scrobble to some **Clients** IE Fred's Spotify account scrobbles to Fred's Maloja
-    server, but not Mary's Maloja server
-
-File-based configurations located in the `CONFIG_DIR` directory can be parsed from
-
-* an **all-in-one** config file named `config.json` that contains information for all Sources and Clients and/or
-* many **specific** files named based on the client/source to configure IE `plex.json` `spotify.json`
-
-There are **example configurations** for all Source/Client types and AIO config located in the [/config](/config) directory of this project. These can be used as-is by renaming them to `.json`.
-For docker installations these examples are copied to your configuration directory on first-time use.
-
-There is also a [**kitchensink example**](/docs/kitchensink.md) that provides examples of using all sources/clients in a complex configuration.
-
-### All-in-One File Configuration
-
-[**Explore the schema for this configuration, along with an example generator and validator, here**](https://json-schema.app/view/%23?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Faio.json)
-
-Example directory structure:
-
-```
-/CONFIG_DIR
-  config.json
-```
-
-<details>
-<summary>Config Example</summary>
-
-```json5
-// in config.json
-{
-  //...
-  "sources": [
-    {
-      "name": "myConfig",
-      "type": "spotify",
-      "clients": [
-        "myMalojaClient"
-      ],
-      "data": {
-        "clientId": "anExample"
-        //...
-      }
-    }
-  ],
-  "clients": [
-    {
-      "name": "myFirstMalojaClient",
-      "type": "maloja",
-      "data": {
-        "url": "http://myMalojaServer.example",
-        // ...
-      }
-    }
-  ]
-}
-```
-
-</details>
-
-`config.json` can also be used to set default behavior for all sources/clients using `sourceDefaults` and `clientDefaults` properties.
-
-See [config.json.example](/config/config.json.example) for an annotated example or check out [the kitchen sink example](kitchensink.md).
-
-### Specific File Configuration
-
-Each file is named by the **type** of the Client/Source found in below sections. Each file as an **array** of that type of Client/Source.
-
-Example directory structure:
-
-```
-/CONFIG_DIR
-  plex.json
-  spotify.json
-  maloja.json
-```
-
-<details>
-<summary>Config Example</summary>
-
-```json5
-// in maloja.json
-[
-  {
-    "name": "myFirstMalojaClient",
-    "data": {
-      "url": "http://myMalojaServer.example",
-      "apiKey": "myKey"
-    }
-  },
-  {
-    "name": "mySecondMalojaClient",
-    "data": {
-      "url": "http://my2ndMalojaServer.example",
-      "apiKey": "myKey"
-    }
-  }
-]
-
-```
-
-</details>
-
-See the [/config](/config) directory of this project for examples of each type of config file or reference specific files below.
-
-# Source Configurations
-
-## [Spotify](https://www.spotify.com)
-
-To access your Spotify history you must [register an application](https://developer.spotify.com/dashboard) to get a
-Client ID/Secret. Make sure to also whitelist your redirect URI in the application settings.
-
-### ENV-Based
-
-| 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`                         |
-
-### File-Based
-
-See [`spotify.json.example`](/config/spotify.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23/%23%2Fdefinitions%2FSpotifySourceConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fsource.json)
-
-## [Plex](https://plex.tv)
-
-Check the [instructions](plex.md) on how to setup a [webhooks](https://support.plex.tv/articles/115002267687-webhooks) to scrobble your plays.
-
-### ENV-Based
-
-| Environmental Variable | Required | Default |                   Description                   |
-|------------------------|----------|---------|-------------------------------------------------|
-| `PLEX_USER`              |        No |         | The a comma-delimited list of usernames to scrobble tracks for. No usernames specified means all tracks by all users will be scrobbled. |
-
-### File-Based
-
-See [`plex.json.example`](/config/plex.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23/%23%2Fdefinitions%2FPlexSourceConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fsource.json)
-
-## [Tautulli](https://tautulli.com)
-
-Check the [instructions](plex.md) on how to setup a notification agent.
-
-### ENV-Based
-
-| Environmental Variable | Required | Default |                   Description                   |
-|------------------------|----------|---------|-------------------------------------------------|
-| `TAUTULLI_USER`              |        No |         | The a comma-delimited list of usernames to scrobble tracks for. No usernames specified means all tracks by all users will be scrobbled. |
-
-### File-Based
-
-See [`tautulli.json.example`](/config/tautulli.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23/%23%2Fdefinitions%2FTautulliSourceConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fsource.json)
-
-## [Subsonic](http://www.subsonic.org/)
-
-Can use this source for any application that implements the [Subsonic API](http://www.subsonic.org/pages/api.jsp) (such as [Airsonic](https://airsonic.github.io/))
-
-**Known Issues:**
-* "Time played at" is somewhat inaccurate since the api only reports "played X minutes ago" so...
-  * All scrobble times are therefore "on the minute" and you may experience occasional duplicate scrobbles
-  * "played X minutes ago" sometimes is also not reported correctly
-* 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**  
-
-### ENV-Based
-
-| Environmental Variable     | Required? |            Default             |                    Description                     |
-|----------------------------|-----------|----------------------------------|----------------------------------------------------|
-| `SUBSONIC_USER`        | Yes       |                                  |                                                    |
-| `SUBSONIC_PASSWORD`    | Yes       |                                  |                                                    |
-| `SUBSONIC_URL`     | Yes         |                                  | Base url of your subsonic-api server |
-
-### File-Based
-
-See [`subsonic.json.example`](/config/subsonic.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23/%23%2Fdefinitions%2FSubSonicSourceConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fsource.json)
-
-## [Jellyfin](https://jellyfin.org/)
-
-Must be using Jellyfin 10.7 or greater
-
-* In the Jellyfin desktop web UI Navigate to -> Administration -> Dashboard -> Plugins -> Catalog
-  * Under Notifications -> **Webhook** -> Install, then restart your server
-* Navigate back to -> Administration -> Dashboard -> Plugins -> My Plugins -> Webhook
-  * Click "..." -> Settings
-* In Webhook settings:
-  * `Add Generic Destination`
-  * In the new `Generic` dropdown:
-    * Webhook Url: `http://localhost:9078/jellyfin`
-    * Notification Type: `Playback Progress`
-    * Item Type: `Songs`
-    * Check `Send All Properties`
-  * Save
-
-### ENV-Based
-
-| Environmental Variable | Required? | Default | Description                                                       |
-|------------------------|-----------|---------|-------------------------------------------------------------------|
-| `JELLYFIN_USER`        |           |         | Comma-separated list of usernames (from Jellyfin) to scrobble for |
-| `JELLYFIN_SERVER`      |           |         | Comma-separated list of Jellyfin server names to scrobble from    |
-
-### File-Based
-
-See [`jellyfin.json.example`](/config/jellyfin.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23/%23%2Fdefinitions%2FJellySourceConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fsource.json)
-
-## [Last.fm (Source)](https://www.last.fm)
-
-See the [Last.fm (Client)](#lastfm) setup for registration instructions. You may need to disable "Hide recent listening information" on your [privacy page](https://www.last.fm/settings/privacy) for this to work.
-
-### ENV-Based
-
-No support for ENV based for Last.fm as a client (only source)
-
-### File-Based
-
-See [`lastfm.json.example`](/config/lastfm.json.example), change `configureAs` to `source`. Or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23/%23%2Fdefinitions%2FLastfmSourceConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fsource.json)
-
-## [Listenbrainz (Source)](https://listenbrainz.org)
-
-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.
-
-**NOTE:** You cannot use ENV variables shown in the [Listenbrainz Client config](#listenbrainz) -- multi-scrobbler assumes Listenbrainz ENVs are always used for the **client** configuration. You must use the file-based config from below to setup Listenbrainz as a Source.
-
-### File-Based
-
-See [`listenbrainz.json.example`](/config/listenbrainz.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23%2Fdefinitions%2FListenBrainzSourceConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fsource.json)
-
-**Change `configureAs` to `source`**
-
-## [Deezer](https://deezer.com/)
-
-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.
-
-### ENV-Based
-
-| 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`         |
-
-### File-Based
-
-See [`deezer.json.example`](/config/deezer.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23/%23%2Fdefinitions%2FDeezerSourceConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fsource.json)
-
-## [Youtube Music](https://music.youtube.com)
-
-Credentials for YT Music are obtained from a browser request to https://music.youtube.com **once you are logged in.** [Specific requirements are here and summarized below:](https://github.com/nickp10/youtube-music-ts-api/blob/master/DOCUMENTATION.md#authenticate)
-
-* Open a new tab
-* Open the developer tools (Ctrl-Shift-I) and select the “Network” tab 
-* Go to https://music.youtube.com and ensure you are logged in 
-
-Then...
-
-1. Find and select an authenticated POST request. The simplest way is to filter by /browse using the search bar of the developer tools. If you don’t see the request, try scrolling down a bit or clicking on the library button in the top bar.
-2. **Make sure **Headers** pane is selected and open
-3. In the **Request Headers** section find and copy the **entire value** found after `Cookie:` and use this as the `cookie` value in your multi-scrobbler config
-4. If present, in the **Request Headers** section find and copy the number found in `X-google-AuthUser` and use this as the value for `authUser` in your multi-scrobbler config
-
-![Google Headers](/docs/google-header.jpg)
-
-NOTES:
-
-* YT Music authentication is "browser based" which means your credentials may expire after a (long?) period of time OR if you log out of https://music.youtube.com. In the event this happens just repeat the steps above to get new credentials.
-* Communication to 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.
-
-### File-Based
-
-See [`ytmusic.json.example`](/config/ytmusic.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23/%23%2Fdefinitions%2FYTMusicSourceConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fsource.json)
-
-## [MPRIS](https://specifications.freedesktop.org/mpris-spec/latest/)
-
-MPRIS 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](/assets/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.
-
-**NOTE:** multi-scrobbler needs to be running as a [**Local Installation**](/docs/installation.md#local) in order to use MPRIS. This cannot be used from docker.
-
-### ENV-Based
-
-| 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 |
-
-### File-Based
-
-See [`mpris.json.example`](/config/mpris.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23%2Fdefinitions%2FMPRISSourceConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fsource.json)
-
-## [Mopidy](https://mopidy.com/)
-
-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.
-
-### File-Based
-
-See [`mopidy.json.example`](/config/mopidy.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23%2Fdefinitions%2FMopidySourceConfig/%23%2Fdefinitions%2FMopidyData?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fsource.json)
-
-Configuration Options:
-
-##### `url`
-
-The URL used to connect to the Mopidy server. You MUST have [Mopidy-HTTP extension](https://mopidy.com/ext/http) enabled.
-
-If no `url` is provided a default is used which assumes Mopidy is installed on the same server as multi-scrobbler: `ws://localhost:6680/mopidy/ws/`
-
-Make sure the hostname and port number match what is found in the Mopidy configuration file `mopidy.conf`:
-
-```
-...
-
-[http]
-hostname = localhost
-port = 6680
-
-...
-```
-
-The URL used to connect ultimately must be formed like this: `[protocol]://[hostname]:[port]/[path]`
-If any part of this URL is missing multi-scrobbler will use a default value, for your convenience. This also means that if any part of your URL is **not** standard you must explicitly define it.
-
-Part => Default Value
-
-* Protocol => `ws://`
-* Hostname => `localhost`
-* Port => `6680`
-* Path => `/mopidy/ws/`
-
-<details>
-<summary>URL Transform Examples</summary>
-
-```json
-{
-  "url": "mopidy.mydomain.com"
-}
-```
-
-MS transforms this to: `ws://mopidy.mydomain.com:6680/mopidy/ws/`
-
-```json
-{
-  "url": "192.168.0.101:3456"
-}
-```
-
-MS transforms this to: `ws://192.168.0.101:3456/mopidy/ws/`
-
-```json
-{
-  "url": "mopidy.mydomain.com:80/MOPWS"
-}
-```
-
-MS transforms this to: `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.
-
-EX:
-
-```json
-{
-  "uriBlacklist": ["soundcloud"]
-}
-```
-
-Will prevent multi-scrobbler from scrobbling any Mopidy track that start with a `uri` like `soundcloud:song:MySong-1234`
-
-#### 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.
-
-EX:
-
-```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`
-
-## [JRiver](https://jriver.com/)
-
-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
-
-If you do not provide a URL then a default is used which assumes JRiver is installed on the same server as multi-scrobbler: `http://localhost:52199/MCWS/v1/`
-
-* Make sure the port number matches what is found in `Advanced` section in the [Media Network](#jriver) options.
-* If your installation is on the same machine but you cannot connect using `localhost` try `0.0.0.0` instead.
-
-The URL used to connect ultimately must be formed like this: `[protocol]://[hostname]:[port]/[path]`
-If any part of this URL is missing multi-scrobbler will use a default value, for your convenience. This also means that if any part of your URL is **not** standard you must explicitly define it.
-
-Part => Default Value
-
-* Protocol => `http://`
-* Hostname => `localhost`
-* Port => `52199`
-* Path => `/MCWS/v1/`
-
-<details>
-<summary>URL Transform Examples</summary>
-
-```json
-{
-  "url": "jriver.mydomain.com"
-}
-```
-
-MS transforms this to: `http://jriver.mydomain.com:52199/MCWS/v1/`
-
-```json
-{
-  "url": "192.168.0.101:3456"
-}
-```
-
-MS transforms this to: `http://192.168.0.101:3456/MCWS/v1/`
-
-```json
-{
-  "url": "mydomain.com:80/jriverReverse/MCWS/v1/"
-}
-```
-
-MS transforms this to: `http://mydomain.com:80/jriverReverse/MCWS/v1/`
-
-</details>
-
-### ENV-Based
-
-
-| 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  |
-
-
-### File-Based
-
-See [`jriver.json.example`](/config/jriver.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23%2Fdefinitions%2FJRiverSourceConfig/%23%2Fdefinitions%2FJRiverData?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fsource.json)
-
-# Client Configurations
-
-## [Maloja](https://github.com/krateng/maloja)
-
-### ENV-Based
-
-| Environmental Variable | Required? | Default |          Description          |
-|----------------------------|-----------|---------|-------------------------------|
-| `MALOJA_URL`               | Yes       |         | Base URL of your installation |
-| `MALOJA_API_KEY`           | Yes       |         | Api Key                       |
-
-### File-Based
-
-See [`maloja.json.example`](/config/maloja.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23/%23%2Fdefinitions%2FMalojaClientConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fclient.json)
-
-## [Last.fm](https://www.last.fm)
-
-[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
-
-### ENV-Based
-
-| 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.                       |
-
-### File-Based
-
-See [`lastfm.json.example`](/config/lastfm.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23/%23%2Fdefinitions%2FLastfmClientConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fclient.json)
-
-## [Listenbrainz](https://listenbrainz.org)
-
-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.
-
-### ENV-Based
-
-
-| 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  |
-
-### File-Based
-
-See [`listenbrainz.json.example`](/config/listenbrainz.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23%2Fdefinitions%2FListenBrainzClientConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Fclient.json)
-
-# Monitoring
-
-multi-scrobbler supports some common webhooks and a healthcheck endpoint in order to monitor Sources and Clients for errors.
-
-## Webhook Configurations
-
-Webhooks will **push** a notification to your configured servers on these events:
-
-* Source polling started 
-* Source polling retry
-* Source polling stopped on error 
-* Scrobble client scrobble failure
-
-Webhooks are configured in the main [config.json](#all-in-one-file-configuration) file under the `webhook` top-level property. Multiple webhooks may be configured for each webhook type. EX:
-
-```json
-{
-  "sources": [
-    ...
-  ],
-  "clients": [
-    ...
-  ],
-  "webhooks": [
-    {
-      "name": "FirstGotifyServer",
-      "type": "gotify",
-      "url": "http://192.168.0.100:8070",
-      "token": "abcd"
-    }, 
-    {
-      "name": "SecondGotifyServer",
-      "type": "gotify",
-      ...
-    },
-    {
-      "name": "NtfyServerOne",
-      "type": "ntfy",
-      ...
-    },
-    ...
-  ]
-}
-```
-
-### [Gotify](https://gotify.net/)
-
-Refer to the [config schema for GotifyConfig](https://json-schema.app/view/%23/%23%2Fdefinitions%2FGotifyConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Faio.json)
-
-multi-scrobbler optionally supports setting message notification priority via `info` `warn` and `error` mappings.
-
-EX
-
-```json
-{
-  "type": "gotify",
-  "name": "MyGotifyFriendlyNameForLogs",
-  "url": "http://192.168.0.100:8070",
-  "token": "AQZI58fA.rfSZbm",
-  "priorities": {
-    "info": 5,
-    "warn": 7,
-    "error": 10
-  }
-}
-```
-
-### [Ntfy](https://ntfy.sh/)
-
-Refer to the [config schema for NtfyConfig](https://json-schema.app/view/%23/%23%2Fdefinitions%2FNtfyConfig?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fdevelop%2Fsrc%2Fcommon%2Fschema%2Faio.json)
-
-multi-scrobbler optionally supports setting message notification priority via `info` `warn` and `error` mappings.
-
-EX
-
-```json
-{
-  "type": "ntfy",
-  "name": "MyNtfyFriendlyNameForLogs",
-  "url": "http://192.168.0.100:9991",
-  "topic": "RvOwKJ1XtIVMXGLR",
-  "username": "Optional",
-  "password": "Optional",
-  "priorities": {
-    "info": 3,
-    "warn": 4,
-    "error": 5
-  }
-}
-```
-
-## Health Endpoint
-
-An endpoint for monitoring the health of sources/clients is available at GET `http://YourMultiScrobblerDomain/health`
-
-* Returns `200 OK` when **everything** is working or `500 Internal Server Error` if **anything** is not 
-* The plain url (`/health`) aggregates status of **all clients/sources** -- so any failing client/source will make status return 500 
-  * Use query params `type` or `name` to restrict client/sources aggregated IE `/health?type=spotify` or `/health?name=MyMaloja`
-* On 500 the response returns a JSON payload with `messages` array that describes any issues
-  * For any clients/sources that require authentication `/health` will return 500 if they are **not authenticated** 
-  * For sources that poll (spotify, yt music, subsonic) `/health` will 500 if they are **not polling**

docs/installation.md

@@ -1,82 +0,0 @@
-# Installation
-
-## Local
-
-Clone this repository somewhere and then install from the working directory
-
-```bash
-git clone https://github.com/FoxxMD/multi-scrobbler.git .
-cd multi-scrobbler
-nvm use # optional, to set correct Node version
-npm install
-npm build
-npm start
-```
-
-### Local Usage Examples
-
-* The web UI is served on port `9078`. This can be modified using the `PORT` environmental variable.
-
-#### Using [file-based](/docs/configuration.md#file-based-configuration) configuration
-
-```bash
-npm start
-```
-
-#### Using [env-based](/docs/configuration.md#env-based-configuration) configuration
-
-```bash
-SPOTIFY_CLIENT_ID=yourId SPOTIFY_CLIENT_SECRET=yourSecret MALOJA_URL="http://domain.tld" node src/index.js
-```
-
-## [Docker](https://hub.docker.com/r/foxxmd/multi-scrobbler)
-
-Cross-platform images are built for x86 (Intel/AMD) and ARM (IE Raspberry Pi)
-
-```
-foxxmd/multi-scrobbler:latest
-```
-
-Or use the provided [docker-compose.yml](/docker-compose.yml) after modifying it to fit your configuration.
-
-Recommended configuration steps for docker or docker-compose usage:
-
-* If you must **bind a host directory into the container for storing configurations and credentials:**
-    * [Using `-v` method for docker](https://docs.docker.com/storage/bind-mounts/#start-a-container-with-a-bind-mount): `-v /path/on/host/config:/config`
-    * [Using docker-compose](https://docs.docker.com/compose/compose-file/compose-file-v3/#short-syntax-3): `- /path/on/host/config:/config`
-* (Optionally) map the web UI port in the container **9078** to the host
-    * With [docker](https://docs.docker.com/engine/reference/commandline/run/#publish): `-p 9078:9078` (first port is the port on the host to use)
-    * With [docker-compose](https://docs.docker.com/compose/compose-file/compose-file-v3/#short-syntax-1): `- "9078:9078"`
-* (Optionally) set the [timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for the container using the environmental variable `TZ` ([docker](https://docs.docker.com/engine/reference/commandline/run/#env)) ([docker-compose](https://docs.docker.com/compose/compose-file/compose-file-v3/#environment))
-
-### Linux Host
-
-If you are
-
-* using [rootless containers with Podman](https://developers.redhat.com/blog/2020/09/25/rootless-containers-with-podman-the-basics#why_podman_)
-* running docker on MacOS or Windows
-
-this **DOES NOT** apply to you.
-
-If you are running Docker on a **Linux Host** you must specify `user:group` permissions of the user who owns the **configuration directory** on the host to avoid [docker file permission problems.](https://ikriv.com/blog/?p=4698) These can be specified using the [environmental variables **PUID** and **PGID**.](https://docs.linuxserver.io/general/understanding-puid-and-pgid)
-
-To get the UID and GID for the current user run these commands from a terminal:
-
-* `id -u` -- prints UID
-* `id -g` -- prints GID
-
-### Docker Usage Examples
-
-#### Using [env-based](/docs/configuration.md#env-based-configuration) configuration
-
-```bash
-docker run -e "SPOTIFY_CLIENT_ID=yourId" -e "SPOTIFY_CLIENT_SECRET=yourSecret" -e "MALOJA_URL=http://domain.tld" -e "MALOJA_API_KEY=1234" -e "PUID=1000" -e "PGID=1000" -p 9078:9078 -v /path/on/host/config:/config foxxmd/multi-scrobbler
-```
-
-#### Using [file-based](/docs/configuration.md#file-based-configuration) configuration
-
-```bash
-docker run -e "PUID=1000" -e "PGID=1000" -p 9078:9078 -v /path/on/host/config:/config foxxmd/multi-scrobbler
-```
-
-See the [docker-compose.yml](/docker-compose.yml) file for how to use with docker-compose.

docsite/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docsite/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docsite/docs/FAQ.md

@@ -0,0 +1,273 @@
+---
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+---
+
+## Connection Issues
+
+### Plex (Webhook)/Tautulli/Jellyfin(Webhook)/Webscrobbler don't connect
+
+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.
+
+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
+```
+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
+```
+**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.**
+
+This is not something multi-scrobbler can fix and means you have an issue in your network.
+
+#### Troubleshooting
+
+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 `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.**
+
+EX `http://localhost:9078/plex` -> `http://192.168.0.140:9078/plex`
+
+##### Check Firewall and Port Forwarding
+
+If the machine multi-scrobbler is running on has a firewall ensure that port **9078** is open. Or if it is in another network entirely make sure your router is forwarding this port and it is open to the correct machine.
+
+##### 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 (Webhook) 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 enabling Debug Mode with the env `DEBUG_MODE=true` which will output the raw payload to DEBUG level logging.
+
+If your issue persists and you open an Issue for it please include the raw payload logs in your report.
+
+### Jellyfin (Webhook) 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.
+
+The callback/redirect URL for these services must be:
+
+* the same address you would use to access the multi-scrobbler web interface
+  * the web-interface must be accessible from the browser you are completing authentication from.
+
+If multi-scrobbler is not running on the same machine your browser is on then the default/example addresses (`http://localhost...`) **will not work.** You must determine the address you can reach the web interface at (such as `http://192.168.0.140:9078`) then use that in place of `localhost` in the callback URLs.
+
+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
+
+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 authentication.
+
+First, ensure you are NOT using [YoutubeTV authentication.](configuration/configuration.mdx?ytmAuth=ytt#youtube-music) 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/configuration.mdx?ytmAuth=cookie#youtube-music) and then restart MS to potentially resolve the problem.
+
+## Configuration Issues
+
+### Config could not be parsed
+
+If you see something like this in your logs:
+
+```
+2023-02-19T10:05:42-06:00 warn   : [App] App config file exists but could not be parsed!
+2023-02-19T10:05:42-06:00 error  : [App] Exited with uncaught error
+2023-02-19T10:05:42-06:00 error  : [App] Error: config.json could not be parsed
+```
+
+It means the JSON in your configuration file is not valid. Copy and paste your configuration into a site like [JSONLint](https://jsonlint.com/) to find out where errors you have and fix them.
+
+## Scrobbling Issues
+
+### Last.fm does not scrobble tracks with multiple artists correctly
+
+This is a limitation of the [Last.fm API](https://www.last.fm/api/show/track.scrobble) where the **artist** field is only one string and Last.fm does not recognize (play well) with "combined" artists.
+
+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 (Webhook) 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)
+
+You can avoid this entirely by using the newer [Jellyfin API Source](configuration/configuration.mdx#jellyfin) which correctly handles multiple artists.
+
+### 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.
+
+### Google Cast device does not track media
+
+It is likely the app playing on the cast device is incorrectly reporting the media type as **not music**. 
+
+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
+
+```
+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
+
+### 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)
+
+### Youtube Music misses or duplicates scrobbles
+
+<details>
+
+  <summary>How MS detects YTM history</summary>
+
+  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/configuration.mdx?#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

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

docsite/docs/configuration/kitchensink.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 3
+title: Kitchen Sink
+---
+
 # Example Config using all Possible Features
 
 Scenario: 
@@ -16,9 +21,7 @@ Scenario:
 
 ### All-in-one Config
 
-Using just one config file located at `CONFIG_DIR/config.json`:
-
-```json5
+```json5 title="CONFIG_DIR/config.json"
 {
   "sourceDefaults": {
     "maxPollRetries": 0,          // optional, default # of automatic polling restarts on error. can be overridden by property in individual config
@@ -37,6 +40,8 @@ Using just one config file located at `CONFIG_DIR/config.json`:
       "data": {
         "clientId": "foxxSpotifyAppId", 
         "clientSecret": "foxxSpotifyAppSecret",
+      },
+      "options": {
         "maxRequestRetries": 2,  // override default max retries because spotify can...spotty
       }
     },
@@ -64,7 +69,9 @@ Using just one config file located at `CONFIG_DIR/config.json`:
       "name": "fredPlex",
       "clients": ["fredMaloja"],
       "data": {
-        "user": ["fred@email.com"]
+        "token": "JtRnwQWD__XMJF8sT3jc",
+        "url": "192.168.0.233:32400",
+        "usersallow": ["fredUser"]
       }
     },
     {
@@ -72,8 +79,10 @@ Using just one config file located at `CONFIG_DIR/config.json`:
       "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"]
       }
     },
     {
@@ -81,7 +90,9 @@ Using just one config file located at `CONFIG_DIR/config.json`:
       "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"]
       }
     },
     {
@@ -89,7 +100,10 @@ Using just one config file located at `CONFIG_DIR/config.json`:
       "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"]
       }
     },
     {
@@ -108,7 +122,6 @@ Using just one config file located at `CONFIG_DIR/config.json`:
       "clients": ["foxxMaloja"],
       "data": {
         "cookie": "__Secure-3PAPISID=3AxsXpy0MKGu75Qb/AkISXGqOnSDn1jEKn; DEVICE_INFO=ChxOekU0Tmpjek5EWTBPRGd3TlRBMk16QXpNdz09EJbS8Z0GGJbS8Z0G; ...",
-        "authUser": 1
       }
     },
   ],
@@ -153,9 +166,7 @@ Using just one config file located at `CONFIG_DIR/config.json`:
 
 ### Separate JSON files
 
-In `CONFIG_DIR/spotify.json`:
-
-```json5
+```json5 title="CONFIG_DIR/spotify.json"
 [
   {
     // may omit 'type' property since app knows this is file is for spotify configs
@@ -186,50 +197,53 @@ In `CONFIG_DIR/spotify.json`:
 ]
 ```
 
-In `CONFIG_DIR/plex.json`
-
-```json5
+```json5 title="CONFIG_DIR/plex.json"
 [
   {
     "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"]
     }
   }
 ]
 ```
 
-In `CONFIG_DIR/jellyfin.json`
-
-```json5
+```json5 title="CONFIG_DIR/jellyfin.json"
 [
   {
     "name": "FredJelly",
     "data": {
-      "user": ["fred@email.com"]
+      "url": "http://localhost:8096",
+      "user": "FoxxMD",
+      "apiKey": "c9fae8756fbf481ebd9c5bb56bd6540c",
+      "usersAllow": ["fredUser"]
     }
   }
 ]
 ```
 
-In `CONFIG_DIR/ytmusic.json`
-
-```json5
+```json5 title="CONFIG_DIR/ytmusic.json"
 [
   {
     "type": "ytmusic",
@@ -237,15 +251,12 @@ In `CONFIG_DIR/ytmusic.json`
     "clients": ["foxxMaloja"],
     "data": {
       "cookie": "__Secure-3PAPISID=3AxsXpy0MKGu75Qb/AkISXGqOnSDn1jEKn; DEVICE_INFO=ChxOekU0Tmpjek5EWTBPRGd3TlRBMk16QXpNdz09EJbS8Z0GGJbS8Z0G; ...",
-      "authUser": 1
     }
   }
 ]
 ```
 
-In `CONFIG_DIR/maloja.json`:
-
-```json5
+```json5 title="CONFIG_DIR/maloja.json"
 [
   {
     "name": "foxxMaloja",
@@ -271,9 +282,7 @@ In `CONFIG_DIR/maloja.json`:
 ]
 ```
 
-In `CONFIG_DIR/lastfm.json`:
-
-```json5
+```json5 title="CONFIG_DIR/lastfm.json"
 [
   {
     "name": "maryLFM",

docsite/docs/configuration/plex.md

@@ -1,3 +1,16 @@
+---
+sidebar_position: 2
+title: Plex/Tautulli (Deprecated)
+---
+
+:::warning[Deprecated]
+
+Multi-scrobbler >= 0.8.8 supports a Plex Source that [directly uses the API](configuration/configuration.mdx?plexType=api#plex) which removes the need to use Tautulli since it does not require Plex Pass.
+
+The Tautulli source **and** Plex Webhook source are deprecated and will be removed in an upcoming release. Existing users should migrate to the API source as soon as possible.
+
+:::
+
 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)

docsite/docs/configuration/transforms.mdx

@@ -0,0 +1,523 @@
+---
+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>
+
+### Extract primary Artist from delimited, multi-Artist string
+
+<details>
+
+  When the Artist string is actually a multi-artist, delimited string, this search-and-replace will replace the string with just the first artist found.
+
+  Ex
+
+  ```
+  My Artist One / My Artist Two / Another Guy
+  My Artist One
+  ```
+
+  Artists are delimited with a spaced forward slash (`/`) in the regex below. Replace the contents of the `delim` capture group with the delimiter for your use case. Some more common scenarios:
+
+  * `(?<delim>\\/)` No spaces between slash IE `My Artist One/My Artist Two/Another Guy`
+  * `(?<delim>\\s*\\\\\s*)` Backslash instead of forward slash IE `My Artist One \ My Artist Two \ Another Guy`
+  * `(?<delim>,)` Comma IE `My Artist One, My Artist Two, Another Guy`
+
+  <details>
+
+      <summary>Example</summary>
+  ```json5 title="config.json"
+  {
+    "sourceDefaults": {
+      "playTransform": {
+        "preCompare": {
+          "artists": [
+            {
+              "search": "(.*?)(?<delim>\\s*\\/\\s*)(.*$)",
+              "replace": "$1"
+            }
+          ]
+        }
+      }
+    }
+  }
+  ```
+  </details>
+
+</details>

docsite/docs/development/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Development",
+  "position": 4,
+  "link": {
+    "type": "generated-index",
+    "description": "Developing for Multi-Scrobbler and tutorials"
+  }
+}

docsite/docs/development/dev-client.md

@@ -0,0 +1,8 @@
+---
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+sidebar_position: 3
+title: Client Development/Tutorial
+---
+
+To do...

docsite/docs/development/dev-common.md

@@ -0,0 +1,180 @@
+---
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+sidebar_position: 1
+title: Common Development
+description: Start here for MS development
+---
+
+# Development
+
+## Architecture
+
+Multi-scrobbler is written entirely in [Typescript](https://www.typescriptlang.org/). It consists of a backend and frontend. The backend handles all Source/Client logic, mounts web server endpoints that listen for Auth callbacks and Source ingress using [expressjs](https://expressjs.com/), and  serves the frontend. The frontend is a standalone [Vitejs](https://vitejs.dev/) app that communicates via API to the backend in order to render the dashboard.
+
+## Project Setup
+
+Development requires [Node v18.19.1](https://nodejs.org/en) or higher is installed on your system. 
+
+:::tip
+
+When running locally (not with a devcontainer) you can use [nvm](https://github.com/nvm-sh/nvm) to manage the installed node version.
+
+:::
+
+Clone this repository somewhere and then install from the working directory
+
+```shell
+git clone https://github.com/FoxxMD/multi-scrobbler.git .
+cd multi-scrobbler
+nvm use # optional, sets correct node version when running without devcontainer
+npm install
+npm run start
+```
+
+### VSCode
+
+This repository contains [workspace settings](https://github.com/FoxxMD/multi-scrobbler/blob/master/.devcontainer) for development with VSCode. These include:
+
+* Run/Debug [Launch configurations](https://code.visualstudio.com/Docs/editor/debugging#_launch-configurations) for the application and tests
+* [Devcontainer](https://code.visualstudio.com/docs/devcontainers/containers) for development with all dependencies already installed
+* Useful extensions for linting and running tests
+
+To use the Devcontainer simple open the repository in VSCode and "Use Devcontainer" when the notification is presented. `npm install` will be run when a new container is created.
+
+## Common Development
+
+:::info
+
+In this document, when referring to aspects of Sources and Clients that are shared between both, the Source/Client will be referred to as a **Component.**
+
+:::
+
+A Component is composed of two parts:
+
+* Typescript interfaces describing structure of configuration for that Component
+* A concrete class inheriting from a common "startup" abstract class that enforces how the Component is built and operates
+
+In both parts Source/Clients share some common properties/behavior before diverging in how they operate.
+
+### Config
+
+The configuration for a Component should always have this minimum shape, enforced respectively by the interfaces [CommonSourceConfig](https://github.com/FoxxMD/multi-scrobbler/blob/master/src/backend/common/infrastructure/config/source/index.ts#L105) and [CommonClientConfig](https://github.com/FoxxMD/multi-scrobbler/blob/ce1c70a4e1e87fb5bea7cca960eaafbd15881a1f/src/backend/common/infrastructure/config/client/index.ts#L68):
+
+```ts
+interface MyConfig {
+  name: string
+  data?: object
+  options?: object
+}
+```
+
+* `data` contains data that is required for a Component to operate such as credentials, callback urls, api keys, endpoints, etc...
+* `options` are **optional** settings that can be used to fine-tune the usage of the Component but are not required or do not majorly affect behavior. EX additional logging toggles
+
+### Concrete Class
+
+Components inherit from an abstract base class, [`AbstractComponent`](https://github.com/FoxxMD/multi-scrobbler/blob/master/src/backend/common/AbstractComponent.ts), that defines different "stages" of how a Component is built and initialized when MS first starts as well as when restarting the Component in the event it stops due to an error/network failure/etc...
+
+#### Stages
+
+Stages below are invoked in the order listed. All stages are asynchronous to allow fetching network requests or reading files.
+
+The stage function (described in each stage below) should return a value or throw:
+
+* return `null` if the stage is not required
+* return `true` if the stage succeeded
+* return a `string` if the stage succeeded and you wish to append a result to the log output for this stage
+* throw an `Exception` if the stage failed for any reason and the Component should not continue to run/start up
+
+##### Stage: Build Data
+
+This stage should be used to validate user configuration, parse any additional data from async sources (file, network), and finalize the shape of any configuration/data needed for the Component to operate.
+
+:::info
+
+Implement [`doBuildInitData`](https://github.com/FoxxMD/multi-scrobbler/blob/master/src/backend/common/AbstractComponent.ts#L71) in your child class to invoke this stage.
+
+::::
+
+<details>
+
+<summary>Examples</summary>
+
+* Parse a full URL like `http://SOME_IP:7000/subfolder/api` from user config containing a base url like `data.baseUrl: 'SOME_IP'` and then store this in the class config
+* Validate that config `data` contains required properties `user` `password` `salt`
+* Read stored credentials from `${this.configDir}/currentCreds-MySource-${name}.json`;
+
+</details>
+
+##### Stage: Check Connection
+
+This stage is used to validate that MS can communicate with the service the Component is interacting with. This stage is invoked on MS startup as well as any time the Component tries to restart after a failure.
+
+If the Component depends on **ingress** (like Jellyfin/Plex webhook) this stage is not necessary.
+
+:::info
+
+Implement [`doCheckConnection`](https://github.com/FoxxMD/multi-scrobbler/blob/master/src/backend/common/AbstractComponent.ts#L103) in your child class to invoke this stage.
+
+::::
+
+<details>
+
+<summary>Examples</summary>
+
+* Make a [`request`](https://nodejs.org/docs/latest-v18.x/api/http.html#httprequesturl-options-callback) to the service's server to ensure it is accessible
+* Open a websocket connection and check for a ping-pong
+
+</details>
+
+##### Stage: Test Auth
+
+MS determines if Auth is required for a Component based on two class properties. You should set these properties during `constructor` initialization for your Component class:
+
+* `requiresAuth` - (default `false`) Set to `true` if MS should check/test Auth for this Component
+* `requiresAuthInteraction` - (default `false`) Set to `true` if user interaction is required to complete auth IE user needs to visit a callback URL
+
+If the Component requires authentication in order to communicate with a service then any required data should be built in this stage and a request made to the service to ensure the authentication data is valid.
+
+This stage should return:
+
+* `true` if auth succeeded
+* `false` if auth failed without unexpected errors 
+  * IE the authentication data is not valid and requires user interaction to resolve the failure
+* throw an exception if network failure or unexpected error occurred
+
+You _should_ attempt to re-authenticate, if possible. Only throw an exception or return `false` if there is no way to recover from an authentication failure.
+
+:::info
+
+Implement [`doAuthentication`](https://github.com/FoxxMD/multi-scrobbler/blob/master/src/backend/common/AbstractComponent.ts#L111) in your child class to invoke this stage.
+
+::::
+
+<details>
+
+<summary>Examples</summary>
+
+* Generate a Bearer Token for Basic Auth from user/password given in config and store in class properties
+* Make a request to a known endpoint with Authorization token from read credentials file to see if succeeds or returns 403
+* Catch a 403 and attempt to reauthenticate at an auth endpoint with user/password given in config
+
+</details>
+
+### Play Object
+
+The **PlayObject** is the standard data structure MS uses to store listen (track) information and data required for scrobbling. It consists of:
+
+* Track Data -- a standard format for storing track, artists, album, track duration, the date the track was played at, etc...
+* Listen Metadata -- Optional but useful data related to the specific play or specifics about the Source/Client context for this play such as
+  * Platform specific ID, web URL to track, device/user ID that played this track, etc...
+
+Both Sources and Clients use the **PlayObject** interface. When a Component receives track info from its corresponding service it must transform this data into a PlayObject before it can be interacted with.
+
+For more refer to the TS documentation for `PlayObject` or [`AmbPlayObject`](https://github.com/FoxxMD/multi-scrobbler/blob/master/src/core/Atomic.ts#L141) in your project
+
+## Creating Clients and Sources
+
+* [Source Development and Tutorial](dev-source.md)
+* [Client Development and Tutorial](dev-client.md)

docsite/docs/development/dev-source.md

@@ -0,0 +1,552 @@
+---
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+sidebar_position: 2
+title: Source Development/Tutorial
+---
+
+This document will provide a step-by-step guide for creating a (trivial) new Source in MS alongside describing what aspects of the Source need to be implemented based on the service you use. Before using this document you should review [Common Development](dev-common.md#common-development).
+
+## Scenario
+
+You are the developer of a fancy, new self-hosted web-based media player called **Cool Player.** Cool Player has a slick interface and many bells and whistles, but most importantly it has an API. The API:
+
+* Has an unauthenticated health endpoint at `/api/health` that returns `200` if the service is running properly
+* Has authenticated endpoints that require a user-generated token in the header `Authorization MY_TOKEN`
+  * Has a `/api/recent` endpoint that lists recently played tracks with a timestamp
+  * Has a `/api/now-playing` endpoint that returns information about the state of the player like current track, player position in the track, etc...
+* Cool Player is by default accessed on port `6969`
+* Your personal instance of Cool Player is hosted at `http://192.168.0.100:6969` and the api is accessed at `http://192.168.0.100:6969/api`
+
+Because there is an API that MS can actively read this will be a **polling** Source where MS sends requests to Cool Player to get scrobble information -- as opposed to an **ingress** Source like Jellyfin/Plex that uses webhooks from the service to send data to MS.
+
+## Minimal Implementation
+
+### Define and Implement Config
+
+We will create a new config interface for Cool Player using the [Common Config](dev-common.md#config) and tell MS it is a valid config that can be used.
+
+Create a new file for your config:
+
+```ts title="/src/backend/common/infrastructure/config/source/coolplayer.ts"
+import { PollingOptions } from "../common.js";
+import { CommonSourceConfig, CommonSourceData } from "./index.js";
+
+// all of the required data for the Build Data and Test Auth stages (from Common Development docs)
+// should go here
+export interface CoolPlayerSourceData extends CommonSourceData, PollingOptions {
+// remember to annotation your properties!
+
+  /**
+   * The user-generated token for Cool Player auth created in Cool Player -> Settings -> User -> Tokens
+   *
+   * @example f243331e-cf5b-49d7-846b-0845bdc965b4
+   * */
+  token: string
+  /**
+   * The host and port where Cool Player is hosted
+   *
+   * @example http://192.168.0.100:6969
+   * */
+  baseUrl: string
+}
+
+export interface CoolPlayerSourceConfig extends CommonSourceConfig {
+  data: CoolPlayerSourceData
+}
+
+export interface CoolPlayerSourceAIOConfig extends CoolPlayerSourceConfig {
+  // when using the all-in-one 'config.json' this is how users will identify this source
+  type: 'coolplayer'
+}
+```
+
+Add the new interface to the list of valid interfaces for sources:
+
+```ts title="src/backend/common/infrastructure/config/source/sources.ts"
+import { ChromecastSourceAIOConfig, ChromecastSourceConfig } from "./chromecast.js";
+// ...
+// highlight-next-line
+import { CoolPlayerSourceAIOConfig, CoolPlayerSourceConfig } from "./coolplayer.js";
+
+export type SourceConfig =
+        SpotifySourceConfig
+        // ...
+        // highlight-next-line
+        | CoolPlayerSourceConfig;
+
+export type SourceAIOConfig =
+        SpotifySourceAIOConfig
+        // ...
+        // highlight-next-line
+        | CoolPlayerSourceAIOConfig;
+```
+
+Finally, add the source type identifier to the list of valid identifiers
+
+```ts title="src/backend/common/infrastructure/Atomic.ts"
+export type SourceType =
+    'spotify'
+    // ...
+    // highlight-next-line
+    | 'coolplayer';
+
+export const sourceTypes: SourceType[] = [
+    'spotify',
+    // ...
+    // highlight-next-line
+    'coolplayer'
+];
+```
+
+Now we will create a new Source inheriting from [`AbstractComponent`](dev-common.md#concrete-class) that:
+
+* accepts our config interface
+* implements a function to transform CoolPlayer's track data into a [**PlayObject**](dev-common.md#play-object)
+* implements required [stages](dev-common.md#stages)
+* implements required methods to current player state and/or now playing track
+
+### Create CoolPlayer Source
+
+First we create a new Source called `CoolPlayerSource` and setup our constructor to accept the config and [specify Auth behavior.](dev-common.md#stage-test-auth)
+
+```ts title="src/backend/sources/SpotifySource.ts"
+import { CoolPlayerSourceConfig } from "../common/infrastructure/config/source/coolplayer.js";
+import MemorySource from "./MemorySource.js";
+import {
+  InternalConfig,
+} from "../common/infrastructure/Atomic.js";
+
+// MemorySource is the base class used for polling-type Sources
+export default class CoolPlayerSource extends MemorySource {
+
+  // type hints for TS to know what the base class config looks like
+  declare config: CoolPlayerSourceConfig;
+
+  constructor(name: any, config: CoolPlayerSourceConfig, internal: InternalConfig, emitter: EventEmitter) {
+    super('coolplayer', name, config, internal, emitter);
+
+    // Cool Player required authentication
+    this.requiresAuth = true;
+    // but does not require user interaction for auth to work
+    this.requiresAuthInteraction = false;
+    // tells MS this is a Source that can be activity monitored through API
+    this.canPoll = true;
+  }
+}
+```
+
+### Initialize Source from Config
+
+When MS starts it reads all configs and determines which Source to build based on the configs found. We need to tell it to build a `CoolPlayerSource` when a `coolplayer` config type is found.
+
+We modify `ScrobbleSources.ts` to add `CoolPlayerSource` as an option:
+
+```ts title="src/backend/sources/ScrobbleSources.ts"
+// ...
+import { CoolPlayerSource, CoolPlayerData } from "./CoolPlayerSource.js";
+
+export default class ScrobbleSources {
+  // ...
+  buildSourcesFromConfig = async (additionalConfigs: ParsedConfig[] = []) => {
+    // ...
+
+    // if CoolPlayerSource should be able to be built from ENVs only 
+    // then add it as a case statement here
+    for (const sourceType of sourceTypes) {
+      switch (sourceType) {
+              // ...
+        case 'musikcube':
+          // ...
+          break;
+              // highlight-start
+        case 'coolplayer':
+          const cp = {
+            baseUrl: process.env.COOL_URL,
+            token: process.env.COOL_TOKEN
+          }
+          if (!Object.values(cp).every(x => x === undefined)) {
+            configs.push({
+              type: 'coolplayer',
+              name: 'unnamed',
+              source: 'ENV',
+              mode: 'single',
+              configureAs: defaultConfigureAs,
+              data: cp as CoolPlayerData
+            });
+          }
+          break;
+              // highlight-end
+        default:
+          break;
+      }
+    }
+  }
+
+  // ...
+
+  // (required) create new CoolPlayerSource if source config type is 'coolplayer'
+  addSource = async (clientConfig: ParsedConfig, defaults: SourceDefaults = {}) => {
+    // ...
+    let newSource: AbstractSource;
+    switch (type) {
+      // ...
+      case 'musikcube':
+        // ...
+        break;
+            // highlight-start
+      case 'coolplayer':
+        newSource = await new CoolPlayerSource(name, compositeConfig as CoolPlayerSourceConfig, internal, this.emitter);
+        break;
+            // highlight-end
+      default:
+        break;
+    }
+  }
+}
+```
+
+### Implement Play Object Transform
+
+Now we will create a static function that is used to take the track data returned from Cool Player's API and return a standard [`PlayObject`.](dev-common.md#play-object)
+
+```ts title="src/backend/sources/CoolPlayerSource.ts"
+import dayjs from "dayjs";
+import {
+  FormatPlayObjectOptions,
+} from "../common/infrastructure/Atomic.js";
+import { PlayObject } from "../../core/Atomic.js";
+
+export default class CoolPlayerSource extends MemorySource {
+  // ...
+
+  // 'obj' should ideally be a real TS interface
+  // if CoolPlayer has a ts/js client we would use that otherwise
+  // we should build our own interfaces to represent track data from Cool Player's API
+  static formatPlayObj(obj: any, options: FormatPlayObjectOptions = {}): PlayObject {
+    const {
+      trackName,
+      artistName,
+      albumName,
+      duration,
+      playedAt,
+    } = obj;
+
+    return {
+      data: {
+        artists: [artistName],
+        album: albumName,
+        track: trackName,
+        // assuming seconds
+        duration,
+        // assuming playedAt is an ISO8601 timestamp
+        playDate: dayjs(playedAt)
+      },
+      meta: {
+        source: 'CoolPlayer'
+      }
+    }
+  }
+}
+```
+
+### Implement Stages
+
+Next we will implement the [Stages](dev-common.md#stages) required to get CoolPlayerSource running.
+
+#### Build Data
+
+First we implement the [Build Data Stage](dev-common.md#stage-build-data). We will check that the `token` and `baseUrl` properties have been provided by the user. Additionally, we will parse the baseUrl and add default ports/prefix.
+
+```ts title="src/backend/sources/CoolPlayerSource.ts"
+import { URL } from "url";
+// ...
+
+export default class CoolPlayerSource extends MemorySource {
+
+  baseUrl!: URL;
+
+  // ...
+
+  static parseConnectionUrl(val: string) {
+    const normal = normalizeUrl(val, {removeTrailingSlash: false, normalizeProtocol: true})
+    const url = new URL(normal);
+
+    if (url.port === null || url.port === '') {
+      url.port = '6969';
+    }
+    if (url.pathname === '/') {
+      url.pathname = '/api/';
+    }
+    return url;
+  }
+
+  protected async doBuildInitData(): Promise<true | string | undefined> {
+    const {
+      token,
+      baseUrl
+    } = this.config;
+    if (token === null || token === undefined || (typeof token === 'string' && token.trim() === '')) {
+      throw new Error(`'token' must be defined`);
+    }
+
+    if (baseUrl === null || baseUrl === undefined || (typeof baseUrl === 'string' && baseUrl.trim() === '')) {
+      throw new Error(`'baseUrl' must be defined`);
+    }
+    try {
+      this.baseUrl = CoolPlayerSource.parseConnectionUrl(baseUrl);
+    } catch (e) {
+      throw new Error(`Could not parse baseUrl: ${baseUrl}`, {cause: e});
+    }
+
+    this.logger.verbose(`Config URL: ${baseUrl} => Normalized: '${this.url.toString()}'`);
+    return true;
+  }
+}
+```
+
+#### Check Connection
+
+Second we will implement the [Check Connection Stage](dev-common.md#stage-check-connection):
+
+```ts title="src/backend/sources/CoolPlayerSource.ts"
+import request from 'superagent';
+import { UpstreamError } from "../common/errors/UpstreamError.js";
+// ...
+export default class CoolPlayerSource extends MemorySource {
+
+  // ...
+
+  protected async doCheckConnection(): Promise<true | string | undefined> {
+    try {
+      const resp = await request.get(`${this.baseUrl}/health`);
+      return true;
+      // if /health returned version info we could instead read response and return a string with version info for visibility to the user
+      // return `Cool Player Version: ${resp.body.version}`;
+    } catch (e) {
+      throw e;
+    }
+  }
+}
+```
+
+#### Test Auth
+
+Finally, we will implement [Auth Test Stage](dev-common.md#stage-test-auth):
+
+```ts title="src/backend/sources/CoolPlayerSource.ts"
+import request from 'superagent';
+import { UpstreamError } from "../common/errors/UpstreamError.js";
+// ...
+export default class CoolPlayerSource extends MemorySource {
+
+  // ...
+
+  doAuthentication = async () => {
+    try {
+      const resp = await request
+              .get(`${this.baseUrl}/recent`)
+              .set('Authorization', `Token ${this.config.token}`);
+      return true;
+    } catch (e) {
+      // if Cool Player returned an error as json we could parse it from error body and throw new Error with the message
+      throw e;
+    }
+  }
+}
+```
+
+### Implement Polling
+
+The majority of Sources MS monitors primarily operate as a source of truth for a **music player** rather than a **played music history.** Only Listenbrainz and Last.fm operate as a source of music history.
+
+To this end, MS implements a [state machine](https://www.freecodecamp.org/news/state-machines-basics-of-computer-science-d42855debc66/) that emulates the behavior of a music player in order to keep track of when a song you are listening to should be scrobbled. It does this by monitoring the "currently playing" track reported by a Source's service, with varying degrees of accuracy depending on what information is returned from the service. The state machine is implemented in `MemorySource` which our `CoolPlayerSource` inherits from.
+
+For a polling Source to work properly we need to implement a function, [`getRecentlyPlayed`](https://github.com/FoxxMD/multi-scrobbler/blob/master/src/backend/sources/AbstractSource.ts#L92), that returns PlayObjects that are "newly" played. These are then checked against previously "discovered" plays and their timestamp to determine if they should be surfaced to Clients to scrobble.
+
+To take advantage of the `MemorySource` state machine we will additionally use [`processRecentPlays`](https://github.com/FoxxMD/multi-scrobbler/blob/master/src/backend/sources/MemorySource.ts#L113) from `MemorySource` inside `getRecentlyPlayed`. We pass track and/or player state returned from the Source service to `processRecentPlayers`. It then takes care of deriving Source player state based on how this data changes over time. The advantage to using `processRecentPlays` is that our Source service does not necessarily need to pass any player information -- as long as the track info has a **duration** we can more-or-less determine if it has been played long enough to scrobble.
+
+```ts title="src/backend/sources/CoolPlayerSource.ts"
+import request from 'superagent';
+import {
+  SourceData,
+  PlayerStateData,
+  SINGLE_USER_PLATFORM_ID
+} from "../common/infrastructure/Atomic.js";
+// ...
+export default class CoolPlayerSource extends MemorySource {
+
+  // ...
+
+  protected async getRecentlyPlayed(options: RecentlyPlayedOptions = {}): Promise<PlayObject[]> {
+    const plays: SourceData[] = [];
+    try {
+      // currently playing tracks/player state data
+      const resp = await request
+              .get(`${this.baseUrl}/now-playing`)
+              .set('Authorization', `Token ${this.config.token}`);
+      const {
+        body: {
+          playerState, // 'playing' or 'stopped' or 'paused'...
+          position, // number of seconds into the track IE at position 48 -> ( 0:48/3:56 in player UI )
+          play: { /* track data */}
+        }
+      } = resp;
+
+      // transform into standard player state data
+      const playerData: PlayerStateData = {
+        platformId: SINGLE_USER_PLATFORM_ID,
+        play: CoolPlayerSource.formatPlayObj(play),
+        position
+      };
+
+      // if Cool Player does return player state we can also push a regular PlayObject to this list
+      plays.push(playerData);
+    } catch (e) {
+      throw e;
+    }
+
+    // process player state through state machine
+    // if the track changes or player state changes
+    // and currently played track has been listened to long enough to be scrobbled it will return in newPlays
+    const newPlays = this.processRecentPlays(plays);
+
+    // finally, we return new plays and MS checks to see if they have been previously seen 
+    // before signalling to Clients that they can be scrobbled
+    return newPlays;
+  }
+}
+```
+
+Congratulations! Your `CoolPlayerSource` has been minimally implemented and can now be used in multi-scrobbler.
+
+## Further Implementation
+
+### Backlog
+
+To have your Source try to scrobble "missed" tracks when MS starts up the Source's service must be able to provide:
+
+* track information
+* timestamp of when the track was played
+
+In your Source implement [`getBackloggedPlays`](https://github.com/FoxxMD/multi-scrobbler/blob/master/src/backend/sources/AbstractSource.ts#L235) and set setting in constructor indicating it has backlogging capabilities:
+
+```ts title="src/backend/sources/CoolPlayerSource.ts"
+import request from 'superagent';
+import {
+  PlayObject,
+} from "../common/infrastructure/Atomic.js";
+// ...
+export default class CoolPlayerSource extends MemorySource {
+
+  constructor(/* ... */) {
+    super(/* ... */);
+    // ...
+
+    // tell MS it should try to get backlogged tracks on startup
+    this.canBacklog = true;
+  }
+
+  // ...
+
+  protected getBackloggedPlays = async (options: RecentlyPlayedOptions): Promise<PlayObject[]> => {
+    try {
+      const resp = await request
+              .get(`${this.baseUrl}/recent`)
+              .set('Authorization', `Token ${this.config.token}`);
+
+      // assuming list from body looks like track info returned in 
+      // "Implement Play Object Transform" section
+      const {
+        body = []
+      } = resp;
+
+      return body.map(x => CoolPlayerSource.formatPlayObj(x));
+    } catch (e) {
+      throw new Error('Error occurred while getting recently played', {cause: e});
+    }
+
+  }
+}
+```
+
+### Other Source Types
+
+There are some scenarios where polling and/or state machine is not the right tool to handle determining if incoming data should be scrobbled:
+
+* The Source service handles scrobble threshold internally, the data being received should always be scrobbled (WebScrobbler, Plex, Tautulli, Listenbrainz, Last.fm)
+* You prefer to handle the scrobble determination yourself
+
+#### Music History Source
+
+If the Source is still polling but the track returned should always be scrobbled if not already seen IE the Source service is a **music history source** (Listenbrainz, Last.fm), rather than a music player, then simply indicate to MS the source of truth type by setting it in the constructor. The state machine will always return a track if it is new and not seen, regardless of how recently it was seen:
+
+
+```ts title="src/backend/sources/CoolPlayerSource.ts"
+import { SOURCE_SOT } from "../../core/Atomic.js";
+// ...
+export default class CoolPlayerSource extends MemorySource {
+
+  constructor(/* ... */) {
+    super(/* ... */);
+    // ...
+
+    // tell MS it should immediately scrobble any new, unseen tracks from the upstream service
+    this.playerSourceOfTruth = SOURCE_SOT.HISTORY;
+  }
+}
+```
+
+#### Non-Polling Source
+
+**Ingress** Sources (like Plex, Tautulli, Webscrobbler, Jellyfin) do not having a polling mechanism because the upstream service contacts MS when there is an event, rather than MS contacting the upstream service.
+
+For these Sources you will need to implement endpoints in `src/service/api.ts` and corresponding files. See the existing Sources in the project as references for how to do this. 
+
+You may still wish to use the state machine `MemorySource` (like Jellyfin) if the events received are not "scrobble" events but instead of implementing `getRecentlyPlayed` you will implement your own function in your Source class, like `handle()`, that receives data and then uses `processRecentPlays`.
+
+After new plays have been determined see the next section for how to scrobble...
+
+#### Basic Source
+
+At the core of a Source that implements `AbstractSource`'s functionality is the ability to **Discover** and **Scrobble** plays. 
+
+These functions are not seen in the MVP `CoolPlayerSource` because they are automatically done by the polling functionality after being returned from `getRecentlyPlayed`.
+
+##### Discovery
+
+A Source keeps track of all the "plays" that are determined to be valid for scrobbling. When a play is valid it is checked to see if it has already been "discovered" by comparing the track info and timestamp of the play against already discovered plays. This prevents duplicate scrobbling by using the Source's own data and simplifies scrobbling for Sources by allowing your implementation to "always" ingest track data without having to worry about whether its new or not -- `AbstractSource` and `discover()` will take care of that for you.
+
+```ts title="src/backend/sources/MyBasicSource.ts"
+export default class MyBasicSource extends AbstractSource {
+  handle(somePlay: PlayObject) {
+    // if the track is "new" and not seen before it is returned in the discovered list
+    // we then know it is OK to be sent to Clients for scrobbling
+    const discovered: PlayObject[] = this.discover([somePlay]);
+  }
+}
+```
+
+This additionally will be surfaced to the user in the Dashboard in the "Tracks Discovered" page.
+
+##### Scrobbling
+
+After a play is verified to be discovered we can then scrobble it. This will emit the plays to the ScrobbleClients service which then disseminates the play to all Clients that were configured to listen in the Source's config.
+
+```ts title="src/backend/sources/MyBasicSource.ts"
+export default class MyBasicSourceSource extends AbstractSource {
+  handle(somePlay: PlayObject) {
+    const discovered: PlayObject[] = this.discover([somePlay]);
+    // emit plays that can be scrobbled by clients
+    this.scrobble(discovered);
+  }
+}
+```
+
+If your service only emits an event when a play is scrobbled you can _technically_ skip using `discover()` but it is good practice to use it unless you have a very good reason not to.
+
+:::note
+
+Using `scrobble()` does not guarantee a track is actually scrobbled! The Scrobble Clients also check the play against their own "recently scrobbled" list to prevent duplicates.
+
+:::

docsite/docs/development/flatpak.md

@@ -0,0 +1,98 @@
+---
+toc_min_heading_level: 2
+toc_max_heading_level: 5
+sidebar_position: 4
+title: Flatpak
+description: Building Flatpak App locally
+---
+
+The final build repo for the flathub version can be found at [flathub/io.github.foxxmd.multiscrobbler](https://github.com/flathub/io.github.foxxmd.multiscrobbler)
+
+## Install Requirements
+
+### Flatpak and flatpak-builder
+
+Install [Flatpak](https://flatpak.org/setup/)
+
+Install [flatpak-builder](https://docs.flatpak.org/en/latest/first-build.html#building-your-first-flatpak)
+
+#### [flatpak-node-generator](https://github.com/flatpak/flatpak-builder-tools/tree/master/node)
+
+Requires python 3.7+, [pip](https://pip.pypa.io/en/stable/)/[pipx](https://pypa.github.io/pipx/)
+
+## Update Project source
+
+Set the `branch` `tag` or `commit` to use for MS in the `source` section of [`io.github.foxxmd.multiscrobbler.yml`](https://github.com/FoxxMD/multi-scrobbler/blob/master/flatpak/io.github.foxxmd.multiscrobbler.yml)
+
+## Generate Sources and Build
+
+### Use Setup Script
+
+A convenience bash script is provided that automates generating offline sources and building the flatpak app for you. This is the recommend method to use.
+
+Located in the project at [`flatpak/setup.sh`](https://github.com/FoxxMD/multi-scrobbler/blob/master/flatpak/setup.sh), run it from the `flatpak` directory with this syntax:
+
+```shell
+./setup.sh -o -b /path/to/flatpak/build/dir
+```
+
+```
+Args:
+
+-o => Delete and overwrite any existing generated sources
+-b => The absolute path to the directory that should be used for flatpak build/artifacts. If not defined will use `CWD/build`
+-y => Proceed without confirming settings
+```
+
+### Manual Setup
+
+If you cannot use `setup.sh` follow the below to manually generate sources and build the flatpak app:
+
+<details>
+
+<summary>Instructions</summary>
+
+#### Use `flatpak-node-generator` to generate sources
+
+First, [make sure `node_modules` is deleted or empty](https://github.com/flatpak/flatpak-builder-tools/issues/354#issuecomment-1478518442) for both the project and `docsite` directories.
+
+Then, from MS project root:
+
+```shell title="PROJECT_DIR"
+flatpak-node-generator npm package-lock.json
+```
+
+Move `generated-sources.json` into `PROJECT_DIR/flatpak` and rename `generated-sources.0.json`
+
+Then, generate `docsite` sources:
+
+```shell title="PROJECT_DIR"
+flatpak-node-generator npm docsite/package-lock.json
+```
+
+Move `generated-sources.json` into `PROJECT_DIR/flatpak` and rename `generated-sources.1.json`
+
+#### Build flatpak
+
+In the below command replace `/home/yourUser/multi-scrobbler-flatpak` with a directory to use for storing flatpak build/artifacts.
+
+```shell title="PROJECT_DIR/flatpak"
+flatpak-builder --repo=/home/yourUser/multi-scrobbler-flatpak/repo --state-dir=/home/yourUser/multi-scrobbler-flatpak/state /home/yourUser/multi-scrobbler-flatpak/build io.github.foxxmd.multiscrobbler.yml --force-clean
+```
+
+:::info
+
+Append `--install --user` to the above command to have the app installed immediately.
+
+::::
+
+</details>
+
+
+# Run App
+
+If built with `--install --user` (default when using `setup.sh`) you can now run MS using the command
+
+```shell
+flatpak run -u io.github.foxxmd.multiscrobbler
+```