fix: Fix colored output being applied to file logging

Vastly simplifies log formatting on the dashboard

.dockerignore

@@ -4,10 +4,21 @@ npm-debug.log
 Dockerfile
 .dockerignore
 .gitignore
+.github
 .git
-config/currentCreds.json
 *.log
-config/maloja.json
-config/spotify.json
-config/config.json
+.idea
+config/*.json
+config/*.bak
+config/*.p8
 /docs
+/logs
+.flatpak-builder
+flatpak/generated-sources.json
+flatpak/.flatpak-builder
+docsite/build
+docsite/node_modules
+docsite/.docusaurus
+docsite/.cache-loader
+build
+*.secrets

.github/ISSUE_TEMPLATE/bug_report.md

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

@@ -0,0 +1,20 @@
+## Checklist before requesting a review
+
+- [ ] **I am opening this PR for the [`develop` branch](https://github.com/FoxxMD/multi-scrobbler/tree/develop) and NOT `master`.**
+- [ ] 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/docsDeploy.yml

@@ -0,0 +1,42 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+    # 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 dependencies
+        run: npm ci
+        working-directory: ./docsite
+      - name: Build website
+        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/publishImage.yml

@@ -0,0 +1,102 @@
+name: Publish Docker image to Dockerhub
+
+on:
+  push:
+    branches:
+      - 'master'
+      - 'develop'
+    tags:
+      - '*.*.*'
+    # don't trigger if just updating docs
+    paths-ignore:
+      - '**.md'
+
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+          cache: 'npm'
+      - name: Install dev dependencies
+        run: npm ci
+      - name: Build Backend
+        run: 'npm run build:backend'
+      - name: Test Backend
+        run: npm run test
+
+  push_to_registry:
+    name: Build and push container images
+    runs-on: ubuntu-latest
+    needs: test
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - dockerfile: ./Dockerfile
+            suffix: ''
+            platforms: 'linux/amd64,linux/arm64'
+          - dockerfile: ./debian.Dockerfile
+            suffix: '-debian'
+            # can't build arm64 due to a TLS issue when running npm install??
+            # https://github.com/FoxxMD/multi-scrobbler/issues/126
+            platforms: 'linux/amd64,linux/arm64'
+    # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#permissions-for-the-github_token
+    permissions:
+      packages: write
+      contents: read
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v4
+
+      - name: Log in to Docker Hub
+        if: github.event_name != 'pull_request'
+        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'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: |
+            foxxmd/multi-scrobbler
+            ghcr.io/foxxmd/multi-scrobbler
+          # 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=raw,value=latest,enable={{is_default_branch}},suffix=${{ matrix.suffix }}
+            type=ref,event=branch,enable=${{ !endsWith(github.ref, 'master') }},suffix=${{ matrix.suffix }}
+            type=semver,pattern={{version}},suffix=${{ matrix.suffix }}
+          flavor: |
+            latest=false
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          file: ${{ matrix.dockerfile }}
+          push: ${{ github.event_name != 'pull_request' && !env.ACT}}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          platforms: ${{ matrix.platforms }}

.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: Publish Docker image to Dockerhub
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  test:
+    name: Run Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v4
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: '18.x'
+          cache: 'npm'
+      - name: Install dev dependencies
+        run: npm ci
+      - name: Build Backend
+        run: 'npm run build:backend'
+      - name: Test Backend
+        run: npm run test

.gitignore

@@ -1,7 +1,7 @@
 # Created by .ignore support plugin (hsz.mobi)
 ### Node template
 # Logs
-logs
+/logs
 *.log
 npm-debug.log*
 yarn-debug.log*
@@ -117,6 +117,18 @@ dist
 .yarn/install-state.gz
 .pnp.*
 
-*.json
+config/*.json
 *.txt
 .idea/
+
+src/**/**.js
+src/**/**.js.map
+
+*.bak
+*.p8
+.flatpak-builder
+flatpak/generated-sources.json
+*.secrets
+
+build
+!setupProxy.js

.mocharc.json

@@ -0,0 +1,5 @@
+{
+  "reporter": "dot",
+  "extension": "ts",
+  "import": "tsx/esm"
+}

.nvmrc

@@ -1 +1 @@
-"lts/fermium"
+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"
+}

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Creating a Pull Request
+
+Please follow these guidelines when contributing code to this repository:
+
+* The PR **must be for the [`develop` branch.](https://github.com/FoxxMD/multi-scrobbler/tree/develop)** The `master` branch is for releases only.
+* 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 `develop`.
+* Ensure that if your code is covered by [an existing test](./src/backend/tests) that you have updated the test accordingly

Dockerfile

@@ -1,35 +1,79 @@
-FROM node:fermium-alpine3.10
+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
 
-RUN mkdir -p /home/node/app/node_modules && chown -R node:node /home/node
+ARG data_dir=/config
+VOLUME $data_dir
+ENV CONFIG_DIR=$data_dir
 
-WORKDIR /home/node/app
+COPY docker/root/ /
 
-COPY package*.json ./
+WORKDIR /app
 
-USER node
+FROM base as build
 
-RUN npm install --production
+# would very much like to use YARN for dependency management but its got show-stopping bad design for prod dependencies
+# https://github.com/yarnpkg/yarn/issues/6323 -- always downloads devDependencies -- and im not about to migrate to v2 since alpine doesn't support it yet
 
-COPY --chown=node:node . .
+# copy dep/TS config and install dev dependencies
+#COPY --chown=abc:abc package.json tsconfig.json yarn.lock ./
+COPY --chown=abc:abc package*.json tsconfig.json ./
+COPY --chown=abc:abc patches ./patches
 
-ENV NPM_CONFIG_LOGLEVEL debug
+RUN npm ci \
+    && chown -R root:root node_modules
+#RUN yarn install
 
-ARG config_dir=/home/node/config
-RUN mkdir -p $config_dir
-VOLUME $config_dir
-ENV CONFIG_DIR=$config_dir
+COPY --chown=abc:abc . /app
 
-ARG log_dir=/home/node/logs
-RUN mkdir -p $log_dir
-VOLUME $log_dir
-ENV LOG_DIR=$log_dir
+# need to set before build so server/client build is optimized and has constants (if needed)
+ENV NODE_ENV=production
+
+RUN npm run build && rm -rf node_modules
+#RUN yarn run build && rm -rf 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=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
+#
+#RUN yarn global add patch-package \
+#    && yarn install --production=true \
+#    && yarn global remove patch-package \
+#    && yarn cache clean --mirror \
+#    && chown abc:abc node_modules \
+#    && rm -rf node_modules/ts-node \
+#    && rm -rf node_modules/typescript
+
+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
-
-CMD [ "node", "index.js" ]

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 FoxxMD
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -2,139 +2,98 @@
 
 [![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/repository/docker/foxxmd/multi-scrobbler)
+[![Docker Pulls](https://img.shields.io/docker/pulls/foxxmd/multi-scrobbler)](https://hub.docker.com/r/foxxmd/multi-scrobbler)
 
-A single-user, javascript app to scrobble your recent plays to [Maloja](https://github.com/krateng/maloja) (and other clients, eventually)
+<img src="/assets/icon.png" align="right"
+alt="multi-scrobbler logo" width="180" height="180">
 
-* Displays running status and buffered log through web server
-* Spotify - Authorize your app through the web server
-* Spotify - Persists obtained credentials to file
-* Spotify - Automatically refreshes authorization for unattended use
-* Spotify - Implements back off behavior if no listening activity is detected after an interval (after 10 minutes of idle it will back off to a maximum of 5 minutes between checks)
-* [Tautulli](https://tautulli.com) - Scrobble endpoint using notification agents
-* [Plex](https://plex.tv) - Scrobble endpoint using [Webhooks](https://support.plex.tv/articles/115002267687-webhooks)
+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](/docsite/docs/configuration/configuration.md#spotify)
+  * [Plex](/docsite/docs/configuration/configuration.md#plex) or [Tautulli](/docsite/docs/configuration/configuration.md#tautulli)
+  * [Subsonic-compatible APIs](/docsite/docs/configuration/configuration.md#subsonic) (like [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/))
+  * [Jellyfin](/docsite/docs/configuration/configuration.md#jellyfin)
+  * [WebScrobbler](/docsite/docs/configuration/configuration.md#webscrobbler)
+  * [Youtube Music](/docsite/docs/configuration/configuration.md#youtube-music)
+  * [Last.fm](/docsite/docs/configuration/configuration.md#lastfm-source)
+  * [ListenBrainz](/docsite/docs/configuration/configuration.md#listenbrainz--source-)
+  * [Deezer](/docsite/docs/configuration/configuration.md#deezer)
+  * [MPRIS (Linux Desktop)](/docsite/docs/configuration/configuration.md#mpris)
+  * [Mopidy](/docsite/docs/configuration/configuration.md#mopidy)
+  * [JRiver](/docsite/docs/configuration/configuration.md#jriver)
+  * [Kodi](/docsite/docs/configuration/configuration.md#kodi)
+  * [Google Cast (Chromecast)](/docsite/docs/configuration/configuration.md#google-cast--chromecast-)
+* Supports scrobbling to many **Clients**
+  * [Maloja](/docsite/docs/configuration/configuration.md#maloja)
+  * [Last.fm](/docsite/docs/configuration/configuration.md#lastfm)
+  * [ListenBrainz](/docsite/docs/configuration/configuration.md#listenbrainz)
+* Monitor status of Sources and Clients using [webhooks (Gotify or Ntfy)](/docsite/docs/configuration/configuration.md#webhook-configurations) or [healthcheck endpoint](/docsite/docs/configuration/configuration.md#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
+* Install using [Docker images for x86/ARM](/docsite/docs/installation/installation.md#docker), [flatpak](/docsite/docs/installation/installation.md#flatpak), or [locally with NodeJS](/docsite/docs/installation/installation.md#nodejs)
+
+**Why should I use this over a browser extension and/or mobile app scrobbler?**
+
+* **Platform independent** -- Because multi-scrobbler communicates directly with service APIs it will scrobble everything you play regardless of where you play it. No more need for apps on every platform you use!
+* **Open-source** -- Get peace of mind knowing exactly how your personal data is being handled.
+* **Track your activity regardless of where you listen** -- Scrobble from many Sources to one Client with ease and without duplicating tracks.
+* **Manage scrobbling for others** -- Scrobble for your friends and family without any setup on their part. Easily silo sources to specific clients to keep plays separate.
+
+**But I already scrobble my music to Last.fm/ListenBrainz, is multi-scrobbler for me?**
+
+Yes! You can use [Last.fm as a **Source**](/docsite/docs/configuration/configuration.md#lastfm--source-) or [Listenbrainz as a **Source**](/docsite/docs/configuration/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.png" width="800">
+
+## How Does multi-scrobbler (MS) Work?
+
+You set up configurations for one or more **Sources** and one or more **Clients**. MS monitors all of your configured **Sources**. When new tracks are played by a Source it grabs that information and then sends it (scrobbles it) to all **Clients** that Source is configured to scrobble to.
+
+### Source
+
+A **Source** is a data source that contains information about tracks you are playing like a music player or platform. Examples are **Spotify, Jellyfin, Plex, Youtube Music, Airsonic**, etc...
+
+Source configurations consist of:
+
+* A friendly name.
+* Any data needed to communicate or authenticate with the Source.
+* An optional list of Client names that the Source should scrobble to. If omitted the Source also scrobbles to all configured Clients.
+
+### Client
+
+A **Client** is an application that stores the historical information about what songs you have played (scrobbles). Examples are **Maloja, Last.fm, Listenbrainz**...
+
+Client configurations consist of:
+
+* A friendly name.
+* Any data needed to communicate or authenticate with the Client.
 
 ## Installation
 
+[See the **Installation** documentation](/docsite/docs/installation/installation.md)
 
-### Locally
+## Configuration
 
-Clone this repository somewhere and then install from the working directory
-
-```bash
-npm install
-```
-
-### [Dockerhub](https://hub.docker.com/repository/docker/foxxmd/multi-scrobbler)
-
-```
-foxxmd/multi-scrobbler:latest
-```
-
-## Setup
-
-All configuration is done through json files or environment variables. Reference the [examples in the config folder](config) more detailed explanations and structure.
-
-**A property from a json config will override the corresponding environmental variable.**
-
-### App (General)
-
-[JSON config example](config/config.json.example)
-
-These environmental variables do not have a config file equivalent (to make Docker configuration easier)
-
-| Environmental Variable | Required? |   Default    |                                        Description                                        |
-|----------------------------|-----------|--------------|-------------------------------------------------------------------------------------------|
-| `CONFIG_DIR`               |         - | `CWD/config` | Directory to look for all other configuration files                                       |
-| `LOG_PATH`                 |         - | `CWD/logs`   | If `false` no logs will be written. If `string` will be the directory logs are written to |
-| `PORT`                     |         - | 9078         | Port to run web server on                                                                 |
-
-**The app must have permission to write to `CONFIG_DIR` in order to store the current spotify access token.**
-
-
-### Sources (Where Music Plays Come From)
-
-#### Spotify
-
-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.
-
-[Spotify config example](config/spotify.json.example)
-
-All variables have a config file equivalent which will overwrite the ENV variable if present (so config file is not required if ENVs present)
-
-| Environmental Variable     | Required? |            Default             |                    Description                     |
-|----------------------------|-----------|----------------------------------|----------------------------------------------------|
-| `SPOTIFY_CLIENT_ID`        | Yes       |                                  |                                                    |
-| `SPOTIFY_CLIENT_SECRET`    | Yes       |                                  |                                                    |
-| `SPOTIFY_ACCESS_TOKEN`     | -         |                                  | Must include either this token or client id/secret |
-| `SPOTIFY_REFRESH_TOKEN`    | -         |                                  |                                                    |
-| `SPOTIFY_REDIRECT_URI`     | -         | `http://localhost:{PORT}/callback` | URI must end in `callback`                         |
-
-The app will automatically obtain new access/refresh token if needed and possible. These will override values from configuration.
-
-#### [Plex](https://plex.tv)
-
-Check the [instructions](docs/plex.md) on how to setup a [webhooks](https://support.plex.tv/articles/115002267687-webhooks) to scrobble your plays.
-
-[Plex config example](config/plex.json.example)
-
-| Environmental Variable | Required | Default |                   Description                   |
-|------------------------|----------|---------|-------------------------------------------------|
-| PLEX_USER              |        - |         | The username of the user to scrobble tracks for. No user specified means all tracks by all users will be scrobbled. |
-
-#### [Tautulli](https://tautulli.com)
-
-Check the [instructions](docs/plex.md) on how to setup a notification agent to scrobble your plays.
-
-**Environmental variables and config file is the same as Plex**
-
-### Scrobble Clients
-
-At least one client (the only one right now...) must be setup in order for the app to work. Client configurations can alternatively be configured in the main [`config.json`](https://github.com/FoxxMD/multi-scrobbler/blob/master/config/config.json.example) configuration
-
-#### Maloja
-
-[Maloja config example](config/maloja.json.example)
-
-All variables have a config file equivalent which will overwrite the ENV variable if present (so config file is not required if ENVs present)
-
-| Environmental Variable | Required? | Default |          Description          |
-|----------------------------|-----------|---------|-------------------------------|
-| `MALOJA_URL`               | Yes       |         | Base URL of your installation |
-| `MALOJA_API_KEY`           | Yes       |         | Api Key                       |
+[See the **Configuration** documentation](/docsite/docs/configuration/configuration.md)
 
 ## Usage
 
-A status page with statistics and recent logs can found at
+A status page with statistics, recent logs, and some runtime configuration options can be found at
 
 ```
-https://localhost:9078
+http://localhost:9078
 ```
 Output is also provided to stdout/stderr as well as file if specified in configuration.
 
-On first startup you may need to authorize Spotify by visiting the callback URL (which can also be accessed from the status page)
+On first startup you may need to authorize Spotify and/or Last.fm by visiting the callback URL (which can also be accessed from the status page). Visit the status page above to find the applicable link to trigger this.
 
-```
-https://localhost:9078/authSpotify
-```
+## Help/FAQ
 
-### Running Directly
-
-```
-node index.js
-```
-
-### Docker
-
-| Environmental Variable |  Type  |         Default         |
-|------------------------|--------|-------------------------|
-| `CONFIG_DIR`           | Volume | `/home/node/app/config` |
-| `LOG_DIR`              | Volume | `/home/node/app/logs`   |
-| `PORT`                 | Port   | 9078                    |
-
-## Examples
-
-[See minimal configuration in the examples doc](docs/examples.md)
+Having issues with connections or configuration? Check the [FAQ](/docsite/docs/FAQ.md) before creating an issue!
 
 ## License
 

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>

clients/AbstractScrobbleClient.js

@@ -1,38 +0,0 @@
-import dayjs from "dayjs";
-import {createLabelledLogger} from "../utils.js";
-
-export default class AbstractScrobbleClient {
-
-    recentScrobbles = [];
-    newestScrobbleTime;
-    oldestScrobbleTime = dayjs();
-
-    lastScrobbleCheck = dayjs();
-    refreshEnabled;
-    checkExistingScrobbles;
-
-    config;
-    logger;
-
-    constructor(config = {}, options = {}) {
-        this.logger = createLabelledLogger('default', 'App');
-        this.config = config;
-        const {
-            refreshEnabled = true,
-            checkExistingScrobbles = true,
-        } = options;
-        this.refreshEnabled = refreshEnabled;
-        this.checkExistingScrobbles = checkExistingScrobbles;
-    }
-
-    scrobblesLastCheckedAt = () => {
-        return this.lastScrobbleCheck;
-    }
-
-    // time frame is valid as long as the play date for the source track is newer than the oldest play time from the scrobble client
-    // ...this is assuming the scrobble client is returning "most recent" scrobbles
-    timeFrameIsValid = (playDate) => {
-        const oldest = this.oldestScrobbleTime ?? dayjs();
-        return playDate.isAfter(oldest);
-    }
-}

clients/MalojaScrobbler.js

@@ -1,144 +0,0 @@
-import AbstractScrobbleClient from "./AbstractScrobbleClient.js";
-import request from 'superagent';
-import dayjs from 'dayjs';
-import {buildTrackString, createLabelledLogger, sortByPlayDate} from "../utils.js";
-
-export default class MalojaScrobbler extends AbstractScrobbleClient {
-
-    constructor(config = {}, options = {}) {
-        super(config, options);
-        this.logger = createLabelledLogger('maloja', 'Maloja');
-    }
-
-    static formatPlayObj(obj) {
-        const {
-            artists,
-            title,
-            time,
-        } = obj;
-        let artistString = artists.reduce((acc, curr) => acc.concat(curr.name), []).join(',');
-        return {
-            data: {
-                artist: artistString,
-                track: title,
-                playDate: dayjs.unix(time),
-            },
-            meta: {
-                source: 'Maloja',
-            }
-        }
-    }
-
-    refreshScrobbles = async () => {
-        if (this.refreshEnabled) {
-            const {url} = this.config;
-            const resp = await request.get(`${url}/apis/mlj_1/scrobbles?max=20`);
-            this.recentScrobbles = resp.body.list.map(x => MalojaScrobbler.formatPlayObj(x)).sort(sortByPlayDate);
-            const [{data: {playDate: newestScrobbleTime = dayjs()}} = {}] = this.recentScrobbles.slice(-1);
-            const [{data: {playDate: oldestScrobbleTime = dayjs()}} = {}] = this.recentScrobbles.slice(0, 1);
-            this.newestScrobbleTime = newestScrobbleTime;
-            this.oldestScrobbleTime = oldestScrobbleTime;
-        }
-        this.lastScrobbleCheck = dayjs();
-    }
-
-    alreadyScrobbled = (playObj) => {
-        return this.existingScrobble(playObj) !== undefined;
-    }
-
-    existingScrobble = (playObj) => {
-        if (false === this.checkExistingScrobbles) {
-            return false;
-        }
-
-        const {
-            data: {
-                track,
-                playDate
-            } = {},
-            meta: {
-                trackLength,
-            } = {},
-        } = playObj;
-
-        const lowerTitle = track.toLocaleLowerCase();
-        const largeDiffs = [];
-        // TODO add a runtime config option for verbose debugging for commented log statements
-        const existingScrobble = this.recentScrobbles.find((x) => {
-            const {data: {playDate: scrobbleTime, track: scrobbleTitle} = {}} = x;
-            const lowerScrobbleTitle = scrobbleTitle.toLocaleLowerCase();
-            if (lowerTitle.includes(lowerScrobbleTitle) || lowerScrobbleTitle.includes(lowerTitle)) {
-                let scrobblePlayStartDiff;
-
-                // check if scrobble time is same as play date (when the track finished playing AKA entered recent tracks)
-                let scrobblePlayDiff = Math.abs(playDate.unix() - scrobbleTime.unix());
-                if (scrobblePlayDiff < 10) {
-                    //this.logger.debug(`Scrobble with same name (${scrobbleTitle}) found and the play (finish time) vs. scrobble time diff was smaller than 10 seconds`);
-                    return true;
-                }
-                // also need to check that scrobble time isn't the BEGINNING of the track -- if the source supports durations
-                if (trackLength !== undefined) {
-                    scrobblePlayStartDiff = Math.abs(playDate.unix() - (scrobbleTime.unix() - trackLength));
-                    if (scrobblePlayStartDiff < 10) {
-                        //this.logger.debug(`Scrobble with same name (${scrobbleTitle}) found and the play (start time) vs. scrobble time diff was smaller than 10 seconds`);
-                        return true;
-                    }
-                }
-                largeDiffs.push({
-                    endTimeDiff: scrobblePlayDiff,
-                    startTimeDiff: scrobblePlayStartDiff,
-                    playDate: scrobbleTime,
-                    title: scrobbleTitle,
-                });
-                return false;
-            }
-            return false;
-        });
-        if (existingScrobble && largeDiffs.length > 0) {
-            this.logger.debug('Scrobbles with same name detected but play diff and scrobble diffs were too large to consider dups.');
-            for (const diff of largeDiffs) {
-                this.logger.debug(`Scrobble: ${diff.title} | Played At ${playDate.local().format()} | End Diff ${diff.endTimeDiff.toFixed(0)}s | Start Diff ${diff.startTimeDiff === undefined ? 'N/A' : `${diff.startTimeDiff.toFixed(0)}s`}`);
-            }
-        }
-        return existingScrobble;
-    }
-
-    scrobble = async (playObj) => {
-        const {url, apiKey} = this.config;
-
-        const {
-            data: {
-                artist,
-                album,
-                track,
-                playDate
-            } = {},
-            meta: {
-                source,
-                newFromSource = false,
-            } = {}
-        } = playObj;
-
-        try {
-            await request.post(`${url}/apis/mlj_1/newscrobble`)
-                .type('json')
-                .send({
-                    artist,
-                    title: track,
-                    album,
-                    key: apiKey,
-                    time: playDate.unix(),
-                });
-            if (newFromSource) {
-                this.logger.info(`Scrobbled Newly Found Track (${source}): ${buildTrackString(playObj)}`);
-            } else {
-                this.logger.info(`Scrobbled Backlogged Track (${source}): ${buildTrackString(playObj)}`);
-            }
-        } catch (e) {
-            this.logger.error('Error while scrobbling', {label: this.name, playInfo: buildTrackString(playObj)});
-            this.logger.log(e);
-        }
-
-        return true;
-    }
-}

clients/ScrobbleClients.js

@@ -1,84 +0,0 @@
-import dayjs from "dayjs";
-import {createLabelledLogger, readJson} from "../utils.js";
-import MalojaScrobbler from "./MalojaScrobbler.js";
-
-export default class ScrobbleClients {
-
-    clients;
-    logger;
-
-    constructor(clients = []) {
-        this.logger = createLabelledLogger();
-        this.clients = clients;
-    }
-
-    buildClients = async (clientConfigs = [], configDir = undefined) => {
-        const clients = [];
-        if (!clientConfigs.every(x => typeof x === 'object')) {
-            throw new Error('All client from config json must be objects');
-        }
-        for (const clientType of ['maloja']) {
-
-            let clientConfig = {};
-
-            switch (clientType) {
-                case 'maloja':
-                    clientConfig = clientConfigs.find(x => x.type === 'maloja') || {
-                        url: process.env.MALOJA_URL,
-                        apiKey: process.env.MALOJA_API_KEY
-                    };
-
-                    if (Object.values(clientConfig).every(x => x === undefined)) {
-                        try {
-                            clientConfig = await readJson(`${configDir}/maloja.json`);
-                        } catch (e) {
-                            // no config exists, skip this client
-                            continue;
-                        }
-                    }
-
-                    const {
-                        url,
-                        apiKey
-                    } = clientConfig;
-
-                    if (url === undefined) {
-                        this.logger.warn('Maloja url not found in config');
-                        continue;
-                    }
-                    if (apiKey === undefined) {
-                        this.logger.warn('Maloja api key not found in config');
-                        continue;
-                    }
-                    clients.push(new MalojaScrobbler(clientConfig));
-                    break;
-                default:
-                    break;
-            }
-        }
-        this.clients = clients;
-    }
-
-    scrobble = async (data, options = {}) => {
-        const playObjs = Array.isArray(data) ? data : [data];
-        const {
-            forceRefresh = false,
-            checkTime = dayjs(),
-        } = options;
-
-        const tracksScrobbled = [];
-
-        for (const client of this.clients) {
-            if (forceRefresh || client.scrobblesLastCheckedAt().unix() < checkTime.unix()) {
-                await client.refreshScrobbles();
-            }
-            for(const playObj of playObjs) {
-                if (client.timeFrameIsValid(playObj.data.playDate) && !client.alreadyScrobbled(playObj)) {
-                    tracksScrobbled.push(playObj);
-                    await client.scrobble(playObj);
-                }
-            }
-        }
-        return tracksScrobbled;
-    }
-}

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"

codeshift/transform.ts

@@ -0,0 +1,217 @@
+import {API, Collection, FileInfo, Options} from 'jscodeshift';
+import path from 'path';
+import fs from 'fs';
+
+export type TransformFrom = 'none' | 'any' | string;
+export type TransformTo = 'none' | 'any' | string;
+export type ImportTypes = 'any' | 'relative' | 'alias';
+
+const base = process.cwd();
+export default function transformer(
+  file: FileInfo,
+  { jscodeshift: j }: API,
+  options: Options,
+) {
+
+  const tf = options.transformFrom as string | undefined;
+  if(tf === undefined) {
+    throw new Error(`arg '--transformFrom' must be defined.`);
+  }
+  const transformFrom = tf.split(',').map(x => x.toLocaleLowerCase()) as TransformFrom[];
+  const tfIsAny = transformFrom.includes('any');
+
+  const tt = options.transformTo as string | undefined;
+  if(tt === undefined) {
+    throw new Error(`arg '--transformTo' must be defined.`);
+  }
+  const transformTo = tt.split(',').map(x => x.toLocaleLowerCase()) as TransformTo[];
+
+  if(transformTo.length > 1 && transformFrom.length !== transformTo.length) {
+    throw new Error('When more than one Transform To is specified then number of Transform From arguments must match');
+  }
+
+  const itypes = options.importTypes as string | undefined;
+  if(itypes === undefined) {
+    throw new Error(`arg '--importTypes' must be defined.`);
+  }
+  const importTypes = itypes.split(',').map(x => x.toLocaleLowerCase()) as ImportTypes[];
+  const importsIsAny = importTypes.includes('any');
+
+  const fileDir = path.dirname(path.join(base, file.path));
+  const processingFilePath = file.path;
+  console.log(`Processing => ${processingFilePath}`);
+  let source: Collection<any>;
+  try {
+    source = j(file.source);
+  } catch (e) {
+    console.error(`Failed to parse ${processingFilePath}, will skip`);
+    console.error(e);
+  }
+
+  const imports = source.find(j.ImportDeclaration)
+  imports.forEach((x) => {
+    const importPath = x.value.source.value as string;
+    const importPathPrefix = `${importPath.padEnd(60, ' ')} =>`;
+    
+    const pathInfo = path.parse(importPath);
+    const hasNoExt = pathInfo.ext === '';
+    let filenameFromDir: string;
+    if(tfIsAny || (hasNoExt && transformFrom.includes('none')) || (transformFrom.includes(pathInfo.ext.replace('.', '').toLocaleLowerCase()))) {
+      const pathFull = path.join(fileDir, importPath);
+      const dir = path.dirname(pathFull);
+      const normalExt = pathInfo.ext.replace('.', '');
+      let isRelative: boolean | undefined;
+      let dirExists: boolean | undefined;
+      let fileExists: boolean | undefined;
+      try {
+        // is dir path real?
+        fs.realpathSync(dir);
+        dirExists = true;
+      } catch (e) {
+        isRelative = false;
+        dirExists = false;
+      }
+
+      if(isRelative === undefined) {
+          // if extension is none we need to check for any file in dir with this name
+          if(hasNoExt) {
+            const dirFiles = fs.readdirSync(dir)
+            filenameFromDir = dirFiles.find(x => path.parse(x).name === pathInfo.name);
+            if(filenameFromDir === undefined) {
+              fileExists = false;
+              isRelative = false;
+            } else {
+              fileExists = true;
+              isRelative = true;
+            }
+          } else {
+            try {
+              // does a file exist?
+              fs.realpathSync(pathFull);
+              isRelative = true;
+            } catch (e) {
+              isRelative = false;
+              fileExists = false;
+            }
+          }
+      }
+
+      if(!importsIsAny) {
+        if(!isRelative && !importTypes.includes('alias')) {
+          console.log(`${importPathPrefix} Import looks like an alias ${dirExists ? '(dir exists, file does not)' : '(dir does not exist)'} but import types does specify alias`);
+          return;
+        } else if(isRelative && !importTypes.includes('relative')) {
+          console.log(`${pathFull} => Import is relative but import types does not specify relative`);
+          return;
+        }
+      }
+
+      // determine transformTo
+
+      // if there is only one TO then use it
+      let derivedTT: undefined | string = transformTo.length === 1 ? transformTo[0] : undefined;
+      if(derivedTT === undefined) {
+        // otherwise we find the TO by using the same index as the matching FROM extension type
+        const tfIndex = transformFrom.findIndex((x) => {
+          if(x === 'any') {
+            return true;
+          }
+          if(x === 'none' && hasNoExt) {
+            return true;
+          }
+          if(x === normalExt) {
+            return true;
+          }
+        });
+        if(tfIndex === -1) {
+          console.warn(`${importPathPrefix} did not match a Transform From type. Will not transform`);
+          return;
+        }
+        derivedTT = transformTo[tfIndex];
+      }
+
+      let transformPrefix = ` --> ${hasNoExt ? '(None)' : normalExt} TO ${derivedTT} <--`;
+
+      let transformedImport: string;
+
+      switch(derivedTT) {
+        case 'none':
+          if(hasNoExt) {
+            console.log(`${importPathPrefix} ${transformPrefix} => Import already has no extension, nothing to do`);
+            return;
+          }
+          transformedImport = combineDirFile(pathInfo.dir, pathInfo.name); // path.join(pathInfo.root, pathInfo.dir, pathInfo.name);
+          break;
+        case 'any':
+          if(hasNoExt && filenameFromDir) {
+            transformedImport = filenameFromDir;
+          } else {
+            const otherFilename = fs.readdirSync(dir).find(x => {
+              const pinfo = path.parse(x);
+              return pinfo.name === pathInfo.name && pinfo.ext !== pathInfo.ext;
+            });
+            if(otherFilename === undefined) {
+              console.warn(`${importPathPrefix} ${transformPrefix} => Could not find another file in directory that had same name but different extension. Will not transform.`);
+              return;
+            }
+            transformedImport = combineDirFile(pathInfo.dir, otherFilename); // path.join(pathInfo.root, dir, otherFilename);
+            transformPrefix = `${transformPrefix} (${path.parse(otherFilename).ext})`
+          }
+          break;
+        default:
+          transformedImport = combineDirFile(pathInfo.dir, `${path.parse(filenameFromDir).name}.${derivedTT}`); // path.join(pathInfo.root, dir, pathInfo.name, `.${derivedTT}`);
+          break;
+      }
+
+      console.log(`${importPathPrefix} ${transformPrefix} => Replacing with ${transformedImport}`);
+      j(x).replaceWith(
+          j.importDeclaration(
+              x.node.specifiers,
+              j.stringLiteral(transformedImport)
+          )
+      );
+
+    } else {
+      console.log(`${importPathPrefix} Import did not match transformFrom ('${tf}')`);
+      return;
+    }
+  });
+
+  /**
+   * Early exit condition
+   * -----
+   * It is often good practice to exit early and return the original source file
+   * if it does not contain code relevant to the codemod.
+   * See this page for more information:
+   * https://codeshiftcommunity.github.io/CodeshiftCommunity/docs/your-first-codemod#output
+   */
+  // if (/* Some condition here */ true) {
+  //   return file.source;
+  // }
+
+  /**
+   * Codemod logic goes here 👇
+   * -----
+   * This is where the core logic for your codemod will go,
+   * consider grouping specific actions into 'motions' and running them in sequence
+   *
+   * See this page for more information:
+   * https://codeshiftcommunity.github.io/CodeshiftCommunity/docs/authoring#motions
+   */
+  //source.findVariableDeclarators('foo').renameTo('bar');
+
+  /**
+   * Return your modified AST here 👇
+   * -----
+   * This is where your modified AST will be transformed back into a string
+   * and written back to the file.
+   */
+  return source.toSource(options.printOptions);
+}
+
+const combineDirFile = (dir: string, file: string) => {
+  if(dir === '') {
+    return file;
+  }
+  return `${dir}${path.sep}${file}`;
+}

config/README.md

@@ -0,0 +1,12 @@
+These are **example configurations** for all Source/Client types and AIO config.
+
+These can be used as-is by renaming them to `.json` and filling or replacing sample data.
+
+For docker installations these examples are copied to your configuration directory on first-time use.
+
+These are **NOT** exhaustive examples. You should consult the  **configuration** documentation and the **schema explorer links** for each source/config type to see a complete list of options and descriptions for all properties.
+
+Documentation at
+
+* [internal docs](../docsite/docs/configuration/configuration.md)
+* External Link: https://foxxmd.github.io/multi-scrobbler/docs/configuration

config/chromecast.json.example

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

config/config.json.example

@@ -1,11 +1,71 @@
 {
-  "spotify": {},        // optional, may specify config here, or in CONFIG_DIR/spotify.json, or as ENV vars
-
-  "clients": [          // may specify clients as objects, or in CONFIG_DIR/{clientType}.json, or as ENV vars
-                                                              // EX CONFIG_DIR/maloja.json
-    {
-      "type": "maloja", // client name
-      "data": {}        // config data
+  "debugMode": false,
+  "sourceDefaults": {
+    "maxPollRetries": 1,
+    "maxRequestRetries": 1,
+    "retryMultiplier": 1.5,
+    "scrobbleThresholds": {
+      "duration": 30,
+      "percent": 50
     },
+    "options": {
+      "logPayload": false,
+      "logFilterFailure": "warn",
+      "logPlayerState": false
+    }
+  },
+  "clientDefaults": {
+    "maxRequestRetries": 1,
+    "retryMultiplier": 1.5
+  },
+  "sources": [
+    {
+      "type": "spotify",
+      "enable": true,
+      "clients": ["myConfig"],
+      "name": "mySpotifySource",
+      "data": {
+        "clientId": "a89cba1569901a0671d5a9875fed4be1",
+        "clientSecret": "ec42e09d5ae0ee0f0816ca151008412a",
+        "redirectUri": "http://localhost:9078/callback"
+      }
+    }
+  ],
+  "clients": [
+    {
+      "type": "maloja",
+      "enable": true,
+      "name": "myConfig",
+      "data": {
+        "url": "http://localhost:42010",
+        "apiKey": "myMalojaKey"
+      }
+    }
+  ],
+  "webhooks": [
+    {
+      "name": "FirstGotifyServer",
+      "type": "gotify",
+      "url": "http://localhost:8070",
+      "token": "MyGotifyToken",
+      "priorities": {
+        "info": 5,
+        "warn": 7,
+        "error": 10
+      }
+    },
+    {
+      "type": "ntfy",
+      "name": "MyNtfyFriendlyNameForLogs",
+      "url": "http://localhost:9991",
+      "topic": "MyMultiScrobblerTopic",
+      "username": "Optional",
+      "password": "Optional",
+      "priorities": {
+        "info": 3,
+        "warn": 4,
+        "error": 5
+      }
+    }
   ]
 }

config/deezer.json.example

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

config/jellyfin.json.example

@@ -0,0 +1,15 @@
+[
+  {
+    "name": "MyJellyfin",
+    "enable": true,
+    "clients": [],
+    "data": {
+      "users": ["FoxxMD"],
+      "servers": ["myServer","anotherServer"]
+    },
+    "options": {
+      "logPayload": false,
+      "logFilterFailure": "warn"
+    }
+  }
+]

config/jriver.json.example

@@ -0,0 +1,11 @@
+[
+  {
+    "name": "MyJriver",
+    "enable": true,
+    "data": {
+      "url": "0.0.0.0",
+      "username": "auser",
+      "password": "apassword"
+    }
+  }
+]

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

@@ -0,0 +1,12 @@
+[
+  {
+    "name": "myLastFm",
+    "enable": true,
+    "configureAs": "client",
+    "data": {
+      "apiKey": "a89cba1569901a0671d5a9875fed4be1",
+      "secret": "ec42e09d5ae0ee0f0816ca151008412a",
+      "redirectUri": "http://localhost:9078/lastfm/callback"
+    }
+  }
+]

config/listenbrainz.json.example

@@ -0,0 +1,11 @@
+[
+  {
+    "name": "brainz",
+    "enable": true,
+    "configureAs": "client",
+    "data": {
+      "token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
+      "username": "FoxxMD"
+    }
+  }
+]

config/maloja.json.example

@@ -1,4 +1,10 @@
-{
-  "url": "https://domain.tld", // the base url of your maloja installation
-  "apiKey": "string"           // your maloja api key
-}
+[
+  {
+    "name": "myMaloja",
+    "enable": true,
+    "data": {
+      "url": "http://localhost:42010",
+      "apiKey": "myMalojaKey"
+    }
+  }
+]

config/mopidy.json.example

@@ -0,0 +1,12 @@
+[
+  {
+    "name": "MyMopidy",
+    "enable": true,
+    "data": {
+      "url": "localhost",
+      "uriBlacklist": [],
+      "uriWhitelist": [],
+      "albumBlacklist": []
+    }
+  }
+]

config/mpris.json.example

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

config/plex.json.example

@@ -1,4 +1,15 @@
-{
-  "user": "username@email.com",                           // user may be a single username
-  "user": ["username@gmail.com","anotherUser@gmail.com"]  // or it may be an array of usernames
-}
+[
+  {
+    "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,13 @@
-{
-  "clientId": "string",                             // spotify client id
-  "clientSecret": "string",                         // spotify client secret
-  "redirectUri": "http://localhost:9078/callback",  // optional, spotify redirect URI. Specify only if not the default. URI must end in "callback"
-  "interval": 60                                    // optional, how long to wait before calling spotify for new tracks
-}
+[
+  {
+    "name": "MySpotify",
+    "enable": true,
+    "clients": [],
+    "data": {
+      "clientId": "a89cba1569901a0671d5a9875fed4be1",
+      "clientSecret": "ec42e09d5ae0ee0f0816ca151008412a",
+      "redirectUri": "http://localhost:9078/callback",
+      "interval": 60
+    }
+  }
+]

config/subsonic.json.example

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

config/tautulli.json.example

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

config/webscrobbler.json.example

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

config/ytmusic.json.example

@@ -0,0 +1,11 @@
+[
+  {
+    "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"
+    }
+  }
+]

debian.Dockerfile

@@ -0,0 +1,112 @@
+#FROM ghcr.io/linuxserver/baseimage-ubuntu:jammy as base
+FROM ghcr.io/linuxserver/baseimage-debian:bookworm as base
+
+ENV TZ=Etc/GMT
+ENV NODE_VERSION 20.11.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 ****" && \
+    apt-get update && \
+    apt-get install --no-install-recommends -y \
+        #ca-certificates \
+        xz-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 && \
+#    curl -sL https://deb.nodesource.com/setup_18.x | bash - && \
+#    apt-get install --no-install-recommends -y nodejs && \
+    npm update -g npm && \
+  echo "**** cleanup ****" && \
+    # 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
+
+ARG data_dir=/config
+VOLUME $data_dir
+ENV CONFIG_DIR=$data_dir
+
+COPY docker/root /
+
+WORKDIR /app
+
+FROM base as build
+
+COPY --chown=abc:abc package*.json tsconfig.json ./
+COPY --chown=abc:abc patches ./patches
+
+# 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 FAILS when building arm64 but not amd64 (and alpine-based Dockerfile has no issues building arm64)
+# see https://github.com/FoxxMD/multi-scrobbler/issues/126
+RUN npm ci \
+    --verbose \
+#   --no-audit \
+    && chown -R root:root node_modules
+# running with --no-audit does not have any affect even though the error only logs with prefix 'npm verb audit error'
+
+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 build && rm -rf node_modules
+
+FROM base as app
+
+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=base /usr/bin /usr/bin
+COPY --from=base /usr/lib /usr/lib
+
+ENV NODE_ENV=production
+ENV IS_DOCKER=true
+
+RUN npm ci --omit=dev \
+    && npm cache clean --force \
+    && chown -R abc:abc node_modules \
+    && rm -rf node_modules/@types \
+              /root/.cache
+
+ARG webPort=9078
+ENV PORT=$webPort
+EXPOSE $PORT

docker-compose.yml

@@ -0,0 +1,26 @@
+version: '3.7'
+
+services:
+  multi-scrobbler:
+    image: foxxmd/multi-scrobbler
+    container_name: multi-scrobbler
+    environment:
+      - TZ=Etc/GMT # Specify timezone from TZ Database name found here https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
+      #- SPOTIFY_CLIENT_ID=
+      #- SPOTIFY_CLIENT_SECRET=
+      #- SPOTIFY_REDIRECT_URI=http://multi-scrobbler-host-IP:9078/callback ## Need to be whitelisted in Spotify dashboard and is used for creating the connection first time
+      #- 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:
+      - /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 and API on
+    restart: unless-stopped

docker/root/etc/s6-overlay/s6-rc.d/init-ms-config/run

@@ -0,0 +1,33 @@
+#!/usr/bin/with-contenv bash
+
+# used https://github.com/linuxserver/docker-plex as a template
+
+POPULATE_EXAMPLES=false
+
+echo "-------------------------------------"
+echo -e "Setting up multi-scrobbler config directory based on CONFIG_DIR env: ${CONFIG_DIR}\n"
+
+# make config folder if it does not exist
+if [ ! -d "${CONFIG_DIR}" ]; then
+  echo "Directory does not exist! Creating..."
+  POPULATE_EXAMPLES=true
+  mkdir -p "${CONFIG_DIR}"
+else
+  if [ "$(ls -A ${CONFIG_DIR})" ]; then
+       echo "Directory is not empty, not creating examples."
+    else
+      POPULATE_EXAMPLES=true
+    fi
+fi
+
+# add example configs
+if [ "$POPULATE_EXAMPLES" = true ]; then
+  echo "Directory is empty, adding examples..."
+  cp -r /app/config/. "${CONFIG_DIR}"/
+fi
+
+# permissions
+echo "chown'ing directory to ensure correct permissions."
+chown -R abc:abc "${CONFIG_DIR}"
+echo "Done!"
+echo -e "-------------------------------------\n"

docker/root/etc/s6-overlay/s6-rc.d/init-ms-config/type

@@ -0,0 +1 @@
+oneshot

docker/root/etc/s6-overlay/s6-rc.d/init-ms-config/up

@@ -0,0 +1 @@
+/etc/s6-overlay/s6-rc.d/init-ms-config/run

docker/root/etc/s6-overlay/s6-rc.d/svc-node/run

@@ -0,0 +1,10 @@
+#!/usr/bin/with-contenv bash
+
+# used https://github.com/linuxserver/docker-wikijs/blob/master/root/etc/s6-overlay/s6-rc.d/svc-wikijs/run as a template
+
+# 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/node_modules/.bin/tsx /app/src/backend/index.ts

docker/root/etc/s6-overlay/s6-rc.d/svc-node/type

@@ -0,0 +1 @@
+longrun

docs/examples.md

@@ -1,36 +0,0 @@
-# Minimal Configuration
-
-Examples assume you have registered a Spotify application with the default callback url of `http://localhost:9078/callback`.
-
-If you use another callback url or domain name you will need to specify at a minimum `SPOTIFY_REDIRECT_URI`.
-
-## Using Environmental Variables
-
-### Local
-```
-SPOTIFY_CLIENT_ID=yourId SPOTIFY_CLIENT_SECRET=yourSecret MALOJA_URL=http://domain.tld MALOJA_API_KEY=1234 node index.js
-```
-
-### Dockerhub
-
-Note: I do not recommend running a container without a `config` volume specified or you will need to reauthorize the app everytime the container is rebuilt.
-
-```
-docker run -e "SPOTIFY_CLIENT_ID=yourId" -e "SPOTIFY_CLIENT_SECRET=yourSecret" -e "MALOJA_URL=http://domain.tld" -e "MALOJA_API_KEY=1234" foxxmd/spotify-scrobbler
-```
-
-## Using Configuration
-
-Reference the [example json configs.](https://github.com/FoxxMD/multi-scrobbler/tree/master/config)
-
-### Local
-
-```
-node index.js
-```
-
-### Docker
-
-```
-docker run -v /path/on/host/config:/home/node/app/config foxxmd/spotify-scrobbler
-```

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/babel.config.js

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

docsite/docs/FAQ.md

@@ -0,0 +1,192 @@
+<!-- TOC -->
+* [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)
+  * [Jellyfin has warnings about missing headers](#jellyfin-has-warnings-about-missing-headers)
+  * [Spotify/Deezer/LastFM won't authenticate](#spotifydeezerlastfm-wont-authenticate)
+  * [Sporadic network problems on docker](#sporadic-network-problems-on-docker)
+* [Configuration Issues](#configuration-issues)
+  * [Config could not be parsed](#config-could-not-be-parsed)
+* [Scrobbling Issues](#scrobbling-issues)
+  * [Last.fm does not scrobble tracks with multiple artists correctly](#lastfm-does-not-scrobble-tracks-with-multiple-artists-correctly)
+  * [Jellyfin does not scrobble tracks with multiple artists correctly](#jellyfin-does-not-scrobble-tracks-with-multiple-artists-correctly)
+  * [Google Cast track information is missing/incorrect or MS player has weird times](#google-cast-track-information-is-missingincorrect-or-ms-player-has-weird-times)
+  * [Google Cast device does not track media](#google-cast-device-does-not-track-media)
+<!-- TOC -->
+
+# Connection Issues
+
+## Plex/Tautulli/Jellyfin don't connect
+
+These three [sources](/#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](configuration/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](configuration/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.
+
+## Jellyfin has warnings about missing headers
+
+If you experience issues trying to scrobble with Jellyfin and find this in your MS logs
+
+```
+[API] Jellyfin is not sending a request with valid headers...
+```
+
+A workaround that may fix this:
+
+* In Webhook settings:
+  * [In the webhook you have already configured...](configuration/configuration.md#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`
+
+## Sporadic network problems on docker
+
+If you encounter networking issues like:
+
+* sporadic timeouts (`ETIMEDOUT`) without a pattern
+* DNS errors (`EAI_AGAIN`) that do no occur consistently
+* Failures to reach a host that was previously fine (`EHOSTUNREACH`)
+
+there may be an issue with the underlying docker image OS (alpine) that may be solved by switching to a different image. Try switching to a `*-debian` variant tag (only available for ARM hosts) to see if this resolves your issue. IE `multi-scrobbler:latest-debian` or `multi-scrobbler:develop-debian`
+
+# 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 does not scrobble tracks with multiple artists correctly
+
+This is a limitation caused by the [Jellyfin webhook plugin](https://github.com/FoxxMD/multi-scrobbler/issues/70#issuecomment-1443804712) only sending the first artist to multi-scrobbler. This issues needs to be [fixed upstream on the Jellyfin webhook repository.](https://github.com/jellyfin/jellyfin-plugin-webhook/issues/166)
+
+## Google Cast track information is missing/incorrect or MS player has weird times
+
+The Google Cast integration relies on a few common fields in the data it receives from your casting device. Every platform that can cast (Spotify, Pandora, etc...) *should* use these fields the same but there are slight differences between their implementations that may confuse multi-scrobbler. Specific platforms may also return more information in non-common fields that are undocumented.
+
+To diagnose these issues you [**must enable payload logging**](configuration/configuration.md#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.md#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.md#forcing-media-tracking) section to fix this

docsite/docs/configuration/_category_.json

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

docsite/docs/configuration/configuration.md

@@ -0,0 +1,986 @@
+---
+sidebar_position: 2
+title: Overview
+---
+
+# Configuration
+
+<!-- TOC -->
+* [Overview](#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)
+* [Application Options](#application-options)
+  * [Base URL](#base-url)
+* [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](#mpris)
+  * [Mopidy](#mopidy)
+  * [JRiver](#jriver)
+  * [Kodi](#kodi)
+  * [WebScrobbler](#webscrobbler)
+      * [Multiple Users](#multiple-users)
+  * [Google Cast (Chromecast)](#google-cast--chromecast-)
+    * [Connecting Devices](#connecting-devices)
+    * [What Media Does MS Scrobble?](#what-media-does-ms-scrobble)
+    * [Cast Troubleshooting](#cast-troubleshooting)
+* [Client Configurations](#client-configurations)
+  * [Maloja](#maloja)
+  * [Last.fm](#lastfm)
+  * [Listenbrainz](#listenbrainz)
+* [Monitoring](#monitoring)
+  * [Webhook Configurations](#webhook-configurations)
+    * [Gotify](#gotify)
+    * [Ntfy](#ntfy)
+  * [Health Endpoint](#health-endpoint)
+<!-- TOC -->
+
+# Overview
+
+[**Sources** and **Clients**](/#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**](../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](/#client) and one [Source](/#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](../installation/installation.md#docker) for how to configure this correctly
+
+Use File-based configuration if:
+
+* You have many [Sources](/#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](https://github.com/FoxxMD/multi-scrobbler/tree/master/config) directory of this project. These can be used as-is by renaming them to `.json`.
+For docker installations these examples are copied to your configuration directory on first-time use.
+
+There is also a [**kitchensink example**](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%2Fmaster%2Fsrc%2Fbackend%2Fcommon%2Fschema%2Faio.json)
+
+Example directory structure:
+
+```
+/CONFIG_DIR
+  config.json
+```
+
+<details>
+<summary>Config Example</summary>
+
+```json5 title="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](https://github.com/FoxxMD/multi-scrobbler/blob/master/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](https://github.com/FoxxMD/multi-scrobbler/blob/master/config) directory of this project for examples of each type of config file or reference specific files below.
+
+# Application Options
+
+These options affect multi-scrobbler's behavior and are not specific to any source/client.
+
+#### Base URL
+
+Defines the URL that is used to generate default redirect URLs for authentication on [spotify](#spotify), [lastfm](#lastfm), and [deezer](#deezer) -- as well as some logging hints.
+
+* Default => `http://localhost`
+* Set with [ENV](#env-based-configuration) `BASE_URL` or `baseUrl` [all-in-one configuration](#all-in-one-file-configuration)
+
+EX: Lastfm Redirect Url is `BASE_URL:PORT/lastfm/callback` -- Set `BASE_URL=http://192.168.0.101` => Redirect URL is `http://192.168.0.101:9078/lastfm/callback` (when no other redirectUri is specified for [lastfm configuration](#lastfm))
+
+Useful when running with [docker](../installation/installation.md#docker) so that you do not need to specify redirect URLs for each configuration.
+
+# 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.
+
+**NOTE:** If your Spotify player has [Automix](https://community.spotify.com/t5/FAQs/What-is-Automix/ta-p/5257278) enabled and Spotify uses it for your playlist/queue then MS cannot accurately determine when a track will end. This is because the track is "mixed" in your queue with a shorter play time than its actual length and [Spotify does not report this modified play time in its API.](https://community.spotify.com/t5/Spotify-for-Developers/Wrong-duration-ms-of-track-with-Automix/m-p/5429147) This **does not affect MS's ability to scrobble** from Spotify but it will affect the accuracy of the duration MS reports was played.
+
+### 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`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%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`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%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`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%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) and supports the [`getNowPlaying`](http://www.subsonic.org/pages/api.jsp#getNowPlaying) endpoint (such as [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/))
+
+**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`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%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
+
+If you see errors in the MS logs regarding `missing headers` when using Jellyfin [see this workaround.](../FAQ.md#jellyfin-has-warnings-about-missing-headers)
+
+### 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`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%2Fcommon%2Fschema%2Fsource.json)
+
+## [Last.fm (Source)](https://www.last.fm)
+
+See the [Last.fm (Client)](#lastfm) setup for registration instructions.
+
+### ENV-Based
+
+No support for ENV based for Last.fm as a client (only source)
+
+### File-Based
+
+See [`lastfm.json.example`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%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`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%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`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%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](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`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%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](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**](../installation/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`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%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`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%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`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%2Fcommon%2Fschema%2Fsource.json)
+
+## [Kodi](https://kodi.tv/)
+
+In order for multi-scrobbler to communicate with Kodi you must have the [Web Interface](https://kodi.wiki/view/Web_interface) enabled. This can can be in the Kodi GUI:
+
+* Settings -> Services -> Control
+  * Check `Allow remote control via HTTP`
+  * Ensure you have a **Username** and **Password** set, you will need to provide them in the ENV/File configuration below.
+
+#### URL
+
+If you do not provide a URL then a default is used which assumes Kodi is installed on the same server as multi-scrobbler: `http://localhost:8080/jsonrpc`
+
+* Make sure the port number matches what is found in **Port** in the [Control](#kodi) section mentioned above.
+* 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 => `8080`
+* Path => `/jsonrpc`
+
+<details>
+<summary>URL Transform Examples</summary>
+
+```json
+{
+  "url": "kodi.mydomain.com"
+}
+```
+
+MS transforms this to: `http://kodi.mydomain.com:8080/jsonrpc`
+
+```json
+{
+  "url": "192.168.0.101:3456"
+}
+```
+
+MS transforms this to: `http://192.168.0.101:3456/jsonprc`
+
+```json
+{
+  "url": "mydomain.com:80/kodiReverse/jsonrpc"
+}
+```
+
+MS transforms this to: `http://mydomain.com:80/kodiReverse/jsonrpc`
+
+</details>
+
+### ENV-Based
+
+
+| Environmental Variable | Required | Default                       | Description                |
+|------------------------|----------|-------------------------------|----------------------------|
+| KODI_URL               | Yes      | http://localhost:8080/jsonrpc | The URL of the Kodi server |
+| KODI_USERNAME          | No       |                               | The username set           |
+| KODI_PASSWORD          | No       |                               | The password set           |
+
+
+### File-Based
+
+See [`kodi.json.example`](https://github.com/FoxxMD/multi-scrobbler/blob/master/config/kodi.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23%2Fdefinitions%2FKodiSourceConfig/%23%2Fdefinitions%2FKodiData?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fmaster%2Fsrc%2Fbackend%2Fcommon%2Fschema%2Fsource.json)
+
+## [WebScrobbler](https://web-scrobbler.com/)
+
+After installing the extension open the preferences/settings for it:
+
+* Under **Accounts**
+  * **Add Webhook**
+    * API URL: `http://localhost:9078/api/webscrobbler`
+    * Application name: `(whatever you want)`
+
+Reload the extension after adding the webhook.
+
+* **On Firefox** - Only FQNs (domain.tld), `localhost`, and `127.0.0.1` are supported for API URL due to [firefox requiring https](https://github.com/web-scrobbler/web-scrobbler/issues/4183#issuecomment-1749222006)
+* **On Chromium-based Browsers** - Any domain will work for API URL
+* All Other browsers are untested
+
+#### Multiple Users
+
+If you would like use multiple WebScrobbler sources they can be matched using a **slug** at the end of the **API URL.** This requires using [a file-based config.](#file-based-configuration)
+
+Example:
+
+In `webscrobbler.json`
+
+```json
+[
+  {
+    "name": "aUserWS",
+    "clients": [
+      "client1Maloja"
+    ],
+    "data": {
+      "slug": "usera" 
+    }
+  },
+  {
+    "name": "bUserWS",
+    "clients": [
+      "client2Maloja"
+    ],
+    "data": {
+      "slug": "userb"
+    }
+  }
+]
+```
+
+* To use `aUserWS` source set **API URL** to `http://localhost:9078/api/webscrobbler/usera`
+* To use `bUserWS` source set **API URL** to `http://localhost:9078/api/webscrobbler/userb`
+
+Note: `http://localhost:9078/api/webscrobbler` is matched with the first source that _that does not have a slug defined._
+
+##### Connectors Black/Whitelist
+
+MS can be configured to only scrobble, or NOT scrobble, from some WS connectors. Use the name of the website from the [supported websites](https://web-scrobbler.com/) or from the **Connectors** tab in the extension. Note that this **only** affects MS's behavior and does not affect the general connector behavior you have configured within the WebScrobbler extension.
+
+### ENV-Based
+
+| Environmental Variable | Required? | Default | Description                                                              |
+|------------------------|-----------|---------|--------------------------------------------------------------------------|
+| WS_ENABLE              | No        |         | Set to 'true' to enable WS without needing to define other ENVs          |
+| WS_WHITELIST           | No        |         | Only scrobble from these WebScrobbler Connectors. Comma-delimited list   |
+| WS_BLACKLIST           | No        |         | Do not scrobble from these WebScrobbler Connectors. Comma-delimited list |
+
+### File-Based
+
+See [`webscrobbler.json.example`](https://github.com/FoxxMD/multi-scrobbler/blob/master/config/webscrobbler.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23%2Fdefinitions%2FWebScrobblerSourceConfig/%23%2Fdefinitions%2FWebScrobblerData?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fmaster%2Fsrc%2Fbackend%2Fcommon%2Fschema%2Fsource.json)
+
+## [Google Cast (Chromecast)](https://www.google.com/chromecast/built-in/)
+
+**NOTE:** Google Cast support is **experimental**. You may experience crashes and errors while using this Source. Please open an issue if you experience problems and include all information detailed in the issue template to help debug your issue.
+
+If your media device can be **Cast** to using this button ![Chromecast Icon](https://upload.wikimedia.org/wikipedia/commons/2/26/Chromecast_cast_button_icon.svg) on your phone/computer then multi-scrobbler can monitor it in order to scrobble music you play.
+
+**Note:** This source relies on common, **basic** music data provided by the cast device which will always be less exhaustive than data parsed from full source integrations. If there is an existing [Source](#source-configurations) it is recommended to configure for it and blacklist the app on Google Cast, rather than relying solely on Google Cast for scrobbling.
+
+### Connecting Devices
+
+Cast devices can be manually configured using [File-based configuration](#file-based-14) OR automatically discovered using **mDNS.**
+
+##### mDNS Discovery
+
+The host machine running multi-scrobbler must be configured to allow [mDNS traffic on port 5353/UDP](https://book.hacktricks.xyz/network-services-pentesting/5353-udp-multicast-dns-mdns).
+
+##### Linux
+
+**Docker**
+
+The host machine must have [avahi-daemon](https://avahi.org/) running to circumvent limitations with DNS resolution due to musl in Alpine. Most major linux distributions package avahi and many have it built-in. Once avahi is running you must pass D-Bus and the avahi daemon socket to your container like so:
+
+```
+docker run ... -v /var/run/dbus:/var/run/dbus -v  	/var/run/avahi-daemon/socket:/var/run/avahi-daemon/socket ... foxxmd/multi-scrobbler
+```
+
+**Flatpak/Nodejs**
+
+No additional steps are required.
+
+##### Windows
+
+**Docker**
+
+Unsupported at this time.
+
+**Nodejs**
+
+No additional steps are required.
+
+### What Media Does MS Scrobble?
+
+Cast devices report what type of media the current activity is [(see `metadata` property here)](https://developers.google.com/cast/docs/media/messages#MediaInformation). The reported type is dependent on the application playing the media to correctly report it, the cast device does not magically know what the media is. If an application does not report a type it is always classified as `unknown`.
+
+**By default, MS will only track media that is reported as `MusicTrack`.**
+
+#### Allow Unknown Media Type
+
+Media with an Unknown (`Generic`) media type can be explicitly allowed by setting `"allowUnknownMedia": true` in the [file-based configuration.](#file-based-14) This can also be configured to only allow unknown media types for specific applications by using a list of application names like:
+
+```json5
+// in chromecast.json or config.json sources
+[
+  {
+    "name": "MyCast",
+    "type": "chromecast",
+    "data": {
+      // only allow unknown if app name contains any of these phrases
+      "allowUnknownMedia": ["smarttube", "default media receiver"]
+    },
+  }
+]
+```
+
+#### Forcing Media Tracking
+
+MS can be forced to track media from an application regardless of media type. This is useful if an application incorrectly reports a media type you are sure should be music. Set `"forceMediaRecognitionOn"` in the [file-based configuration.](#file-based-14) to a list of application names that should always be tracked like:
+
+```json5
+// in chromecast.json or config.json sources
+[
+  {
+    "name": "MyCast",
+    "type": "chromecast",
+    "data": {
+      // media from applications that contains these phrases will always be tracked, regardless of media type reported
+      "forceMediaRecognitionOn": ["smarttube", "default media receiver"]
+    },
+  }
+]
+```
+
+
+### Cast Troubleshooting
+
+Please include any/all logs with raw output if there are any errors encountered as this is critical to diagnosing issues.
+
+To diagnose bad/incomplete track information or strange MS player behavior please turn on **payload logging** and include log output of the source running to help diagnose this issue:
+
+```json5
+// in chromecast.json or config.json sources
+[
+  {
+    "name": "MyCast",
+    "type": "chromecast",
+    "data": {
+      //...
+    },
+    "options": {
+      "logPayload": true
+    }
+  }
+]
+```
+
+### ENV-Based
+
+Note: [Manually configuring cast device connections](#connecting-devices) is only available through [File-based config.](#file-based-14)
+
+| Environmental Variable | Required? | Default |                                     Description                                      |
+|------------------------|-----------|---------|--------------------------------------------------------------------------------------|
+| CC_ENABLE              | No        |         | Set to 'true' to enable Cast monitoring without needing to define other ENVs         |
+| CC_WHITELIST_DEVICES   | No        |         | Only scrobble from these Cast devices. Comma-delimited list. EX mini-home, family-tv |
+| CC_BLACKLIST_DEVICES   | No        |         | Do not scrobble from these Cast devices. Comma-delimited list                        |
+| CC_WHITELIST_APPS      | No        |         | Only scrobble from these casted Apps. Comma-delimited list. EX spotify, pandora      |
+| CC_BLACKLIST_APPS      | No        |         | Do not scrobble from these casted Apps. Comma-delimited list                         |
+
+### File-Based
+
+See [`chromecast.json.example`](https://github.com/FoxxMD/multi-scrobbler/blob/master/config/chromecast.json.example) or [explore the schema with an example and live editor/validator](https://json-schema.app/view/%23%2Fdefinitions%2FChromecastSourceConfig/%23%2Fdefinitions%2FChromecastData?url=https%3A%2F%2Fraw.githubusercontent.com%2FFoxxMD%2Fmulti-scrobbler%2Fmaster%2Fsrc%2Fbackend%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`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%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`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%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`](https://github.com/FoxxMD/multi-scrobbler/blob/master/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%2Fmaster%2Fsrc%2Fbackend%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:
+
+```json5
+{
+  "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%2Fmaster%2Fsrc%2Fbackend%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%2Fmaster%2Fsrc%2Fbackend%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**

docsite/docs/configuration/kitchensink.md

@@ -0,0 +1,293 @@
+---
+sidebar_position: 3
+title: Kitchen Sink
+---
+
+# Example Config using all Possible Features
+
+Scenario: 
+
+* You want to scrobble plays for yourself (Foxx), Fred, and Mary
+* Each person has their own Maloja server
+* Each person has their own Spotify account
+* You have your own Airsonic (subsonic) server you to scrobble from
+* You have your own Youtube Music account you want to scrobble from
+* Mary has her own Last.fm account she also wants to scrobble to
+* Fred has his own Spotify application and provides you with just his access and refresh token because he doesn't trust you (wtf Fred)
+* Fred has a Plex server and wants to scrobble everything he plays
+* Mary uses Fred's Plex server but only wants to scrobble her plays from the `podcast` library
+* The three of you have a shared library on Plex called `party` that you only play when you are hanging out. You want plays from that library to be scrobbled to everyone's servers.
+* Fred also has his own Jellyfin server and wants to scrobble everything he plays
+
+### All-in-one Config
+
+Using just one config file located at `CONFIG_DIR/config.json`:
+
+```json5
+{
+  "sourceDefaults": {
+    "maxPollRetries": 0,          // optional, default # of automatic polling restarts on error. can be overridden by property in individual config
+    "maxRequestRetries": 1,       // optional, default # of http request retries a source can make before error is thrown. can be overridden by property in individual config
+    "retryMultiplier": 1.5,       // optional, default retry delay multiplier (retry attempt * multiplier = # of seconds to wait before retrying). can be overridden by property in individual config
+  },
+  "clientDefaults": {
+    "maxRequestRetries": 1,       // optional, default # of http request retries a client can make before error is thrown. can be overridden by property in individual config
+    "retryMultiplier": 1.5,       // optional, default retry delay multiplier (retry attempt * multiplier = # of seconds to wait before retrying). can be overridden by property in individual config
+  },
+  "sources": [
+    {
+      "type": "spotify",
+      "name": "foxxSpot",
+      "clients": ["foxxMaloja"],
+      "data": {
+        "clientId": "foxxSpotifyAppId", 
+        "clientSecret": "foxxSpotifyAppSecret",
+        "maxRequestRetries": 2,  // override default max retries because spotify can...spotty
+      }
+    },
+    {
+      "type": "spotify",
+      "name": "marySpot",
+      "clients": ["maryMaloja"],
+      "data": {
+        "clientId": "foxxSpotifyAppId", // only need one application, it can be used by all users of this multi-scrobbler instance 
+        "clientSecret": "foxxSpotifyAppSecret",
+      }
+    },
+    {
+      "type": "spotify",
+      "name": "fredSpot",
+      "clients": ["fredMaloja"],
+      "data": {
+        "accessToken": "fredsToken",
+        "refreshToken": "fredsRefreshToken",
+        "interval": 120, // he also wants a slower check interval because his application already has heavy api usage
+      }
+    },
+    {
+      "type": "plex",
+      "name": "fredPlex",
+      "clients": ["fredMaloja"],
+      "data": {
+        "user": ["fred@email.com"]
+      }
+    },
+    {
+      "type": "plex",
+      "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"]
+      }
+    },
+    {
+      "type": "plex",
+      "name": "partyPlex",
+      // omitting clients (or making it empty) will make this Source scrobble to all Clients
+      "data": {
+        "libraries": ["party"],
+      }
+    },
+    {
+      "type": "jellyfin",
+      "name": "FredJelly",
+      // omitting clients (or making it empty) will make this Source scrobble to all Clients
+      "data": {
+        "user": ["fred@email.com"]
+      }
+    },
+    {
+      "type": "subsonic",
+      "name": "foxxAirsonic",
+      "clients": ["foxxMaloja"],
+      "data": {
+        "user": "foxx",
+        "password": "foxxPassword",
+        "url": "https://airsonic.foxx.example"
+      }
+    },
+    {
+      "type": "ytmusic",
+      "name": "foxxYoutube",
+      "clients": ["foxxMaloja"],
+      "data": {
+        "cookie": "__Secure-3PAPISID=3AxsXpy0MKGu75Qb/AkISXGqOnSDn1jEKn; DEVICE_INFO=ChxOekU0Tmpjek5EWTBPRGd3TlRBMk16QXpNdz09EJbS8Z0GGJbS8Z0G; ...",
+        "authUser": 1
+      }
+    },
+  ],
+  "clients": [
+    {
+      "type": "maloja",
+      "name": "foxxMaloja",
+      "data": {
+        "url": "https://maloja.foxx.example",
+        "apiKey": "foxxApiKey"
+      }
+    },
+    {
+      "type": "maloja",
+      "name": "fredMaloja",
+      "data": {
+        "url": "https://maloja.fred.example",
+        "apiKey": "fredApiKey"
+      }
+    },
+    {
+      "type": "maloja",
+      "name": "maryMaloja",
+      "data": {
+        "url": "https://maloja.mary.example",
+        "apiKey": "maryApiKey"
+      }
+    },
+    {
+      "type": "lastfm",
+      "name": "maryLFM",
+      "data": {
+        "apiKey": "maryApiKey",
+        "secret": "marySecret",
+        "redirectUri": "http://localhost:9078/lastfm/callback"
+      }
+    }
+  ]
+}
+
+```
+
+### Separate JSON files
+
+In `CONFIG_DIR/spotify.json`:
+
+```json5
+[
+  {
+    // may omit 'type' property since app knows this is file is for spotify configs
+    "name": "foxxSpot",
+    "clients": ["foxxMaloja"],
+    "data": {
+      "clientId": "foxxSpotifyAppId",
+      "clientSecret": "foxxSpotifyAppSecret"
+    }
+  },
+  {
+    "name": "marySpot",
+    "clients": ["maryMaloja"],
+    "data": {
+      "clientId": "foxxSpotifyAppId",
+      "clientSecret": "foxxSpotifyAppSecret"
+    }
+  },
+  {
+    "name": "fredSpot",
+    "clients": ["fredMaloja"],
+    "data": {
+      "accessToken": "fredsToken",
+      "refreshToken": "fredsRefreshToken",
+      "interval": 120
+    }
+  },
+]
+```
+
+In `CONFIG_DIR/plex.json`
+
+```json5
+[
+  {
+    "name": "fredPlex",
+    "clients": ["fredMaloja"],
+    "data": {
+      "user": ["fred@email.com"]
+    }
+  },
+  {
+    "name": "maryPlex",
+    "clients": ["maryMaloja"],
+    "data": {
+      "user": ["mary@email.com"],
+      "libraries": ["podcasts"]
+    }
+  },
+  {
+    "name": "partyPlex",
+    "data": {
+      "libraries": ["party"]
+    }
+  }
+]
+```
+
+In `CONFIG_DIR/jellyfin.json`
+
+```json5
+[
+  {
+    "name": "FredJelly",
+    "data": {
+      "user": ["fred@email.com"]
+    }
+  }
+]
+```
+
+In `CONFIG_DIR/ytmusic.json`
+
+```json5
+[
+  {
+    "type": "ytmusic",
+    "name": "foxxYoutube",
+    "clients": ["foxxMaloja"],
+    "data": {
+      "cookie": "__Secure-3PAPISID=3AxsXpy0MKGu75Qb/AkISXGqOnSDn1jEKn; DEVICE_INFO=ChxOekU0Tmpjek5EWTBPRGd3TlRBMk16QXpNdz09EJbS8Z0GGJbS8Z0G; ...",
+      "authUser": 1
+    }
+  }
+]
+```
+
+In `CONFIG_DIR/maloja.json`:
+
+```json5
+[
+  {
+    "name": "foxxMaloja",
+    "data": {
+      "url": "https://maloja.foxx.example",
+      "apiKey": "foxxApiKey"
+    }
+  },
+  {
+    "name": "fredMaloja",
+    "data": {
+      "url": "https://maloja.fred.example",
+      "apiKey": "fredApiKey"
+    }
+  },
+  {
+    "name": "maryMaloja",
+    "data": {
+      "url": "https://maloja.mary.example",
+      "apiKey": "maryApiKey"
+    }
+  }
+]
+```
+
+In `CONFIG_DIR/lastfm.json`:
+
+```json5
+[
+  {
+    "name": "maryLFM",
+    "data": {
+      "apiKey": "maryApiKey",
+      "secret": "marySecret",
+      "redirectUri": "http://localhost:9078/lastfm/callback"
+    }
+  }
+]
+```
+

docsite/docs/configuration/plex.md

@@ -1,3 +1,8 @@
+---
+sidebar_position: 2
+title: Plex/Tautulli
+---
+
 Tracks played on [Plex](https://plex.tv/) can be scrobbled either by:
  * A [Tautulli](https://tautulli.com/) notification agent with a webhook.
  * Using Plex [Webhooks](https://support.plex.tv/articles/115002267687-webhooks) (restricted to Plex Pass users)
@@ -40,8 +45,17 @@ Expand the **Watched** dropdown and add the following code block to the **JSON D
 "album_name": "{album_name}",
 "media_type": "{media_type}",
 "title":  "{title}",
-"duration": "{duration}",
-"username": "{username}"
+"duration": "{duration_sec}",
+"username": "{username}",
+"server": "{server_name}",
+"version": "{server_version}",
+"library": "{library_name}",
+"player": "{player}",
+"device": "{device}",
+"platform": "{platform}",
+"action": "{action}",
+"machine_id": "{machine_id}",
+"session_key": "{session_key}"
 }
 ```
 

docsite/docs/installation/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Installation",
+  "position": 1,
+  "link": {
+    "type": "generated-index",
+    "description": "Way to install Multi-Scrobbler"
+  }
+}

docsite/docs/installation/installation.md

@@ -0,0 +1,185 @@
+---
+sidebar_position: 1
+title: 'Overview'
+---
+
+# Installation
+
+# Local
+
+After installation see [service.md](service.md) to configure multi-scrobbler to run automatically in the background.
+
+## Nodejs
+
+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, to set correct Node version
+npm install
+npm run build
+npm run start
+```
+
+#### Rollup build error
+
+During building if you encounter an error like: `Your current platform "XXX" and architecture "XXX" combination is not yet supported by the native Rollup build.`
+
+Modify `overrides` in `package.json` to use `@rollup/wasm-node` as a drop-in replacement for rollup:
+
+```json
+"overrides": {
+  "spotify-web-api-node": {
+    "superagent": "$superagent"
+  }
+  "vite": {
+    "rollup": "npm:@rollup/wasm-node@^4.9.6"
+  }
+}
+```
+
+See [this issue](https://github.com/FoxxMD/multi-scrobbler/issues/135#issuecomment-1927080260) for more detail.
+
+### Usage Examples
+
+* The web UI and API is served on port `9078`. This can be modified using the `PORT` environmental variable.
+
+#### Using [file-based](../configuration/configuration.md#file-based-configuration) configuration
+
+```shell
+npm run start
+```
+
+#### Using [env-based](../configuration/configuration.md#env-based-configuration) configuration
+
+```shell
+SPOTIFY_CLIENT_ID=yourId SPOTIFY_CLIENT_SECRET=yourSecret MALOJA_URL="http://domain.tld" node src/index.js
+```
+
+## Flatpak
+
+You must have [Flatpak](https://flatpak.org/) installed on your system.
+
+```shell
+flatpak install flathub io.github.foxxmd.multiscrobbler
+```
+
+**Note:** Flatpak users have experienced issues when using multi-scrobbler as a long-running process. Due to the relative difficulty in debugging issues with flatpak installations it is recommended:
+
+* to use a [Docker](#docker) installation if possible or
+* only if you need access to host-level resources like dbus for [MPRIS](https://foxxmd.github.io/multi-scrobbler/docs/configuration#mpris) and cannot run a [nodejs](#nodejs) installation
+
+### Usage Examples
+
+#### Using [file-based](../configuration/configuration.md#file-based-configuration) configuration
+
+The config directory for multi-scrobbler as a flatpak can be found under `/home/YourUser/.var/app/io.github.foxxmd.multiscrobbler/config`
+
+```shell
+flatpak run io.github.foxxmd.multiscrobbler
+```
+
+#### Using [env-based](../configuration/configuration.md#env-based-configuration) configuration
+
+There are a few [options for running flatpak applications with temporary or permanent environmental variables.](https://ardasevinc.dev/launch-flatpak-apps-with-custom-args-and-environment-variables)
+
+```shell
+flatpak run --env=SPOTIFY_CLIENT_ID=yourId --envSPOTIFY_CLIENT_SECRET=yourSecret --env=MALOJA_URL="http://domain.tld" io.github.foxxmd.multiscrobbler
+```
+
+## Docker
+
+Cross-platform images are built for x86 (Intel/AMD) and ARM64 (IE Raspberry Pi)
+
+[Dockerhub](https://hub.docker.com/r/foxxmd/multi-scrobbler)
+```
+docker.io/foxxmd/multi-scrobbler:latest
+```
+
+[Github Packages](https://github.com/FoxxMD/multi-scrobbler/pkgs/container/multi-scrobbler)
+```
+ghcr.io/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:
+
+#### Storage
+
+You **must** bind a host directory into the container for storing configurations and credentials. Otherwise, these will be lost when the container is updated.
+
+* [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`
+
+#### Networking
+
+If you are using a [bridge network](https://www.appsdeveloperblog.com/docker-networking-bridging-host-and-overlay/) (default docker setup) you **must** map a port to the container in order to access the dashboard and use MS with some sources (Plex, Jellyfin).
+
+The default container port is `9078`. To map container to host port:
+
+* 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"`
+
+##### Base URL
+
+Optionally, when
+
+* using a [Source or Client](../configuration/configuration.md) that has a "Redirect URI" that you have not explicitly defined
+* and
+  * using a bridge network or
+  * installing MS on a different machine than the one used to view the dashboard
+
+set the [Base URL](../configuration/configuration.md#base-url) as the IP of the host machine. (This is the IP you would use to view the dashboard in a browser)
+
+* With docker: `-e BASE_URL="http://hostMachineIP"` (first port is the port on the host to use)
+* With docker-compose: [see comments in docker-compose.yml](../../../docker-compose.yml)
+
+#### Other
+
+* (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
+
+### Network Issues
+
+If you encounter networking issues like:
+
+* sporadic timeouts (`ETIMEDOUT`) without a pattern
+* DNS errors (`EAI_AGAIN`) that do no occur consistently
+* Failures to reach a host that was previously fine (`EHOSTUNREACH`)
+
+there may be an issue with the underlying docker image OS (alpine) that may be solved by switching to a different image. Try switching to a `*-debian` variant tag (only available for x86/x64 hosts) to see if this resolves your issue. IE `multi-scrobbler:latest-debian` or `multi-scrobbler:develop-debian`
+
+## Docker Usage Examples
+
+If installing on a different machine make sure all redirect URIs are defined or that you have set a [Base URL](#base-url).
+
+### Using [env-based](../configuration/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](../configuration/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/docs/installation/service.md

@@ -0,0 +1,73 @@
+---
+sidebar_position: 2
+title: 'As a Service'
+---
+
+If you have multi-scrobbler installed [locally](installation.md#local) you can enable it to run as a background service when you login.
+
+Before running as a service you should run it at least once in the foreground to ensure it can start up correctly!
+
+# [Systemd](https://systemd.io/)
+
+Systemd is system and service manager that is used by [most popular linux distros](https://en.wikipedia.org/wiki/Systemd#Adoption) including [Ubuntu](https://wiki.ubuntu.com/SystemdForUpstartUsers), [Fedora](https://docs.fedoraproject.org/en-US/quick-docs/understanding-and-administering-systemd/), Pop!_OS, [Debian](https://wiki.debian.org/systemd), and [Arch](https://wiki.archlinux.org/title/systemd).
+
+This setup will create a [user service](https://wiki.archlinux.org/title/systemd/User) that runs on login.
+
+## Create A Unit File
+
+Create a new service file for multi-scrobbler under your HOME config:
+
+```console
+mkdir -p ~/.config/systemd/user
+touch ~/.config/systemd/user/multi-scrobbler.service
+```
+
+In a text editor add contents below to the file you created, `multi-scrobbler.service`:
+
+```ini
+[Unit]
+Description=multi-scrobbler
+After=network.target
+
+[Service]
+Type=simple
+ExecStart=flatpak run io.github.multiscrobbler
+Restart=no
+
+[Install]
+WantedBy=default.target
+```
+
+The above assumes you [installed multi-scrobbler using flatpak](installation.md#flatpak)
+
+### Node.js Installs
+
+If you are running multi-scrobbler directly with [nodejs from a clone repository directory](installation.md#nodejs) you should modify the `[Service]`:
+
+```ini
+[Service]
+Type=simple
+WorkingDirectory=/path/to/multi-scrobbler/directory
+ExecStart=node src/index.js
+Restart=no
+```
+
+## Start the Service
+
+Save the file then run:
+
+```console
+systemctl daemon-reload
+systemctl --user enable multi-scrobbler.service
+systemctl --user start multi-scrobbler.service
+```
+
+This will
+
+* scan for new services and pickup our multi-scrobbler user service
+* enable the service to run at login automatically
+* start the service now
+
+# Other Service Methods
+
+Open a PR if you would like to document setting up multi-scrobbler for other service managers!

docsite/docusaurus.config.js

@@ -0,0 +1,159 @@
+// @ts-check
+// Note: type annotations allow type checking and IDEs autocompletion
+
+const lightCodeTheme = require('prism-react-renderer/themes/github');
+const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  title: 'Multi-Scrobbler',
+  tagline: 'Scrobble all the things',
+  favicon: 'img/favicon.ico',
+
+  // Set the production url of your site here
+  url: 'https://foxxmd.github.io',
+  // Set the /<baseUrl>/ pathname under which your site is served
+  // For GitHub pages deployment, it is often '/<projectName>/'
+  baseUrl: '/multi-scrobbler',
+
+  // GitHub pages deployment config.
+  // If you aren't using GitHub pages, you don't need these.
+  organizationName: 'foxxmd', // Usually your GitHub org/user name.
+  projectName: 'multi-scrobbler', // Usually your repo name.
+
+  trailingSlash: false,
+
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+
+  // Even if you don't use internalization, you can use this field to set useful
+  // metadata like html lang. For example, if your site is Chinese, you may want
+  // to replace "en" with "zh-Hans".
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  presets: [
+    [
+      'classic',
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
+        docs: {
+          sidebarPath: require.resolve('./sidebars.js'),
+          // Please change this to your repo.
+          // Remove this to remove the "edit this page" links.
+          editUrl:
+            'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
+        },
+        // blog: {
+        //   showReadingTime: true,
+        //   // Please change this to your repo.
+        //   // Remove this to remove the "edit this page" links.
+        //   editUrl:
+        //     'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
+        // },
+        blog: false,
+
+        theme: {
+          customCss: require.resolve('./src/css/custom.css'),
+        },
+      }),
+    ],
+  ],
+  themes: ["docusaurus-json-schema-plugin"],
+  plugins: [
+    [
+      require.resolve("@cmfcmf/docusaurus-search-local"),
+      {
+        indexBlog: false,
+      },
+    ],
+  ],
+  themeConfig:
+    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+    ({
+      // Replace with your project's social card
+      image: 'img/docusaurus-social-card.jpg',
+      navbar: {
+        title: 'Multi-Scrobbler',
+        logo: {
+          alt: 'Logo',
+          src: 'img/icon.svg',
+        },
+        items: [
+          {
+            type: 'docSidebar',
+            sidebarId: 'tutorialSidebar',
+            position: 'left',
+            label: 'Docs',
+          },
+          {
+            to: 'playground',
+            position: 'left',
+            label: 'Config Playground',
+          },
+          {
+            href: 'https://github.com/foxxmd/multi-scrobbler',
+            label: 'GitHub',
+            position: 'right',
+          },
+        ],
+      },
+      footer: {
+        style: 'dark',
+        links: [
+          {
+            title: 'Docs',
+            items: [
+              {
+                label: 'Overview',
+                to: '/',
+              },
+              {
+                label: 'Installation',
+                to: '/docs/installation',
+              },
+              {
+                label: 'Configuration',
+                to: '/docs/configuration',
+              },
+            ],
+          },
+/*          {
+            title: 'Community',
+            items: [
+              {
+                label: 'Stack Overflow',
+                href: 'https://stackoverflow.com/questions/tagged/docusaurus',
+              },
+              {
+                label: 'Discord',
+                href: 'https://discordapp.com/invite/docusaurus',
+              },
+              {
+                label: 'Twitter',
+                href: 'https://twitter.com/docusaurus',
+              },
+            ],
+          },*/
+          {
+            title: 'More',
+            items: [
+              {
+                label: 'GitHub',
+                href: 'https://github.com/foxxmd/multi-scrobbler',
+              },
+            ],
+          },
+        ],
+        copyright: `Copyright © ${new Date().getFullYear()} Multi-Scrobbler. Built with Docusaurus.`,
+      },
+      prism: {
+        theme: lightCodeTheme,
+        darkTheme: darkCodeTheme,
+      },
+    }),
+};
+
+module.exports = config;

docsite/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "my-website",
+  "version": "0.0.0",
+  "private": true,
+  "scripts": {
+    "docusaurus": "docusaurus",
+    "start": "docusaurus start",
+    "build": "docusaurus build",
+    "swizzle": "docusaurus swizzle",
+    "deploy": "docusaurus deploy",
+    "clear": "docusaurus clear",
+    "serve": "docusaurus serve",
+    "write-translations": "docusaurus write-translations",
+    "write-heading-ids": "docusaurus write-heading-ids",
+    "typecheck": "tsc"
+  },
+  "dependencies": {
+    "@cmfcmf/docusaurus-search-local": "^1.1.0",
+    "@docusaurus/core": "2.4.1",
+    "@docusaurus/preset-classic": "2.4.1",
+    "@mdx-js/react": "^1.6.22",
+    "clsx": "^1.2.1",
+    "docusaurus-json-schema-plugin": "^1.6.1",
+    "prism-react-renderer": "^1.3.5",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
+  },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "2.4.1",
+    "@tsconfig/docusaurus": "^1.0.5",
+    "typescript": "^4.7.4"
+  },
+  "browserslist": {
+    "production": [
+      ">0.5%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "engines": {
+    "node": ">=16.14"
+  }
+}

docsite/sidebars.js

@@ -0,0 +1,40 @@
+/**
+ * Creating a sidebar enables you to:
+ - create an ordered group of docs
+ - render a sidebar for each doc of that group
+ - provide next/previous navigation
+
+ The sidebars can be generated from the filesystem, or explicitly defined here.
+
+ Create as many sidebars as you want.
+ */
+
+// @ts-check
+
+/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
+const sidebars = {
+  // By default, Docusaurus generates a sidebar from the docs folder structure
+  tutorialSidebar: [
+      {type: 'autogenerated', dirName: '.'},
+    {
+      type: "link",
+      label: "Config Playground",
+      href: "/playground"
+    }
+  ],
+
+  // But you can create a sidebar manually
+  /*
+  tutorialSidebar: [
+    'intro',
+    'hello',
+    {
+      type: 'category',
+      label: 'Tutorial',
+      items: ['tutorial-basics/create-a-document'],
+    },
+  ],
+   */
+};
+
+module.exports = sidebars;

docsite/src/components/JSONSchemaData.tsx

@@ -0,0 +1,44 @@
+import React from "react"
+import BrowserOnly from "@docusaurus/BrowserOnly"
+import { useColorMode } from "@docusaurus/theme-common"
+
+import JSONSchemaEditor from "@theme/JSONSchemaEditor"
+// Context
+import { usePlaygroundContext } from "@site/src/contexts/PlaygroundContext"
+
+// Common stringify of the JSON
+const STRINGIFY_JSON = (json: unknown) => JSON.stringify(json, null, "\t")
+
+function JSONSchemaDataInner(): JSX.Element {
+    const {
+        state: { userSchema, editorRef, data: value },
+        updateState,
+    } = usePlaygroundContext()
+
+    const { colorMode } = useColorMode()
+
+    return (
+        <div style={{ boxSizing: "border-box", width: "50%" }}>
+            <JSONSchemaEditor
+                value={value}
+                schema={userSchema}
+                theme={colorMode === "dark" ? "vs-dark" : "vs"}
+                editorDidMount={(editor) => {
+                    updateState({ editorRef: editor })
+                }}
+                height={"70vh"}
+                key={STRINGIFY_JSON(userSchema)}
+            />
+        </div>
+    )
+}
+
+export default function JSONSchemaDataComponent(): JSX.Element {
+    return (
+        <BrowserOnly fallback={<div>Loading...</div>}>
+            {() => {
+                return <JSONSchemaDataInner />
+            }}
+        </BrowserOnly>
+    )
+}

docsite/src/components/PlaygroundInner.tsx

@@ -0,0 +1,59 @@
+import React from "react"
+import BrowserOnly from "@docusaurus/BrowserOnly"
+
+import Schema from "@site/static/aio.json";
+import ConfigExample from "@site/static/configExample.json";
+import JSONSchemaViewer from "@theme/JSONSchemaViewer"
+import JSONSchemaEditor from "@theme/JSONSchemaEditor";
+import {useColorMode} from "@docusaurus/theme-common";
+const STRINGIFY_JSON = (json: unknown) => JSON.stringify(json, null, "\t")
+
+// based on https://github.com/jy95/docusaurus-json-schema-plugin/blob/main/testsite/src/components/PlaygroundInner.tsx
+function PlaygroundInner(): JSX.Element {
+
+    const { colorMode } = useColorMode()
+
+    return (
+        <div
+            style={{
+                display: "flex",
+                flexDirection: "column",
+                overflowY: "hidden",
+                overflowX: "hidden",
+            }}
+        >
+            <div
+                style={{
+                    display: "flex",
+                    flexDirection: "row",
+                    justifyContent: "space-between",
+                }}
+            >
+                <div style={{width: '50%'}}>
+                <JSONSchemaViewer
+                    schema={Schema}
+                    showExamples={true}
+                />
+                </div>
+                <div style={{ boxSizing: "border-box", width: "50%" }}>
+                <JSONSchemaEditor
+                    value={STRINGIFY_JSON(ConfigExample)}
+                    theme={colorMode === "dark" ? "vs-dark" : "vs"}
+                    schema={Schema}
+                    height={"70vh"}
+                />
+                </div>
+            </div>
+        </div>
+    )
+}
+
+export default function PlaygroundComponent(): JSX.Element {
+    return (
+        <BrowserOnly fallback={<div>Loading...</div>}>
+            {() => {
+                return <PlaygroundInner />
+            }}
+        </BrowserOnly>
+    )
+}

docsite/src/contexts/PlaygroundContext.tsx

@@ -0,0 +1,50 @@
+import { useContext, createContext } from "react"
+
+// Type I need for useRef
+import type { MonacoEditorTypes } from "@theme/MonacoEditor"
+
+export type State = {
+    // The full schema
+    // We might need to scope it with a JSON Pointer
+    fullSchema: unknown
+    // The current schema displayed (after the json pointer)
+    userSchema: unknown
+    // The current json pointer
+    jsonPointer: string
+    // Schema editor ref
+    schemaRef: undefined | MonacoEditorTypes.IStandaloneCodeEditor
+    // Data editor ref
+    editorRef: undefined | MonacoEditorTypes.IStandaloneCodeEditor
+    // Data on the data editor
+    // When using "Infer schema from data", it would be annoying to lose our written
+    data: string
+    // Errors in schema
+    schemaErrors: MonacoEditorTypes.IMarkerData[]
+    // Errors in data
+    dataErrors: MonacoEditorTypes.IMarkerData[]
+}
+
+export type Playground = {
+    // state
+    state: State
+    // update function
+    updateState: (_: Partial<State>) => void
+}
+
+export const PlaygroundContext = createContext<Playground>({
+    state: {
+        fullSchema: {},
+        userSchema: {},
+        jsonPointer: "",
+        data: "{}",
+        schemaRef: undefined,
+        editorRef: undefined,
+        schemaErrors: [],
+        dataErrors: [],
+    },
+    updateState: () => {},
+})
+
+export const usePlaygroundContext = () => useContext(PlaygroundContext)
+
+export const PlaygroundContextProvider = PlaygroundContext.Provider

docsite/src/css/custom.css

@@ -0,0 +1,30 @@
+/**
+ * Any CSS included here will be global. The classic template
+ * bundles Infima by default. Infima is a CSS framework designed to
+ * work well for content-centric websites.
+ */
+
+/* You can override the default Infima variables here. */
+:root {
+  --ifm-color-primary: #2e8555;
+  --ifm-color-primary-dark: #29784c;
+  --ifm-color-primary-darker: #277148;
+  --ifm-color-primary-darkest: #205d3b;
+  --ifm-color-primary-light: #33925d;
+  --ifm-color-primary-lighter: #359962;
+  --ifm-color-primary-lightest: #3cad6e;
+  --ifm-code-font-size: 95%;
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
+}
+
+/* For readability concerns, you should choose a lighter palette in dark mode. */
+[data-theme='dark'] {
+  --ifm-color-primary: #25c2a0;
+  --ifm-color-primary-dark: #21af90;
+  --ifm-color-primary-darker: #1fa588;
+  --ifm-color-primary-darkest: #1a8870;
+  --ifm-color-primary-light: #29d5b0;
+  --ifm-color-primary-lighter: #32d8b4;
+  --ifm-color-primary-lightest: #4fddbf;
+  --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
+}

docsite/src/pages/index.mdx

@@ -0,0 +1,103 @@
+---
+title: Overview
+---
+
+# Overview
+
+![Latest Release](https://img.shields.io/github/v/release/foxxmd/multi-scrobbler)
+![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)
+![Docker Pulls](https://img.shields.io/docker/pulls/foxxmd/multi-scrobbler)
+
+<img src={require('/img/icon.png').default} align="right" alt="multi-scrobbler logo" width="180" height="180"/>
+
+A javascript app to scrobble music you listened to, to [Maloja](https://github.com/krateng/maloja), [Last.fm](https://www.last.fm), and [ListenBrainz](https://listenbrainz.org)
+
+* Supports scrobbling from many **Sources**
+    * [Spotify](docs/configuration#spotify)
+    * [Plex](docs/configuration#plex) or [Tautulli](docs/configuration#tautulli)
+    * [Subsonic-compatible APIs](docs/configuration#subsonic) (like [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/))
+    * [Jellyfin](docs/configuration#jellyfin)
+    * [WebScrobbler](docs/configuration#webscrobbler)
+    * [Youtube Music](docs/configuration#youtube-music)
+    * [Last.fm](docs/configuration#lastfm-source)
+    * [ListenBrainz](docs/configuration#listenbrainz--source-)
+    * [Deezer](docs/configuration#deezer)
+    * [MPRIS (Linux Desktop)](docs/configuration#mpris)
+    * [Mopidy](docs/configuration#mopidy)
+    * [JRiver](docs/configuration#jriver)
+    * [Kodi](docs/configuration#kodi)
+    * [Google Cast (Chromecast)](/docs/configuration#google-cast--chromecast-)
+* Supports scrobbling to many **Clients**
+    * [Maloja](docs/configuration#maloja)
+    * [Last.fm](docs/configuration#lastfm)
+    * [ListenBrainz](docs/configuration#listenbrainz)
+* Monitor status of Sources and Clients using [webhooks (Gotify or Ntfy)](docs/configuration#webhook-configurations) or [healthcheck endpoint](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
+* Install using [Docker images for x86/ARM](docs/installation#docker), [flatpak](docs/installation#flatpak), or [locally with NodeJS](docs/installation#nodejs)
+
+**Why should I use this over a browser extension and/or mobile app scrobbler?**
+
+* **Platform independent** -- Because multi-scrobbler communicates directly with service APIs it will scrobble everything you play regardless of where you play it. No more need for apps on every platform you use!
+* **Open-source** -- Get peace of mind knowing exactly how your personal data is being handled.
+* **Track your activity regardless of where you listen** -- Scrobble from many Sources to one Client with ease and without duplicating tracks.
+* **Manage scrobbling for others** -- Scrobble for your friends and family without any setup on their part. Easily silo sources to specific clients to keep plays separate.
+
+**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#lastfm--source-) or [Listenbrainz as a **Source**](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.
+
+<img src={require('/img/status-ui.png').default} width="800"/>
+
+## How Does multi-scrobbler (MS) Work?
+
+You set up configurations for one or more **Sources** and one or more **Clients**. MS monitors all of your configured **Sources**. When new tracks are played by a Source it grabs that information and then sends it (scrobbles it) to all **Clients** that Source is configured to scrobble to.
+
+### Source
+
+A **Source** is a data source that contains information about tracks you are playing like a music player or platform. Examples are **Spotify, Jellyfin, Plex, Youtube Music, Airsonic**, etc...
+
+Source configurations consist of:
+
+* A friendly name.
+* Any data needed to communicate or authenticate with the Source.
+* An optional list of Client names that the Source should scrobble to. If omitted the Source also scrobbles to all configured Clients.
+
+### Client
+
+A **Client** is an application that stores the historical information about what songs you have played (scrobbles). Examples are **Maloja, Last.fm, Listenbrainz**...
+
+Client configurations consist of:
+
+* A friendly name.
+* Any data needed to communicate or authenticate with the Client.
+
+## Installation
+
+[See the **Installation** documentation](docs/installation)
+
+## Configuration
+
+[See the **Configuration** documentation](docs/configuration)
+
+## Usage
+
+A status page with statistics, recent logs, and some runtime configuration options can be found at
+
+```
+http://localhost:9078
+```
+Output is also provided to stdout/stderr as well as file if specified in configuration.
+
+On first startup you may need to authorize Spotify and/or Last.fm by visiting the callback URL (which can also be accessed from the status page). Visit the status page above to find the applicable link to trigger this.
+
+## Help/FAQ
+
+Having issues with connections or configuration? Check the [FAQ](docs/FAQ) before creating an issue!
+
+## License
+
+MIT

docsite/src/pages/playground.tsx

@@ -0,0 +1,38 @@
+import React from "react"
+import Layout from "@theme/Layout"
+import BrowserOnly from "@docusaurus/BrowserOnly"
+import ErrorBoundary from "@docusaurus/ErrorBoundary"
+// based on https://github.com/jy95/docusaurus-json-schema-plugin/blob/main/testsite/src/pages/playground.tsx
+function PlaygroundComponent(): JSX.Element {
+    // No SSR for the live preview
+    // See https://github.com/facebook/docusaurus/issues/5747
+    return (
+        <ErrorBoundary
+            fallback={({ error, tryAgain }) => (
+                <div>
+                    <p>Playground component crashed because of error: {error.message}.</p>
+                    <button onClick={tryAgain}>Try Again!</button>
+                </div>
+            )}
+        >
+            <BrowserOnly fallback={<div>Loading...</div>}>
+                {() => {
+                    const PlaygroundInnerComponent =
+                        require("@site/src/components/PlaygroundInner").default
+                    return <PlaygroundInnerComponent />
+                }}
+            </BrowserOnly>
+        </ErrorBoundary>
+    )
+}
+
+export default function Playground(): JSX.Element {
+    return (
+        <Layout
+            title={`Playground`}
+            description="Playground of docusaurus-json-schema-plugin"
+        >
+            <PlaygroundComponent />
+        </Layout>
+    )
+}

docsite/static/configExample.json

@@ -0,0 +1,60 @@
+{
+  "sourceDefaults": {
+    "maxPollRetries": 0,
+    "maxRequestRetries": 1,
+    "retryMultiplier": 1.5
+  },
+  "clientDefaults": {
+    "maxRequestRetries": 1,
+    "retryMultiplier": 1.5
+  },
+  "baseUrl": "http://localhost",
+  "sources": [
+    {
+      "type": "spotify",
+      "clients": ["myConfig"],
+      "name": "mySpotifySource",
+      "data": {
+        "clientId": "a89cba1569901a0671d5a9875fed4be1",
+        "clientSecret": "ec42e09d5ae0ee0f0816ca151008412a",
+        "redirectUri": "http://localhost:9078/callback"
+      }
+    }
+  ],
+  "clients": [
+    {
+      "type": "maloja",
+      "name": "myConfig",
+      "data": {
+        "url": "http://localhost:42010",
+        "apiKey": "myMalojaKey"
+      }
+    }
+  ],
+  "webhooks": [
+    {
+      "name": "FirstGotifyServer",
+      "type": "gotify",
+      "url": "http://localhost:8070",
+      "token": "MyGotifyToken",
+      "priorities": {
+        "info": 5,
+        "warn": 7,
+        "error": 10
+      }
+    },
+    {
+      "type": "ntfy",
+      "name": "MyNtfyFriendlyNameForLogs",
+      "url": "http://localhost:9991",
+      "topic": "MyMultiScrobblerTopic",
+      "username": "Optional",
+      "password": "Optional",
+      "priorities": {
+        "info": 3,
+        "warn": 4,
+        "error": 5
+      }
+    }
+  ]
+}

docsite/static/img/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>

docsite/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  // This file is not used in compilation. It is here just for a nice editor experience.
+  "extends": "@tsconfig/docusaurus/tsconfig.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "resolveJsonModule": true,
+    // Extending "@tsconfig/docusaurus/tsconfig.json".types with "docusaurus-json-schema-plugin"
+    "types": ["node", "@docusaurus/module-type-aliases", "@docusaurus/theme-classic", "docusaurus-json-schema-plugin"]
+  }
+}

eslint.config.js

@@ -0,0 +1,43 @@
+// @ts-check
+
+import eslint from '@eslint/js';
+import tsEslint from 'typescript-eslint';
+import arrow from 'eslint-plugin-prefer-arrow-functions';
+
+export default tsEslint.config(
+    eslint.configs.recommended,
+    ...tsEslint.configs.recommended,
+// use to enable typed linting (way more errors) https://typescript-eslint.io/linting/typed-linting
+/*    ...tsEslint.configs.recommendedTypeChecked,
+    {
+        languageOptions: {
+            parserOptions: {
+                project: true,
+                tsconfigDirName: import.meta.dirname,
+            },
+        },
+    },*/
+    {
+        files: ['src/backend/**/*.ts'],
+        ignores: ['eslint.config.js'],
+        plugins: {
+            "prefer-arrow-functions": arrow
+        },
+        rules: {
+            'no-useless-catch': 'off',
+            '@typescript-eslint/no-unused-vars': 'off',
+            "prefer-arrow-functions/prefer-arrow-functions": [
+                "warn",
+                {
+                    "allowNamedFunctions": false,
+                    "classPropertiesAllowed": false,
+                    "disallowPrototype": false,
+                    "returnStyle": "unchanged",
+                    "singleReturnOnly": false
+                }
+            ],
+            "arrow-body-style": ["warn", "as-needed"],
+            "@typescript-eslint/no-explicit-any": "warn"
+        }
+    }
+);

flatpak/README.md

@@ -0,0 +1,48 @@
+NOTE: This steps are for building the flatpak entirely locally, from source. If you want to install the application normally then [get it through flathub](/docs/installation.md#flatpak)
+
+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)
+
+# 1. 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/)
+
+# 2. Update Project source
+
+Set the `branch` `tag` or `commit` to use for MS in the `git` source in [`io.github.foxxmd.multiscrobbler.yml`](/flatpak/io.github.foxxmd.multiscrobbler.yml)
+
+# 3. 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)
+
+Then, from MS project root:
+
+```shell
+flatpak-node-generator npm package-lock.json
+```
+
+Move `generated-sources.json` into [`/flatpak`](/flatpak)
+
+# 4. Build flatpak
+
+From MS project root:
+
+```shell
+cd 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 --install --user
+```
+Add `--install --user` to have the app installed immediately.
+# 5. Run (Locally)
+
+If built with `--install --user` you can now run MS using the command
+
+```shell
+flatpak run -u io.github.foxxmd.multiscrobbler
+```

flatpak/defaultConfig.json

@@ -0,0 +1,6 @@
+{
+  "logging": {
+    "file": false
+  },
+  "port": 9078
+}

flatpak/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>

flatpak/io.github.foxxmd.multiscrobbler.desktop

@@ -0,0 +1,10 @@
+[Desktop Entry]
+Type=Application
+Name=multi-scrobbler
+Comment=Scrobbles music from multiple sources to multiple clients
+Icon=io.github.foxxmd.multiscrobbler
+TryExec=multiscrobbler
+Exec=multiscrobbler
+Terminal=true
+Categories=Utility;Music;ConsoleOnly;
+X-Flatpak=io.github.foxxmd.multiscrobbler

flatpak/io.github.foxxmd.multiscrobbler.metainfo.xml

@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<component type="console-application">
+    <id>io.github.foxxmd.multiscrobbler</id>
+    <provides>
+        <id>io.github.foxxmd.multiscrobbler.desktop</id>
+    </provides>
+    <launchable type="desktop-id">io.github.foxxmd.multiscrobbler.desktop</launchable>
+    <name>multi-scrobbler</name>
+    <summary>Scrobbles music from many sources</summary>
+    <url type="homepage">https://foxxmd.github.io/multi-scrobbler</url>
+    <url type="help">https://foxxmd.github.io/multi-scrobbler/docs/configuration</url>
+    <metadata_license>MIT</metadata_license>
+    <project_license>MIT</project_license>
+    <developer id="tld.vendor">
+        <name>FoxxMD</name>
+    </developer>
+    <description>
+        <p>
+            Track your music listening history from many different sources:
+        </p>
+        <ul>
+            <li>Spotify</li>
+            <li>Plex (Tautulli)</li>
+            <li>Any subsonic-based music player (Airsonic)</li>
+            <li>Jellyfin</li>
+            <li>WebScrobbler</li>
+            <li>Mopidy</li>
+            <li>Deezer</li>
+            <li>JRiver</li>
+            <li>Kodi</li>
+            <li>Webscrobbler</li>
+            <li>Youtube Music</li>
+            <li>MPRIS (linux desktop)</li>
+            <li>Google Cast (Chromecast)</li>
+        </ul>
+        <p>and consolidate your listens (scrobbles) into one or more scrobbling servers/services:</p>
+        <ul>
+            <li>Maloja</li>
+            <li>Last.fm</li>
+            <li>Listenbrainz</li>
+        </ul>
+        <p>multi-scrobbler requires some configuration before use. Please visit the website or help links below to get started.</p>
+    </description>
+    <screenshots>
+        <screenshot type="default">
+            <caption>Browser-based UI</caption>
+            <image type="source">https://raw.githubusercontent.com/FoxxMD/multi-scrobbler/f4256d1084f4bdea2945c03e523af6d0ed89b3ae/assets/status-ui.png</image>
+        </screenshot>
+    </screenshots>
+    <releases>
+        <release version="0.6.5" date="2024-02-05"/>
+        <release version="0.6.4" date="2024-01-29"/>
+        <release version="0.6.3" date="2024-01-10"/>
+        <release version="0.6.2" date="2023-11-29"/>
+        <release version="0.6.1" date="2023-10-24"/>
+        <release version="0.6.0" date="2023-10-04"/>
+        <release version="0.5.2" date="2023-09-21"/>
+        <release version="0.5.0" date="2023-08-29"/>
+        <release version="0.4.6" date="2023-06-07"/>
+        <release version="0.4.4" date="2023-03-20"/>
+    </releases>
+    <categories>
+        <category>Utility</category>
+        <category>Music</category>
+        <category>ConsoleOnly</category>
+    </categories>
+    <content_rating type="oars-1.0">
+        <content_attribute id="language-profanity">mild</content_attribute>
+    </content_rating>
+</component>

flatpak/io.github.foxxmd.multiscrobbler.yml

@@ -0,0 +1,87 @@
+app-id: io.github.foxxmd.multiscrobbler
+runtime: org.freedesktop.Platform
+runtime-version: '22.08'
+sdk: org.freedesktop.Sdk
+command: multiscrobbler
+finish-args:
+  - --share=network
+  # used for access to MPRIS in order to scrobble
+  - --own-name=org.mpris.MediaPlayer2.*
+sdk-extensions:
+  - org.freedesktop.Sdk.Extension.node18
+modules:
+  - name: multiscrobbler
+    buildsystem: simple
+    build-options:
+      append-path: /usr/lib/sdk/node18/bin
+      env:
+        XDG_CACHE_HOME: /run/build/multiscrobbler/flatpak-node/cache
+        npm_config_cache: /run/build/multiscrobbler/flatpak-node/npm-cache
+        npm_config_nodedir: /usr/lib/sdk/node18
+        npm_config_offline: 'true'
+    build-commands:
+      # install npm dependencies
+      - npm install --offline
+
+      # build app
+      - NODE_ENV=production npm run build
+
+      # makes node and npm available
+      - mkdir -p /app/bin /app/lib /app/lib/dist /app/lib/src /app/lib/assets
+      - cp -a /usr/lib/sdk/node18/bin/{node,npm} /app/bin
+      - cp -a /usr/lib/sdk/node18/lib/* /app/lib
+      - rm -r /app/lib/node_modules/npm/{docs,man}
+
+      # remove dev dependencies
+      - npm prune --production
+
+      # copy node_modules needed to run app
+      - cp -r node_modules/. /app/lib/node_modules
+
+      # copy app files to runtime dir
+      - cp -r dist/. /app/lib/dist
+      - cp -r src/. /app/lib/src
+      - cp -r config /app/lib/config
+      - cp -r assets /app/lib/assets
+      - cp -r public /app/lib/public
+      - cp vite.config.ts /app/lib/vite.config.ts
+      - cp tsconfig.json /app/lib/tsconfig.json
+      - cp tailwind.config.js /app/lib/tailwind.config.js
+      - cp postcss.config.js /app/lib/postcss.config.js
+      - cp flatpak/defaultConfig.json /app/lib/config/config.json
+
+      - install -Dm644 flatpak/${FLATPAK_ID}.desktop /app/share/applications/${FLATPAK_ID}.desktop
+      - install -Dm644 flatpak/icon.png /app/share/icons/hicolor/512x512/apps/${FLATPAK_ID}.png
+      - install -Dm644 assets/icon.svg /app/share/icons/hicolor/scalable/apps/${FLATPAK_ID}.svg
+      - install -Dm644 flatpak/${FLATPAK_ID}.metainfo.xml /app/share/metainfo/${FLATPAK_ID}.metainfo.xml
+
+      - install -Dm755 ../run.sh /app/bin/multiscrobbler
+    subdir: main
+    sources:
+      # use for official releases
+      - type: git
+        url: https://github.com/FoxxMD/multi-scrobbler
+        tag: 0.6.3
+        commit: 4bd996eb466137ffc5c3f48305afabde03720525
+        dest: main
+      # use if developing locally
+#      - type: dir
+#        path: /home/yourUser/multi-scrobbler
+#        dest: main
+      # Wrapper to launch the app
+      - type: script
+        dest-filename: run.sh
+        commands:
+          # Run config check and copy examples + default config (disable file logging)
+          - |
+            echo -e "Checking CONFIG_DIR for existing configs: ${XDG_CONFIG_HOME}"
+            if [ "$(ls -A ${XDG_CONFIG_HOME})" ]; then
+              echo "Directory is not empty! Will not add default config/examples"
+            else
+              echo "Directory is empty! Adding default config/examples"
+              cp -r /app/lib/config/. "${XDG_CONFIG_HOME}"/
+              #cp /app/lib/defaultConfig.json $XDG_CONFIG_HOME/config.json
+            fi
+          - cd /app/lib && CONFIG_DIR=$XDG_CONFIG_HOME LOG_DIR=$XDG_CONFIG_HOME IS_LOCAL=true NODE_ENV=production node_modules/.bin/tsx src/backend/index.ts
+
+      - generated-sources.json

index.html

@@ -0,0 +1,21 @@
+<!doctype html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8" />
+    <meta
+            name="description"
+            content="Dashboard for Multi Scrobbler"
+    />
+    <meta name="theme-color" content="#000000" />
+    <link rel="apple-touch-icon" href="/logo192.png" />
+    <link rel="icon" type="image/svg+xml" href="/icon.svg" />
+    <link rel="manifest" href="/manifest.json" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Multi Scrobbler</title>
+</head>
+<body>
+<noscript>You need to enable JavaScript to run this app.</noscript>
+<div id="root"></div>
+<script type="module" src="/src/client/index.tsx"></script>
+</body>
+</html>

index.js

@@ -1,229 +0,0 @@
-import {addAsync} from '@awaitjs/express';
-import express from 'express';
-import bodyParser from 'body-parser';
-import multer from 'multer';
-import winston from 'winston';
-import dayjs from 'dayjs';
-import utc from 'dayjs/plugin/utc.js';
-import isBetween from 'dayjs/plugin/isBetween.js';
-import {Writable} from 'stream';
-import 'winston-daily-rotate-file';
-import {labelledFormat, readJson } from "./utils.js";
-import Clients from './clients/ScrobbleClients.js';
-import SpotifySource from "./sources/SpotifySource.js";
-import TautulliSource from "./sources/TautulliSource.js";
-import PlexSource from "./sources/PlexSource.js";
-
-const storage = multer.memoryStorage()
-const upload = multer({storage: storage})
-
-dayjs.extend(utc)
-dayjs.extend(isBetween);
-
-const {transports} = winston;
-
-let output = []
-const stream = new Writable()
-stream._write = (chunk, encoding, next) => {
-    output.unshift(chunk.toString().replace('\n', ''));
-    output = output.slice(0, 101);
-    next()
-}
-const streamTransport = new winston.transports.Stream({
-    stream,
-})
-
-const logConfig = {
-    level: process.env.LOG_LEVEL || 'info',
-    sort: 'descending',
-    limit: 50,
-}
-
-const availableLevels = ['info','debug'];
-const logPath = process.env.LOG_DIR || `${process.cwd()}/logs`;
-const port = process.env.PORT ?? 9078;
-const localUrl = `http://localhost:${port}`;
-
-const rotateTransport = new winston.transports.DailyRotateFile({
-    dirname: logPath,
-    createSymlink: true,
-    symlinkName: 'scrobble-current.log',
-    filename: 'scrobble-%DATE%.log',
-    datePattern: 'YYYY-MM-DD',
-    maxSize: '5m'
-});
-
-const consoleTransport = new transports.Console();
-
-const myTransports = [
-    consoleTransport,
-    streamTransport,
-];
-
-if (typeof logPath === 'string') {
-    myTransports.push(rotateTransport);
-}
-
-const loggerOptions = {
-    level: logConfig.level,
-    format: labelledFormat(),
-    transports: myTransports,
-};
-
-winston.loggers.add('default', loggerOptions);
-
-const logger = winston.loggers.get('default');
-
-const configDir = process.env.CONFIG_DIR || `${process.cwd()}/config`;
-
-const app = addAsync(express());
-
-app.use(bodyParser.json());
-
-try {
-    (async function () {
-
-        // try to read a configuration file
-        let config = {};
-        try {
-            config = await readJson(`${configDir}/config.json`);
-        } catch (e) {
-            logger.info('No config file or could not be read (normal if using ENV vars only)');
-        }
-
-        // setup defaults for other configs and general config
-        const {
-            spotify,
-            plex = {},
-            clients = [],
-        } = config || {};
-
-        /*
-        * setup clients
-        * */
-        const scrobbleClients = new Clients();
-        await scrobbleClients.buildClients(clients, configDir);
-        if (scrobbleClients.clients.length === 0) {
-            logger.warn('No scrobble clients were configured')
-        }
-
-        /*
-        * setup sources
-        * */
-        const spotifySource = new SpotifySource({configDir, localUrl});
-        await spotifySource.buildSpotifyApi(spotify);
-
-        let plexJson = {};
-        try {
-            plexJson = await readJson(`${configDir}/plex.json`);
-        } catch (e) {
-            // no config exists but that's ok
-        }
-
-        const tautulliSource = await new TautulliSource(scrobbleClients, {...plex, ...plexJson});
-        const plexSource = await new PlexSource(scrobbleClients, {...plex, ...plexJson});
-
-        app.getAsync('/', async function (req, res) {
-            let slicedLog = output.slice(0, logConfig.limit + 1);
-            if(logConfig.sort === 'ascending') {
-                slicedLog.reverse();
-            }
-            res.render('status', {
-                spotify: {
-                    status: spotifySource.pollerRunning,
-                    discovered: spotifySource.discoveredTracks,
-                },
-                tautulli: {
-                    status: tautulliSource.discoveredTracks > 0 ? 'Received Data' : 'Awaiting Data',
-                    discovered: tautulliSource.discoveredTracks,
-                },
-                plex: {
-                    status: plexSource.discoveredTracks > 0 ? 'Received Data' : 'Awaiting Data',
-                    discovered: plexSource.discoveredTracks,
-                },
-                logs: {
-                    output: slicedLog,
-                    limit: [10,20,50,100].map(x => `<a class="capitalize ${logConfig.limit === x ? 'bold' : ''}" href="logs/settings/update?limit=${x}">${x}</a>`).join(' | '),
-                    sort: ['ascending', 'descending'].map(x => `<a class="capitalize ${logConfig.sort === x ? 'bold' : ''}" href="logs/settings/update?sort=${x}">${x}</a>`).join(' | '),
-                    level: availableLevels.map(x => `<a class="capitalize ${logConfig.level === x ? 'bold' : ''}" href="logs/settings/update?level=${x}">${x}</a>`).join(' | ')
-                }
-            });
-        })
-
-        app.postAsync('/tautulli', async function (req, res) {
-            await tautulliSource.handle(TautulliSource.formatPlayObj(req.body, true));
-            res.send('OK');
-        });
-
-        app.postAsync('/plex', upload.any(), async function (req, res) {
-            const {
-                body: {
-                    payload
-                } = {}
-            } = req;
-            if (payload !== undefined) {
-                await plexSource.handle(PlexSource.formatPlayObj(JSON.parse(payload), true));
-            }
-            res.send('OK');
-        });
-
-        app.getAsync('/authSpotify', async function (req, res) {
-            logger.info('Redirecting to spotify authorization url');
-            res.redirect(spotifySource.createAuthUrl());
-        });
-
-        app.getAsync('/pollSpotify', async function (req, res) {
-            spotifySource.pollSpotify(scrobbleClients);
-            res.send('OK');
-        });
-
-        app.getAsync('/logs/settings/update', async function (req, res) {
-            const e = req.query;
-            for(const [setting, val] of Object.entries(req.query)) {
-                switch(setting) {
-                    case 'limit':
-                        logConfig.limit = Number.parseInt(val);
-                        break;
-                    case 'sort':
-                        logConfig.sort = val;
-                        break;
-                    case 'level':
-                        logConfig.level = val;
-                        for(const [key, logger] of winston.loggers.loggers) {
-                            logger.level = val;
-                        }
-                        break;
-                }
-            }
-            res.send('OK');
-        });
-
-        app.getAsync(/.*callback$/, async function (req, res, next) {
-            logger.info('Received auth code callback from Spotify', { label: 'Spotify' });
-            const tokenResult = await spotifySource.handleAuthCodeCallback(req.query);
-            let responseContent = 'OK';
-            if(tokenResult === true) {
-                spotifySource.pollSpotify(scrobbleClients);
-            } else {
-                responseContent = tokenResult;
-            }
-            return res.send(responseContent);
-        });
-
-        if (spotifySource.spotifyApi !== undefined) {
-            if (spotifySource.spotifyApi.getAccessToken() === undefined) {
-                logger.info('Spotify Api is not ready');
-                logger.info(`Open ${localUrl}/authSpotify to continue`);
-            } else {
-                spotifySource.pollSpotify(scrobbleClients);
-            }
-        }
-        app.set('views', './views');
-        app.set('view engine', 'ejs');
-        logger.info(`Server started at ${localUrl}`);
-        const server = await app.listen(port)
-    }());
-} catch (e) {
-    logger.error('Exited with uncaught error');
-    logger.error(e);
-}