Skip to content

Quickstart

This guide will get you up and running with multi-scrobbler using Docker and docker compose. At the end of the guide you will have:

  • the dashboard served on port 9078 of a host machine which has a URL of
  • data saved to the same directory as the docker-compose.yml file
  • multi-scrobbler monitoring Spotify, Jellyfin, Navidrome, Plex, and/or Last.fm for listening activity
  • multi-scrobbler scrobbling to Lastfm, Maloja, and/or Koito

Create a new folder for your multi-scrobbler installation and inside it create a folder for config/data files.

/home/yourUser
$ mkdir ~/msData1
$ mkdir ~/msData/config2
  1. 1.project folder
  2. 2.folder used for config/data

If you are running docker on a Linux host, determine your UID/GID using these commands:

Terminal window
$ id -u
10001
$ id -g
10012
  1. 1.UID
  2. 2.GID

Create a docker-compose.yml in with this content:

~/msData/docker-compose.yml
services:
multi-scrobbler:
image: foxxmd/multi-scrobbler
container_name: multi-scrobbler
user: 1000:10011
environment:
- TZ=Etc/GMT2
- BASE_URL=http://YOUR_MS_DOMAIN:90783
# all Environmental Variables in below examples go here!
volumes:
- "./config:/config"4
ports:
- "9078:9078"
restart: unless-stopped
  1. 1.UID:GID retrieved in the first section, used for file/folder ownership on Linux hosts
  2. 2.Specify timezone from TZ Database TZ identifier
  3. 3.Base URL is the URL that Multi-Scrobbler will be accessed from in a browser
  4. 4../config is the directory created in the first section, needed for storing db and auth data

Sources are the services/music players multi-scrobbler monitors to look for listening activity.

Follow the Jellyfin configuration instructions for setting up an API Key.

Then, add these values to the environment section in the docker-compose.yml you created.

~/msData/docker-compose.yml
- JELLYFIN_URL=192.168.0.110:80961
- JELLYFIN_APIKEY=c9fae8756fbf481ebd9c5bb56b2
- JELLYFIN_USER=MyUser3
- JELLYFIN_ID=myJellyin
  1. 1.URL to Jellyfin UI
  2. 2.Api Key created in previous step
  3. 3.Your username in Jellyfin

Correct Scrobbles with Musicbrainz Optional

Section titled “Correct Scrobbles with Musicbrainz Optional ”

Multi-scrobbler can use Musicbrainz to match activity from your Sources in order to fill in missing data, or correct/normalize existing data, before it is scrobbled to the Clients below. This step is optional.

Musicbrainz Setup Instructions

Configure Musicbrainz API

Add these value to the environment section in the docker-compose.yml you created.

~/msData/docker-compose.yml
- MB_PRESETS=default,sensible,native1
  1. 1.how musicbrainz searches and selects matches: isrc => then tries basic text fields => then tries extracted artists

Presets are found here.

Enable Musicbrainz For A Source

Musicbrainz can be enabled for multiple Sources. Follow the directions in each tab to enable it for that Source.

Add this value to the environment section in the docker-compose.yml you created.

~/msData/docker-compose.yml
- JELLYFIN_TRANSFORMS=musicbrainz

Clients are services that store scrobbles. Multi-scrobbler will scrobble all listening activity from the Sources you configured to all Clients you configure here.

Setup a Koito server if you have not already done this.

  • Create (or get) an API Key
    • From your Koito server dashboard navigate to Settings (bottom-left icon) => API Keys
    • Create a new Key (or use an existing) and Copy the key using the copy icon to the right of the key
      • EX pM195xPV98CDpk0QW47FIIOR8AKATAX5DblBF-Jq0t1MbbKL
  • Take note of your Koito username (used below as )
  • Determine your Koito URL
    • This is the URL you use to access your Koito dashboard OR whatever URL is accessible from your multi-scrobbler instance.
    • EX dashboard at http://192.168.0.100:4110 => replace below with http://192.168.0.100:4110
    • More info on the URL to use is the full docs

Add/Substitute values above into these examples values and add them to the environment section in the docker-compose.yml you created for multi-scrobbler earlier.

~/msData/docker-compose.yml
- KOITO_TOKEN=myToken
- KOITO_USER=myUser
- KOITO_URL=myURL
- KOITO_ID=myKoito

From the same directory as the docker-compose.yml you created earlier start the container:

~/msData
docker compose up -d

You’re done! Multi-scrobbler is now running. It will monitor the sources you configured and scrobble to clients you set up.

Visit to see the dashboard where

  • configured Sources/Clients
    • show current status and authentication options
    • display statistics about discovered/scrobbled tracks and Now Playing status
  • a real-time log shows multi-scrobbler’s activity