multi-scrobbler

https://docs.multi-scrobbler.app
Admin
multi-scrobbler is a dockerized application that monitors music listening activity from various...
Tokens:110,621
Snippets:1,453
Trust Score:4.6
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start application via npm

Source: https://docs.multi-scrobbler.app/installation

Standard command to start the application after configuration.

```bash
npm run start  
```

--------------------------------

### All-in-One Configuration Example

Source: https://docs.multi-scrobbler.app/configuration/sources/azuracast

Example of an Azuracast source definition within the main config.json file.

```json
{
"sources": [
{
"type": "azuracast",
"enable": true,
"name": "Cool Station",
"id": "myAzura",
"data": {
"url": "ws://192.168.0.101",
"station": "my-station-name",
"monitorWhenLive": true,
"monitorWhenListeners": 1
}
}
]
}
```

--------------------------------

### Install and Run Flatpak Application

Source: https://docs.multi-scrobbler.app/development/flatpak

Installs and runs the Flatpak application. Append --install --user to the build command for immediate installation. The run command uses the specified application ID.

```bash
flatpak run -u io.github.foxxmd.multiscrobbler
```

--------------------------------

### All-in-One Configuration Example

Source: https://docs.multi-scrobbler.app/configuration/sources/icecast

Example of an Icecast source defined within the main config.json file.

```json
{
"sources": [
{
"name": "Station 1",
"enable": true,
"id": "myIceStation1",
"data": {
"url": "http://myIcecast.com/radio"
},
"type": "icecast"
}
]
}
```

--------------------------------

### Install Multi-Scrobbler via Node.js

Source: https://docs.multi-scrobbler.app/installation

Commands to clone the repository, install dependencies, build the project, and start the application.

```bash
git clone --branch <LATEST_RELEASE_TAG> https://github.com/FoxxMD/multi-scrobbler.git  
cd multi-scrobbler  
nvm use # optional, to set correct Node version  
npm install  
npm run docs:install && npm run build  
npm run start  
```

--------------------------------

### All-in-One Configuration Example

Source: https://docs.multi-scrobbler.app/configuration/sources/spotify?spotifyRedirect=echo

Example of a comprehensive config.json file including a Spotify source definition within the sources array.

```json
{
"sources": [
{
"id": "MySpotify",
"name": "Foxx Spotify",
"enable": true,
"clients": [],
"data": {
"clientId": "a89cba1569901a0671d5a9875fed4be1",
"clientSecret": "ec42e09d5ae0ee0f0816ca151008412a",
"redirectUri": "http://localhost:9078/callback",
"interval": 60
},
"type": "spotify"
}
]
}
```

--------------------------------

### All-in-One Configuration Example

Source: https://docs.multi-scrobbler.app/configuration/sources/mpd

Example of an all-in-one config.json file including an MPD source definition.

```json
{
"sources": [
{
"enable": true,
"id": "myMPD",
"name": "Desktop",
"data": {
"url": "192.168.0.100:6600",
"password": "MY_PASSWORD"
},
"options": {
"disableDiscovery": false
},
"type": "mpd"
}
]
}
```

--------------------------------

### All-in-One Configuration Example

Source: https://docs.multi-scrobbler.app/configuration/sources/jellyfin

An example of a full configuration file including a Jellyfin source definition within the sources array.

```json
{
"sources": [
{
"name": "Cool JF Server",
"enable": true,
"id": "myJellyfin",
"clients": [],
"data": {
"url": "http://localhost:8096",
"user": "FoxxMD",
"apiKey": "c9fae8756fbf481ebd9c5bb56bd6540c",
"usersAllow": [
"FoxxMD",
"SomeOtherUser"
],
"usersBlock": [
"AnotherUser"
],
"devicesAllow": [
"firefox"
],
"devicesBlock": [
"google-home"
],
"librariesAllow": [
"GoodMusic"
],
"librariesBlock": [
"BadMusic"
]
```

--------------------------------

### All-in-One Configuration Example

Source: https://docs.multi-scrobbler.app/configuration/sources/deezer

Example JSON structure for a global config.json file including a Deezer source definition.

```json
{
"sources": [
{
"name": "Family Account",
"id": "myDeezerId",
"enable": true,
"clients": [],
"data": {
"arl": "UOsRPjT3U5Dhaaup3xQ30DWFoSgqugdSYzL3QE743waaVy2eur2ckyJcZ4RV123Q3PsbKXkLwA6ahc9XmEfev6BtfSP8LujE3JswWRQogZCDUOwVzWO5sAig"
},
"type": "deezer"
}
]
}
```

--------------------------------

### Local Installation ENV Configuration Example

Source: https://docs.multi-scrobbler.app/configuration?cachedThings=metadata

Export environment variables before starting Multi Scrobbler for a local Node.js installation. This method is useful for single-user or simple setups.

```bash
SPOTIFY_CLIENT_ID=yourId SPOTIFY_CLIENT_SECRET=yourSecret npm run start
```

--------------------------------

### Example OAuth Startup Log

Source: https://docs.multi-scrobbler.app/configuration/sources/youtube-music

Example of the log output generated by Multi-Scrobbler during startup to identify the required Redirect URI.

```text
Will use custom OAuth Client:  
Client ID: ...  
Client Secret: ...  
Redirect URI: http://localhost:9078/api/ytmusic/callback?name=MyYTM
```

--------------------------------

### Example Configuration File

Source: https://docs.multi-scrobbler.app/configuration?cachedThings=metadata

This is a comprehensive example of the config.json file, illustrating various configuration sections such as source defaults, client defaults, source definitions (e.g., Spotify), client definitions (e.g., Maloja), and webhook configurations (e.g., Gotify, ntfy).

```json
{
  "debugMode": false,
  "disableWeb": false,
  "sourceDefaults": {
    "logPayload": false,
    "logFilterFailure": "warn",
    "logPlayerState": false,
    "scrobbleThresholds": {
      "duration": 30,
      "percent": 50
    },
    "maxPollRetries": 1,
    "maxRequestRetries": 1,
    "retryMultiplier": 1.5
  },
  "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
      }
    }
  ]
}
```

--------------------------------

### All-in-One Configuration Example

Source: https://docs.multi-scrobbler.app/configuration/sources/lastfm-endpoint

Example of an all-in-one config.json file including an endpointlfm source definition.

```json
{
"sources": [
{
"name": "LFM For App",
"enable": true,
"id": "myLfmApp",
"data": {
"slug": "mySlug"
},
"type": "endpointlfm"
}
]
}
```

--------------------------------

### Full Docker Deploy Example with ENV Configuration

Source: https://docs.multi-scrobbler.app/configuration/transforms/musicbrainz

Example of a full Docker deployment using Jellyfin and Maloja, demonstrating the configuration of MusicBrainz transforms via environment variables.

```yaml
services:
  multi-scrobbler:
    image: foxxmd/multi-scrobbler
    container_name: multi-scrobbler
    environment:
      - MB_CONTACT=contact@mydomain.com
       # searches with sensible release sorting with the searchOrder
       # isrc => basic => artist (native mode)
      - MB_PRESETS=default,sensible,native
      - JELLYFIN_URL=192.168.0.110:8096
      - JELLYFIN_APIKEY=c9fae8756fbf481ebd9c5bb56b
      - JELLYFIN_USER=MyUser
       # applies musicbrainz Stage to preTransform of Jellyfin source
      - JELLYFIN_TRANSFORMS=musicbrainz

      # maloja receives enhanced scrobble from Jellyfin
      - MALOJA_URL=http://192.168.0.100:42010
      - MALOJA_API_KEY=myApiKey


    volumes:
      - "./config:/config"
    ports:
      - "9078:9078"
    restart: unless-stopped

```

--------------------------------

### JRiver URL Transformation Examples

Source: https://docs.multi-scrobbler.app/configuration/sources/jriver

Examples showing how various input configurations are transformed into the final connection URL.

```markdown
`url`| Transformed URL  
---|---  
(none set)| `http://localhost:52199/MCWS/v1/`  
`jriver.mydomain.com`| `http://jriver.mydomain.com:52199/MCWS/v1/`  
`192.168.0.101:3456`| `http://192.168.0.101:3456/MCWS/v1/`  
`mydomain.com:80/jriverReverse/MCWS/v1/`| `mydomain.com:80/jriverReverse/MCWS/v1/`
```

--------------------------------

### All-in-One Configuration Example

Source: https://docs.multi-scrobbler.app/configuration/sources/webscrobbler

Example JSON structure for an all-in-one config.json file including a webscrobbler source definition.

```json
{
"sources": [
{
"id": "MyWebScrobbler",
"name": "Firefox Laptop",
"data": {
"slug": "MyOptionalSlug",
"whitelist": [],
"blacklist": []
},
"type": "webscrobbler"
}
]
}
```

--------------------------------

### Naive Mode Input Example

Source: https://docs.multi-scrobbler.app/configuration/transforms/musicbrainz

Example of input data for the Naive search mode, demonstrating a single artist string with multiple artists.

```json
{
    "title": "Endless Possibility (feat. Wheatus)",
    "artists": ["Bowling For Soup, Punk Rock Factory & Wheatus"]
}

```

--------------------------------

### Docker ENV Configuration Example

Source: https://docs.multi-scrobbler.app/configuration?cachedThings=metadata

Configure Multi Scrobbler using environment variables when running a Docker container. This is suitable for simple setups.

```bash
docker run -e "SPOTIFY_CLIENT_ID=yourId" -e "SPOTIFY_CLIENT_SECRET=yourSecret" ...
```

--------------------------------

### Example Log Output for Version Check

Source: https://docs.multi-scrobbler.app/updating

When Multi-Scrobbler starts, it logs the current version. This is useful for verifying updates.

```log
[2026-04-16 09:17:32.428 -0400] INFO   : [Init] Version: 0.13.0
```

--------------------------------

### All-in-One Configuration File

Source: https://docs.multi-scrobbler.app/configuration/sources/yamaha-musiccast

Example of including a MusicCast source within the main config.json file.

```json
{
"sources": [
{
"name": "Livingroom Reciever",
"id": "myYamaha",
"enable": true,
"data": {
"url": "192.168.0.101"
},
"type": "musiccast"
}
]
}
```

--------------------------------

### Clone and Install Project Dependencies

Source: https://docs.multi-scrobbler.app/development/dev-common

Steps to clone the repository, navigate into the directory, and install project dependencies using npm. The 'nvm use' command is optional and helps set the correct Node.js version.

```bash
git clone https://github.com/FoxxMD/multi-scrobbler.git .
cd multi-scrobbler
nvm use # optional, sets correct node version when running without devcontainer
npm install
npm run start
```

--------------------------------

### All-in-One Configuration File

Source: https://docs.multi-scrobbler.app/configuration/clients/lastfm

Example of a Last.fm client integrated into the main application configuration file.

```json
{
"clients": [
{
"name": "Foxx LFM Client",
"id": "myLastFmClient",
"enable": true,
"configureAs": "client",
"data": {
"apiKey": "a89cba1569901a0671d5a9875fed4be1",
"secret": "ec42e09d5ae0ee0f0816ca151008412a",
"redirectUri": "http://localhost:9078/lastfm/callback"
},
"type": "lastfm"
}
]
}
```

--------------------------------

### Example Transform Diff Output

Source: https://docs.multi-scrobbler.app/configuration/transforms

This example shows the typical output when transformation logging is enabled, highlighting the differences between the original play data and the transformed output using diff syntax.

```text
[2025-12-17 08:53:10.467 -0500] DEBUG  : [App] [Sources] [Lastfm - mylfm] [Play Transform] [preCompare] [VLDJJo] Transform Diff  
- Original  
+ musicbrainz-MyMB  
  
  Title        : Demons Theme Part II (original 12" mix)  
  Artists      : LTJ Bukem  
  Album Artists: (None)  
- Album        : Producer 05: Rarities (Original 12" Version)  
+ Album        : Producer 05: Rarities (original 12" version)  
  Meta         :   
  * brainz-album: 36759a8a-d3df-47da-a236-60f84fdc0cab  
+ * brainz-artist: 28c1b7b7-355a-48b1-b2c4-75b8eb8080ef  
+ * brainz-track: a0d51240-7ef1-4676-882e-be9f354075cb  
+ * brainz-releaseGroup: e0cce74f-abcc-343b-9390-1673e4d57ce7  

```

--------------------------------

### All-in-One Configuration File

Source: https://docs.multi-scrobbler.app/configuration/clients/discord/discord-headless?artworkUrl=caa

Example configuration for the main config.json file including a Discord client entry.

```json
{
  "clients": [
    {
      "name": "Discord",
      "enable": true,
      "id": "myDiscordRemote",
      "data": {
        "token": "Ma7XBvzRERK3gQdkX4dkb3OQ.6aaGmJ.rvFiiVrzG4VXHHL3LyhZYhpWdG3Ph_if9aKz5E",
        "applicationId": "8190211179716453570"
      },
      "type": "discord"
    }
  ]
}
```

--------------------------------

### Configure config.json

Source: https://docs.multi-scrobbler.app/configuration/sources/google-cast

Example all-in-one configuration file including a chromecast source definition.

```json
{
"sources": [
{
"name": "My Cast",
"id": "myCast",
"data": {
"blacklistedDevices": [],
"whitelistedDevices": [],
"blacklistedApps": [],
"whitelistedApps": []
},
"type": "chromecast"
}
]
}
```

--------------------------------

### All-in-One Configuration with ListenBrainz

Source: https://docs.multi-scrobbler.app/configuration/clients/listenbrainz

Example of including a ListenBrainz client within the global config.json file.

```json
{
"clients": [
{
"name": "Foxx LZ Client",
"id": "brainzClient",
"enable": true,
"configureAs": "client",
"data": {
"token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
"username": "FoxxMD",
"url": "https://api.listenbrainz.org"
},
"type": "listenbrainz"
}
]
}
```

--------------------------------

### Azuracast URL Path Resolution Examples

Source: https://docs.multi-scrobbler.app/configuration/sources/azuracast

Examples showing how Multi-scrobbler appends the required websocket path to the provided URL.

```text
URL From Config                => MS Uses  
  
'ws://192.168.0.101'                 => ws://192.168.0.101/api/live/nowplaying/websocket  
'ws://azura.mydomain.com'            => ws://azura.mydomain.com.com/api/live/nowplaying/websocket  
'wss://mydomain.com/custom/azura/ws' => wss://mydomain.com/custom/azura/ws
```

--------------------------------

### Native Mode Input Example

Source: https://docs.multi-scrobbler.app/configuration/transforms/musicbrainz

Example of input data for the Native search mode, showing how artist and title strings are structured.

```json
{
    "title": "Endless Possibility (feat. Wheatus)",
    "artists": ["Bowling For Soup & Punk Rock Factory, My Cool Band"]
}

```

--------------------------------

### MusicCast Source Configuration File

Source: https://docs.multi-scrobbler.app/configuration/sources/yamaha-musiccast

Example of a standalone configuration file for a MusicCast source.

```json
[
{
"name": "Livingroom Reciever",
"id": "myYamaha",
"enable": true,
"data": {
"url": "192.168.0.101"
}
}
]
```

--------------------------------

### Example Hostname Change for Spotify/Deezer/LastFM Authentication

Source: https://docs.multi-scrobbler.app/FAQ

This example shows how to update the callback URL for services like Spotify, Deezer, or LastFM when they are not on the same machine as multi-scrobbler. Ensure the web interface is reachable from your browser at the specified address.

```text
EX `http://localhost:9078/lastfm/callback` -> `http://192.168.0.220:9078/lastfm/callback`

```

--------------------------------

### All-in-One Configuration File

Source: https://docs.multi-scrobbler.app/configuration/sources/musikcube

Example JSON configuration for the all-in-one config.json file including a Musikcube source.

```json
{
"sources": [
{
"type": "musikcube",
"enable": true,
"name": "Desktop",
"id": "myMusikcube",
"data": {
"url": "ws://localhost:7905",
"password": "MY_PASSWORD"
}
}
]
}
```

--------------------------------

### Configure chromecast.json

Source: https://docs.multi-scrobbler.app/configuration/sources/google-cast

Example configuration file for a standalone chromecast source.

```json
[
{
"name": "My Cast",
"id": "myCast",
"data": {
"blacklistedDevices": [],
"whitelistedDevices": [],
"blacklistedApps": [],
"whitelistedApps": []
}
}
]
```

--------------------------------

### Native Stage Configuration Example

Source: https://docs.multi-scrobbler.app/configuration/transforms/native

Shows how to configure the Native Stage within a rule, specifying which fields to apply transformations to.

```json
{
    "type": "native",
    // ...
    "title": false, // will not apply any changes to Play title
    "artists": {
      "when": {/* ... */},
    /* ... */
    },
    "album": true // will always apply changes to Play album
}

```

--------------------------------

### Last.fm Client Configuration File

Source: https://docs.multi-scrobbler.app/configuration/clients/lastfm

Example of a standalone configuration file for a Last.fm client.

```json
[
{
"name": "Foxx LFM Client",
"id": "myLastFmClient",
"enable": true,
"configureAs": "client",
"data": {
"apiKey": "a89cba1569901a0671d5a9875fed4be1",
"secret": "ec42e09d5ae0ee0f0816ca151008412a",
"redirectUri": "http://localhost:9078/lastfm/callback"
}
}
]
```

--------------------------------

### All-in-One Kodi Source Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/kodi

Example of a Kodi source definition within the main config.json file.

```json
{
"sources": [
{
"name": "My Kodi Server",
"id": "myKodi",
"enable": true,
"data": {
"url": "http://localhost:8080/jsonrpc",
"username": "myUser",
"password": "myPassword"
},
"type": "kodi"
}
]
}
```

--------------------------------

### VLC Source File Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/vlc

Example JSON configuration for a standalone VLC source file.

```json
[
{
"enable": true,
"id": "myVlc",
"name": "Desktop",
"data": {
"url": "localhost:8080",
"password": "changeme"
}
}
]
```

--------------------------------

### Libre.fm Source File Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/librefm-source

Example JSON configuration for a Libre.fm source file.

```json
[
{
"name": "Foxx Libre Source",
"id": "myLibreFmSource",
"enable": true,
"configureAs": "source",
"data": {
"apiKey": "anything",
"secret": "anything",
"redirectUri": "http://localhost:9078/librefm/callback"
}
}
]
```

--------------------------------

### Discord Client Configuration File

Source: https://docs.multi-scrobbler.app/configuration/clients/discord/discord-headless?artworkUrl=caa

Example configuration for a standalone discord.json file.

```json
[
  {
    "name": "Discord",
    "enable": true,
    "id": "myDiscordRemote",
    "data": {
      "token": "Ma7XBvzRERK3gQdkX4dkb3OQ.6aaGmJ.rvFiiVrzG4VXHHL3LyhZYhpWdG3Ph_if9aKz5E",
      "applicationId": "8190211179716453570"
    }
  }
]
```

--------------------------------

### Naive Mode Stage Configuration

Source: https://docs.multi-scrobbler.app/configuration/transforms/musicbrainz

Configuration example for enabling Naive search artist method within a stage.

```json
// ...
"defaults": {
  // will only search using title/album + naive extracted artists
  "searchOrder": ["artist"],
  "searchArtistMethod": "naive"
  }

```

--------------------------------

### Libre.fm Client JSON Configuration

Source: https://docs.multi-scrobbler.app/configuration/clients/librefm

Example of a standalone configuration file for a Libre.fm client.

```json
[
{
"name": "Foxx Libre Client",
"id": "myLibreFmClient",
"enable": true,
"configureAs": "client",
"data": {
"apiKey": "anything",
"secret": "anything",
"redirectUri": "http://localhost:9078/librefm/callback"
}
}
]
```

--------------------------------

### Configure Multi-Scrobbler via JSON

Source: https://docs.multi-scrobbler.app/installation

Example configuration file structure for defining sources and clients.

```json
{
    "sources": [  
        {  
            "type": "jellyfin",  
            "clients": ["myConfig"],  
            "name": "myJellyfinSource",  
            "data": {  
                "apiKey": "a89cba1569901a0671d5a9875fed4be1",  
                "url": "http://192.168.0.101:8096",  
                "user": "MyUser"  
             }  
        }  
    ],  
    "clients": [  
        {  
            "type": "maloja",  
            "name": "myConfig",  
            "data": {  
                "url": "http://localhost:42010",  
                "apiKey": "myMalojaKey"  
            }  
        }  
    ],  
}  
```

--------------------------------

### Configure Deezer via deezer.json

Source: https://docs.multi-scrobbler.app/configuration/sources/deezer

Example configuration file for the Deezer source located in the CONFIG_DIR.

```json
[
  {
    "name": "DeezerOfficalDeprecated",
    "enable": true,
    "clients": [],
    "data": {
      "clientId": "a89cba1569901a0671d5a9875fed4be1",
      "clientSecret": "ec42e09d5ae0ee0f0816ca151008412a",
      "redirectUri": "http://localhost:9078/deezer/callback",
      "interval": 60
    }
  }
]
```

--------------------------------

### All-in-One Mopidy Configuration Example

Source: https://docs.multi-scrobbler.app/configuration/sources/mopidy

A sample JSON configuration for the all-in-one config.json file, including a Mopidy source definition.

```json
{
"sources": [
{
"name": "Mopidy Desktop",
"id": "MyMopidy",
"enable": true,
"data": {
"url": "localhost",
"uriBlacklist": [],
"uriWhitelist": [],
"albumBlacklist": []
},
"type": "mopidy"
}
]
}
```

--------------------------------

### Musikcube Source Configuration File

Source: https://docs.multi-scrobbler.app/configuration/sources/musikcube

Example JSON configuration for a Musikcube source.

```json
[
{
"type": "musikcube",
"enable": true,
"name": "Desktop",
"id": "myMusikcube",
"data": {
"url": "ws://localhost:7905",
"password": "MY_PASSWORD"
}
}
]
```

--------------------------------

### All-in-One Libre.fm Client Configuration

Source: https://docs.multi-scrobbler.app/configuration/clients/librefm

Example of including a Libre.fm client within the global config.json file.

```json
{
"clients": [
{
"name": "Foxx Libre Client",
"id": "myLibreFmClient",
"enable": true,
"configureAs": "client",
"data": {
"apiKey": "anything",
"secret": "anything",
"redirectUri": "http://localhost:9078/librefm/callback"
},
"type": "librefm"
}
]
}
```

--------------------------------

### VLC All-in-One Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/vlc

Example JSON configuration for including a VLC source within the main config.json file.

```json
{
"sources": [
{
"enable": true,
"id": "myVlc",
"name": "Desktop",
"data": {
"url": "localhost:8080",
"password": "changeme"
},
"type": "vlc"
}
]
}
```

--------------------------------

### All-in-One Configuration with MPRIS

Source: https://docs.multi-scrobbler.app/configuration/sources/mpris

Example of an all-in-one config.json file including an MPRIS source definition.

```json
{
"sources": [
{
"name": "Desktop",
"id": "myMprisUbuntu",
"enable": true,
"data": {
"whitelist": [
"vlc",
"mpd"
],
"blacklist": [
"spotify"
]
},
"type": "mpris"
}
]
}
```

--------------------------------

### Kodi Source JSON Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/kodi

Example of a standalone JSON configuration file for a Kodi source.

```json
[
{
"name": "My Kodi Server",
"id": "myKodi",
"enable": true,
"data": {
"url": "http://localhost:8080/jsonrpc",
"username": "myUser",
"password": "myPassword"
}
}
]
```

--------------------------------

### File-based Configuration Directory Structure

Source: https://docs.multi-scrobbler.app/configuration?cachedThings=metadata

Example directory structure for file-based configuration, where each file corresponds to a specific source or client type.

```text
/CONFIG_DIR
    plex.json
    spotify.json
    maloja.json

```

--------------------------------

### All-in-One Configuration with TealFM Source

Source: https://docs.multi-scrobbler.app/configuration/sources/tealfm-source

An example of an integrated config.json file containing a TealFM source definition.

```json
{
"sources": [
{
"id": "myTealSource",
"name": "Foxx Teal Source",
"configureAs": "source",
"data": {
"identifier": "alice.bsky.social",
"appPassword": "twog-phu7-4dhe-y4j3",
"serviceAllow": [
"plyr"
],
"serviceDeny": [
"last.fm"
]
},
"type": "tealfm"
}
]
}
```

--------------------------------

### ListenBrainz Source File Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/listenbrainz-source

Example JSON configuration for a standalone ListenBrainz source file.

```json
[
{
"name": "Foxx LZ Source",
"id": "brainzSource",
"enable": true,
"configureAs": "source",
"data": {
"token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
"username": "FoxxMD",
"url": "https://api.listenbrainz.org"
}
}
]
```

--------------------------------

### Rocksky Source File Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/rocksky-source

Example of a standalone configuration file for a Rocksky source.

```json
[
{
"id": "myRockskySource",
"name": "FoxxMD Rocksky Source",
"configureAs": "source",
"data": {
"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkaWQiOiJkaWQ6cGxjOng0NjVwZmtyeW5zaDZ...",
"handle": "alice.bsky.social"
}
}
]
```

--------------------------------

### ListenBrainz Endpoint Source Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/listenbrainz-endpoint

Example JSON configuration for an endpointlz source file.

```json
[
{
"name": "LZ for Navidrome",
"id": "myLzNavidrome",
"enable": true,
"data": {
"token": "myToken"
}
}
]
```

--------------------------------

### Maloja Client File Configuration

Source: https://docs.multi-scrobbler.app/configuration/clients/maloja

Example JSON configuration for a standalone Maloja client file.

```json
[
{
"name": "Maloja Client",
"id": "myMalojaClient",
"enable": true,
"configureAs": "client",
"data": {
"url": "http://localhost:42010",
"apiKey": "myMalojaKey"
}
}
]
```

--------------------------------

### Azuracast Source File Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/azuracast

Example of a standalone JSON configuration file for an Azuracast source.

```json
[
{
"type": "azuracast",
"enable": true,
"name": "Cool Station",
"id": "myAzura",
"data": {
"url": "ws://192.168.0.101",
"station": "my-station-name",
"monitorWhenLive": true,
"monitorWhenListeners": 1
}
}
]
```

--------------------------------

### All-in-One Koito Client Configuration

Source: https://docs.multi-scrobbler.app/configuration/clients/koito

Example of including a Koito client within the main config.json file.

```json
{
"clients": [
{
"name": "Koito Client A",
"id": "myKoitoClient",
"configureAs": "client",
"data": {
"token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
"username": "admin",
"url": "http://192.168.0.100:4110"
},
"type": "koito"
}
]
}
```

--------------------------------

### Native Mode Stage Configuration

Source: https://docs.multi-scrobbler.app/configuration/transforms/musicbrainz

Configuration example for enabling Native search artist method within a stage.

```json
// ...
"defaults": {
  // will only search using title/album + native extracted artists
  "searchOrder": ["artist"],
  "searchArtistMethod": "native"
  }

```

--------------------------------

### MPD Source JSON Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/mpd

Example JSON configuration for an MPD source file.

```json
[
{
"enable": true,
"id": "myMPD",
"name": "Desktop",
"data": {
"url": "192.168.0.100:6600",
"password": "MY_PASSWORD"
},
"options": {
"disableDiscovery": false
}
}
]
```

--------------------------------

### ListenBrainz Client File Configuration

Source: https://docs.multi-scrobbler.app/configuration/clients/listenbrainz

Example of a standalone JSON configuration file for a ListenBrainz client.

```json
[
{
"name": "Foxx LZ Client",
"id": "brainzClient",
"enable": true,
"configureAs": "client",
"data": {
"token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
"username": "FoxxMD",
"url": "https://api.listenbrainz.org"
}
}
]
```

--------------------------------

### Icecast Source File Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/icecast

Example of a standalone JSON configuration file for an Icecast source.

```json
[
{
"name": "Station 1",
"enable": true,
"id": "myIceStation1",
"data": {
"url": "http://myIcecast.com/radio"
}
}
]
```

--------------------------------

### All-in-One Configuration File

Source: https://docs.multi-scrobbler.app/configuration/sources/youtube-music

Example JSON configuration for the main config.json file including a ytmusic source definition.

```json
{
"sources": [
{
"id": "myYtMusic",
"name": "Foxx YT Music",
"enable": true,
"clients": [],
"data": {
"cookie": "__Secure-1PSIDTS=sidts-CjEB3EgAEvCd-......",
"clientId": "891098404....apps.googleusercontent.com",
"clientSecret": "GOCS..."
},
"options": {
"logDiff": true
},
"type": "ytmusic"
}
]
}
```

--------------------------------

### Maloja Source File Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/maloja

Example JSON configuration for a standalone Maloja source file.

```json
[
{
"name": "Maloja Source",
"id": "myMalojaSource",
"enable": true,
"configureAs": "source",
"data": {
"url": "http://localhost:42010",
"apiKey": "myMalojaKey"
}
}
]
```

--------------------------------

### Mopidy Server Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/mopidy

Example configuration snippet for the Mopidy server's HTTP settings.

```ini
[http]  
hostname = localhost  
port = 6680  
```

--------------------------------

### Koito Client JSON Configuration

Source: https://docs.multi-scrobbler.app/configuration/clients/koito

Example of a standalone koito.json configuration file for a Koito client.

```json
[
{
"name": "Koito Client A",
"id": "myKoitoClient",
"configureAs": "client",
"data": {
"token": "029b081ba-9156-4pe7-88e5-3be671f5ea2b",
"username": "admin",
"url": "http://192.168.0.100:4110"
}
}
]
```

--------------------------------

### Start Maloja Container

Source: https://docs.multi-scrobbler.app/configuration/clients/maloja

Command to start the Maloja container in detached mode.

```bash
docker compose up -d  
```

--------------------------------

### Configure Sonos source in JSON

Source: https://docs.multi-scrobbler.app/configuration/sources/sonos

Example configuration for the Sonos source, including debug logging options for troubleshooting.

```json
[
  {
    "enable": true,
    "name": "MySonos",
    "data": {
      "host": "192.168.0.150"
    },
    "options": {
      "logFilterFailure": "warn",
      "logPayload": true
    }
  }
]
```

--------------------------------

### Album Blacklist Example Data

Source: https://docs.multi-scrobbler.app/configuration/sources/mopidy

Example of how track data is represented before and after applying the album blacklist.

```text
Album: Soundcloud, Track: My Cool Track, Artist: A Cool Artist  
```

```text
Track: My Cool Track, Artist: A Cool Artist  
```

--------------------------------

### Spotify Source JSON Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/spotify?spotifyRedirect=echo

Example configuration for a standalone spotify.json file defining the source properties and credentials.

```json
[
{
"id": "MySpotify",
"name": "Foxx Spotify",
"enable": true,
"clients": [],
"data": {
"clientId": "a89cba1569901a0671d5a9875fed4be1",
"clientSecret": "ec42e09d5ae0ee0f0816ca151008412a",
"redirectUri": "http://localhost:9078/callback",
"interval": 60
}
}
]
```

--------------------------------

### Plex Source Configuration Example

Source: https://docs.multi-scrobbler.app/configuration/sources/plex

A sample JSON configuration for a Plex source, demonstrating the required structure for authentication, connectivity, and filtering rules.

```json
{
"sources": [
{
"name": "Foxx Plex",
"id": "MyPlexApi",
"enable": true,
"clients": [],
"data": {
"token": "1234",
"url": "http://192.168.0.120:32400",
"usersAllow": [
"FoxxMD",
"SomeOtherUser"
],
"usersBlock": [
"AnotherUser"
],
"devicesAllow": [
"firefox"
],
"devicesBlock": [
"google-home"
],
"librariesAllow": [
"GoodMusic"
],
"librariesBlock": [
"BadMusic"
]
},
"options": {

```

--------------------------------

### Deezer Source File Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/deezer

Example JSON structure for a standalone Deezer source configuration file.

```json
[
{
"name": "Family Account",
"id": "myDeezerId",
"enable": true,
"clients": [],
"data": {
"arl": "UOsRPjT3U5Dhaaup3xQ30DWFoSgqugdSYzL3QE743waaVy2eur2ckyJcZ4RV123Q3PsbKXkLwA6ahc9XmEfev6BtfSP8LujE3JswWRQogZCDUOwVzWO5sAig"
}
}
]
```

--------------------------------

### Last.fm Source File Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/lastfm-source

Example JSON configuration for a Last.fm source defined in a standalone file.

```json
[
{
"name": "Foxx LFM Source",
"id": "myLastFmSource",
"enable": true,
"configureAs": "source",
"data": {
"apiKey": "a89cba1569901a0671d5a9875fed4be1",
"secret": "ec42e09d5ae0ee0f0816ca151008412a",
"redirectUri": "http://localhost:9078/lastfm/callback"
}
}
]
```

--------------------------------

### Artwork URL Validation Examples

Source: https://docs.multi-scrobbler.app/configuration/clients/discord/discord-headless

Examples of URL validation logic based on protocol and service trust.

```text
http://foobar.com/cool.jpg <-- NOT allowed, not http  
http://192.168.0.112/fun.png <-- NOT allowed, not http
```

```text
https://archive.org/download/dir/myimage.jpg <-- allowed, is https and known service  
https://spotify.com/assets/cover.png?size=1000 <-- allowed, is https and known service  
https://example.com/cool.jpg <-- NOT allowed, is https but not a known service and DISCORD_ARTWORK is not set  
https://anything.com/neat.jpg <-- NOT allowed, is https but not a known service and DISCORD_ARTWORK is not set
```

```text
https://archive.org/my/dir/myimage.jpg <-- allowed, is https and known service  
http://foobar.com/cool.jpg <-- NOT allowed, not http  
https://example.com/cool.jpg <-- allowed, is https  
https://anything.com/neat.jpg <-- allowed, is https
```

```text
https://archive.org/my/dir/myimage.jpg <-- allowed, is https and known service  
http://foobar.com/cool.jpg <-- NOT allowed, not http  
https://example.com/cool.jpg <-- NOT allowed, is https but does not contain "mycdn" or "jellyfin"  
https://jellyfin.mydomain.com/neat.jpg <-- allowed, is https and contains "jellyfin"
```

--------------------------------

### Score Refinement Configuration

Source: https://docs.multi-scrobbler.app/configuration/transforms/musicbrainz

Example configuration for setting a minimum score threshold for MusicBrainz search matches.

```json
{
  // ...
  "score": 90 // matches must score 90 or higher to be considered
}

```

--------------------------------

### JRiver Source File Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/jriver

Example JSON structure for a standalone JRiver source configuration file.

```json
[
{
"name": "My JRiver Server",
"id": "myRiver",
"enable": true,
"data": {
"url": "0.0.0.0",
"username": "auser",
"password": "apassword"
}
}
]
```

--------------------------------

### All-in-One Configuration with Subsonic Source

Source: https://docs.multi-scrobbler.app/configuration/sources/subsonic

Example of a config.json file containing a Subsonic source definition within the sources array.

```json
{
"sources": [
{
"id": "mySubsonic",
"name": "Airsonic Server",
"enable": true,
"data": {
"url": "http://localhost:4040/airsonic",
"user": "yourUser",
"password": "yourPassword",
"usersAllow": [
"yourUser"
],
"detectStaleNowPlayingFromMinutesAgo": true
},
"type": "subsonic"
}
]
}
```

--------------------------------

### Configure Deezer via config.json

Source: https://docs.multi-scrobbler.app/configuration/sources/deezer

Example configuration structure for the Deezer source within the main config.json file.

```json
{
  "sources": [
    {
      "name": "DeezerOfficalDeprecated",
      "enable": true,
      "clients": [],
      "data": {
        "clientId": "a89cba1569901a0671d5a9875fed4be1",
        "clientSecret": "ec42e09d5ae0ee0f0816ca151008412a",
        "redirectUri": "http://localhost:9078/deezer/callback",
        "interval": 60
      },
      "type": "deezer"
    }
  ]
}
```

--------------------------------

### Maloja All-in-One Configuration

Source: https://docs.multi-scrobbler.app/configuration/clients/maloja

Example JSON configuration for including a Maloja client within the main config.json file.

```json
{
"clients": [
{
"name": "Maloja Client",
"id": "myMalojaClient",
"enable": true,
"configureAs": "client",
"data": {
"url": "http://localhost:42010",
"apiKey": "myMalojaKey"
},
"type": "maloja"
}
]
}
```

--------------------------------

### TealFM Client File Configuration

Source: https://docs.multi-scrobbler.app/configuration/clients/tealfm

Example JSON structure for a standalone TealFM client configuration file.

```json
[
{
"id": "myTealClient",
"name": "Foxx Teal Client",
"configureAs": "client",
"data": {
"identifier": "alice.bsky.social",
"appPassword": "twog-phu7-4dhe-y4j3"
}
}
]
```

--------------------------------

### Sonos Source Configuration Example

Source: https://docs.multi-scrobbler.app/configuration/sources/sonos

A sample JSON configuration for a Sonos source, demonstrating how to enable the source and filter specific devices and groups.

```json
{
"sources": [
{
"enable": true,
"id": "MySonos",
"name": "Boom 2",
"data": {
"host": "192.168.0.150",
"devicesAllow": [
"move",
"beam"
],
"devicesBlock": [
"roam"
],
"groupsAllow": [
"family"
],
"groupsBlock": [
"bedroom"
]
},
"type": "sonos"
}
]
}
```

--------------------------------

### Maloja All-in-One Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/maloja

Example JSON configuration for including a Maloja source within the main config.json file.

```json
{
"sources": [
{
"name": "Maloja Source",
"id": "myMalojaSource",
"enable": true,
"configureAs": "source",
"data": {
"url": "http://localhost:42010",
"apiKey": "myMalojaKey"
},
"type": "maloja"
}
]
}
```

--------------------------------

### Authentication Error Log Example

Source: https://docs.multi-scrobbler.app/configuration/sources/youtube-music

Example of the error message displayed when authentication is required via the device code flow.

```text
ERROR: Sign in with the code 'CLV-KFA-BVKY' using the authentication link on the dashboard or https://www.google.com/device  
```

--------------------------------

### User Stage Configuration Example

Source: https://docs.multi-scrobbler.app/configuration/transforms/user

Defines a User Stage transformer with default rules for cleaning titles and artist names.

```json
{
  // ...
  "transformers": [
    {
      "type": "user",
      "name": "Normalizer",
      "defaults": {
        "title": [
          "(Album Version)"
        ],
        "artists": [
            "Various Artists"
        ]
      }
    }
  ]
}
```

--------------------------------

### Run Setup Script for Flatpak Build

Source: https://docs.multi-scrobbler.app/development/flatpak

Automates generating offline sources and building the Flatpak app. Use the -o flag to overwrite existing sources, -b to specify the build directory, and -y to confirm settings automatically.

```bash
./setup.sh -o -b /path/to/flatpak/build/dir
```

--------------------------------

### JRiver All-in-One Configuration

Source: https://docs.multi-scrobbler.app/configuration/sources/jriver

Example JSON structure for including a JRiver source within the main config.json file.

```json
{
"sources": [
{
"name": "My JRiver Server",
"id": "myRiver",
"enable": true,
"data": {
"url": "0.0.0.0",
"username": "auser",
"password": "apassword"
},
"type": "jriver"
}
]
}
```

--------------------------------

### Naive Mode Resulting Data Example

Source: https://docs.multi-scrobbler.app/configuration/transforms/musicbrainz

Example of the data structure after the Naive mode has processed the input, showing only the first extracted artist.

```json
{
    "title": "Endless Possibility (feat. Wheatus)",
    "artists": ["Bowling For Soup"]
}

```

--------------------------------

### Native Mode Resulting Data Example

Source: https://docs.multi-scrobbler.app/configuration/transforms/musicbrainz

Example of the data structure after the Native mode has processed the input, with artists extracted and title cleaned.

```json
{
    "title": "Endless Possibility",
    "artists": ["Bowling For Soup", "Punk Rock Factory", "My Cool Band", "Wheatus"]
}

```

--------------------------------

### Configure Navidrome ListenBrainz.BaseURL

Source: https://docs.multi-scrobbler.app/quickstart

Set the ListenBrainz.BaseURL in your Navidrome installation's environment variables to point to the Multi Scrobbler instance. This assumes a Docker installation.

```yaml
- ND_LISTENBRAINZ_BASEURL=http://192.168.0.100:9078/1/  

```

--------------------------------

### Example Environmental Variables for Interpolation

Source: https://docs.multi-scrobbler.app/configuration?cachedThings=metadata

Illustrates how environmental variables can be set, for example, within a Docker Compose `environment` section, to provide values for secrets interpolation.

```bash
MY_APIKEY=a89cba1569901a0671d5a9875fed4be1
MY_SECRET=ec42e09d5ae0ee0f0816ca151008412a

```

--------------------------------

### Example Hostname Change for Webscrobbler

Source: https://docs.multi-scrobbler.app/FAQ

This example demonstrates how to change the callback URL from 'localhost' to a specific IP address when the Webscrobbler source is not running on the same server as multi-scrobbler.

```text
EX `http://localhost:9078/api/webscrobbler` -> `http://192.168.0.140:9078/api/webscrobbler`

```

--------------------------------

### Component Configuration Interface Example

Source: https://docs.multi-scrobbler.app/development/dev-common

An example TypeScript interface defining the minimum shape for a Component's configuration. It includes required 'name' and optional 'data' and 'options' objects.

```typescript
interface MyConfig {
  name: string
  data?: object
  options?: object
}
```

--------------------------------

### Example Scrobble Data for BasicOrIds Search

Source: https://docs.multi-scrobbler.app/configuration/transforms/musicbrainz

An example of scrobble data structure that would be used with the 'basicOrIds' search method. It shows how album MBID and album name are provided.

```json
{
    "title": "Endless Possibility (feat. Wheatus)",
    "artists": ["Bowling For Soup"]
    "albumMbid": "c9f91cdc-984e-4303-9a51-4ac0dfa2348f",
    "album": "My Cool Album"
}

```

--------------------------------

### Configure Musicbrainz in AIO Config (Full Source)

Source: https://docs.multi-scrobbler.app/configuration/sources/plex

Example showing both the transformer definition and the source configuration within a single AIO config.json file.

```json
{
  // ...
  "transformers": [
    {
      "type": "musicbrainz",
      "name": "MyMB",
      "data": {
        "apis": [
          {
            // a real email that Musicbrainz can use to contact you in case of issues
            "contact": "myEmail@myEmailProvider.com"
          }
        ]
      }
    }
  ]
  // ...
  "sources": [
    // ...
    { 
      "name": "MyPlex",
      "type": "plex",
      "data": { /* ... */},
      "options": {
        "playTransform": {
          "preCompare": [
            {
              "type": "musicbrainz",
              "name": "MyMB",
              "searchOrder": ["mbidrecording", "basicOrIds", "basic"]
            }
          ]
        }
      }
    }
  ]
}
```

--------------------------------

### Manage Systemd User Service

Source: https://docs.multi-scrobbler.app/installation/service

Commands to reload the systemd daemon, enable the Multi-Scrobbler service to start on login, and start the service immediately. These commands should be run after creating and configuring the service file.

```bash
systemctl daemon-reload
systemctl --user enable multi-scrobbler.service
systemctl --user start multi-scrobbler.service
```

--------------------------------

### Word-Order Invariant Text Similarity Example 2

Source: https://docs.multi-scrobbler.app/configuration/duplicates

Shows another example of word-order invariant text similarity, highlighting how reordering tokens and using similarity algorithms can match disparate strings.

```text
String A: you, doin hwat are  => you doin hwat are  
String B: what are you doing  => you doing what are  
```

--------------------------------

### Update with Git

Source: https://docs.multi-scrobbler.app/updating

If you installed Multi-Scrobbler using git, pull the latest changes and restart the application.

```bash
git pull
```
Tokens:
Raw