--- title: Quickstart sidebar: order: 2 --- import {LocalStorageText} from '@site/src/components/Storage/Text'; import { Badge } from '@astrojs/starlight/components'; import Handle from "@site/src/components/snippets/_atmosphere_id.mdx"; This guide will get you up and running with multi-scrobbler using [Docker](https://www.docker.com/) and [`docker compose`](https://docs.docker.com/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](/configuration/sources/spotify), [Jellyfin](/configuration/sources/jellyfin), Navidrome, [Plex](/configuration/sources/plex), and/or [Last.fm](/configuration/sources/lastfm-source) for listening activity * multi-scrobbler scrobbling to [Lastfm](/configuration/clients/lastfm), [Maloja](/configuration/clients/maloja), and/or [Koito](/configuration/clients/koito) :::note If the multi-scrobbler container is on the same machine you will be viewing the dashboard from (IE `localhost`) you can remove and ignore `BASE_URL` usage below. Additionally, replace usage of with `http://localhost:9078`. ::: ## Create Folders and Get User ID Create a new folder for your multi-scrobbler installation and inside it create a folder for config/data files. ```shell title="/home/yourUser" placeholder="~/msData" $ mkdir ~/msData #[!ref] project folder $ mkdir ~/msData/config #[!ref] folder used for config/data ``` If you are running docker on a Linux host, determine your UID/GID using these commands: ```shell placeholder="1000,1001" $ id -u 1000 #[!ref] UID $ id -g 1001 #[!ref] GID ``` ## Create Docker Compose File Create a `docker-compose.yml` in with this content: ```yaml title="~/msData/docker-compose.yml" placeholder="http://YOUR_MS_DOMAIN:9078,1000,1001" services: multi-scrobbler: image: foxxmd/multi-scrobbler container_name: multi-scrobbler user: 1000:1001 # [!ref] UID:GID retrieved in the first section, used for [file/folder ownership](/installation#user-and-permission) on Linux hosts environment: - TZ=Etc/GMT # [!ref] Specify timezone from [TZ Database **TZ identifier**](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) - BASE_URL=http://YOUR_MS_DOMAIN:9078 # [!ref] [**Base URL**](/configuration#base-url) is the URL that Multi-Scrobbler will be accessed from in a browser # all Environmental Variables in below examples go here! volumes: - "./config:/config" # [!ref] `./config` is the directory created in the first section, needed for storing db and auth data ports: - "9078:9078" restart: unless-stopped ``` ## Setup Sources [**Sources**](/configuration/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**.](/configuration/sources/jellyfin) Then, add these values to the `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file) ```yaml title="~/msData/docker-compose.yml" - JELLYFIN_URL=192.168.0.110:8096 # [!ref] URL to Jellyfin UI - JELLYFIN_APIKEY=c9fae8756fbf481ebd9c5bb56b # [!ref] Api Key created in previous step - JELLYFIN_USER=MyUser # [!ref] Your username in Jellyfin - JELLYFIN_ID=myJellyin ``` To access your Spotify activity you must [create a Spotify App](https://developer.spotify.com/dashboard) to get a **Client ID/Secret** and set a valid **Redirect URI**. Refer to the [Spotify Authentication instructions in the docs.](/configuration/sources/spotify#authenticate-spotify-with-multi-scrobbler) Assuming you used the **HTTPS** method for your **Redirect URI** from the instructions above...after the application is created add these values to the `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file) ```yaml title="~/msData/docker-compose.yml" placeholder="http://YOUR_MS_DOMAIN:9078" - SPOTIFY_CLIENT_ID=yourClientId - SPOTIFY_CLIENT_SECRET=yourClientSecret - SPOTIFY_REDIRECT_URI=http://YOUR_MS_DOMAIN:9078/callback - SPOTIFY_ID=mySpotify ``` Later, after [starting multi-scrobbler](#start-multi-scrobbler), visit the dashboard at and click **(Re)authenticate** on the Spotify card to authorize multi-scrobbler to use your account. Monitoring will begin automatically after authorization is complete. Navidrome supports [scrobbling using Listenbrainz](https://www.navidrome.org/docs/usage/scrobbling/#listenbrainz). You should use this, rather than a [Subsonic Source](/configuration/sources/subsonic) because Navidrome's internal scrobbling functionality supports providing multiple artists and offline scrobbling while the Subsonic Source does not. To setup Navidrome to scrobble to multi-scrobbler via the Listenbrainz option: #### Create Listenbrainz Endpoint Source Create a new [Listenbrainz Endpoint](/configuration/sources/listenbrainz-endpoint) [Source](/configuration/sources) in multi-scrobbler by creating a token to use with the endpoint via [ENV Config](/configuration?configType=env#configuration-types) in `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file) ```yaml title="~/msData/docker-compose.yml" - LZE_TOKEN=myCoolToken - LZE_ID=navidromeLZ ``` The token can be anything. [(Re)start multi-scrobbler](#start-multi-scrobbler) after making this change. #### Configure Navidrome Set the [**ListenBrainz.BaseURL**](https://www.navidrome.org/docs/usage/configuration-options/#advanced-configuration) (env `ND_LISTENBRAINZ_BASEURL`) to in your Navidrome installation. Assuming you are using the [docker installation](https://www.navidrome.org/docs/installation/docker/), modify `environment` to add: ```yaml title="docker-compose.yml" placeholder="http://YOUR_MS_DOMAIN:9078" - ND_LISTENBRAINZ_BASEURL=http://YOUR_MS_DOMAIN:9078/1/ ``` Restart Navidrome after making this change. Then, [follow the directions for enabling Listenbrainz scrobbling in Navidrome](https://www.navidrome.org/docs/usage/scrobbling/#listenbrainz). The **Listenbrainz user token** is the token you created for `LZE_TOKEN` earlier. Find your [**Plex Token**](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/) and make note of the **URL** and **Port** used to connect to your Plex instance. Add these values to the `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file) ```yaml title="~/msData/docker-compose.yml" - PLEX_URL=http://192.168.0.101:32400 - PLEX_TOKEN=6c0ihz8j7__f5r18oa0zm8 - PLEX_ID=myPlex # [!ref] optional, restrict scrobbling to a list of comma-delimited users #- PLEX_USERS_ALLOW=myPlexUsername ``` [Restart multi-scrobbler](#start-multi-scrobbler) to create the new Source. You may wish to refer to the [User and Library defaults/filtering](/configuration/sources/plex) in the Plex Source docs for a more granular setup. [**Last.fm is ending free API Keys!**](/configuration/clients/lastfm) If you are already scrobbling to Last.fm and wish to mirror your scrobbling activity to one or more other [Clients](#setup-clients), use this Source. If, instead, you want to scrobble **from** multi-scrobbler **to** Last.fm then see the Last.fm tab in the [Setup Clients](#setup-clients) section below. [Register for an API account at Last.fm.](https://www.last.fm/api/account/create) Use the following for **Callback URL**: ```text placeholder="http://YOUR_MS_DOMAIN:9078" http://YOUR_MS_DOMAIN:9078/lastfm/callback ``` After account creation make note of the **Api Key** and **Secret** that are displayed. Add these values to the `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file) ```yaml title="~/msData/docker-compose.yml" placeholder="http://YOUR_MS_DOMAIN:9078" - SOURCE_LASTFM_API_KEY=MY_API_KEY_PLACEDHOLDER - SOURCE_LASTFM_SECRET=MY_SECRET_PLACEHOLDER - SOURCE_LASTFM_REDIRECT_URI=http://YOUR_MS_DOMAIN:9078/lastfm/callback - SOURCE_LASTFM_ID=myLFMSource ``` Later, after [starting multi-scrobbler](#start-multi-scrobbler), visit the dashboard at and click **(Re)authenticate** on the **Last.fm (Source)** card to authorize multi-scrobbler to use your account. Monitoring will begin automatically after authorization is complete. ## Correct Scrobbles with Musicbrainz :badge[Optional]{variant="note"} Multi-scrobbler can use [Musicbrainz](https://musicbrainz.org/) to match activity from your Sources in order to [fill in missing data](/configuration/transforms/musicbrainz), or correct/normalize existing data, before it is scrobbled to the [Clients](#setup-clients) below. This step is optional.
Musicbrainz Setup Instructions

Configure Musicbrainz API

:::note **This step only needs to be performed once** regardless of how many Sources you want to use Musicbrainz for. ::: Add these value to the `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file) ```yaml title="~/msData/docker-compose.yml" # [!ref] how musicbrainz searches and selects matches: isrc => then tries basic text fields => then tries extracted artists - MB_PRESETS=default,sensible,native ``` **Presets** are found [here](/configuration/transforms/musicbrainz/#env-configuration).

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.](#create-docker-compose-file) ```yaml title="~/msData/docker-compose.yml" - JELLYFIN_TRANSFORMS=musicbrainz ``` Add this value to the `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file) ```yaml title="~/msData/docker-compose.yml" - SPOTIFY_TRANSFORMS=musicbrainz ``` Add this value to the `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file) ```yaml title="~/msData/docker-compose.yml" - LZE_TRANSFORMS=musicbrainz ``` Add this value to the `environment` section in the [`docker-compose.yml` you created.](#create-docker-compose-file) ```yaml title="~/msData/docker-compose.yml" - PLEX_TRANSFORMS=musicbrainz ``` Modify the `lastfm.json` file you created in the [Setup Sources](#setup-sources) step to add the highlighted section in the example below. The comma at the top highlighted section is important! ```json title="~/msData/config/lastfm.json" placeholder="http://YOUR_MS_DOMAIN:9078" [ { "name": "myLastFmSource", "configureAs": "source", "data": { "apiKey": "MY_API_KEY_PLACEDHOLDER", "secret": "MY_SECRET_PLACEHOLDER", "redirectUri": "http://YOUR_MS_DOMAIN:9078/lastfm/callback" // [!code highlight:8] }, "options": { "playTransform": { "preCompare": { "type": "musicbrainz" } } } } ] ```
## Setup Clients [**Clients**](/configuration/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](https://koito.io/guides/installation/) if you have not already done this. * [Create (or get) an API Key](https://koito.io/guides/scrobbler/) * From your Koito server dashboard navigate to **Settings** (bottom-left icon) => **API Keys** * Create a new Key (or use an existing) and Copy the key using the copy icon to the right of the key * EX `pM195xPV98CDpk0QW47FIIOR8AKATAX5DblBF-Jq0t1MbbKL` * Take note of your Koito username (used below as ) * 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](/configuration/clients/koito) 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.](#create-docker-compose-file) ```yaml placeholder="myToken,myUser,myURL" title="~/msData/docker-compose.yml" - KOITO_TOKEN=myToken - KOITO_USER=myUser - KOITO_URL=myURL - KOITO_ID=myKoito ``` :::tip For Koito versions `<=0.1.7`, you must have the environment variable `KOITO_ALLOWED_HOSTS` set correctly in your Koito environment/container. Ensure it is set to the IP address or domain name that you use to access Koito with e.g. `koito.mydomain.com`. ::: [**teal.fm**](https://teal.fm/) is a social discovery and browsing app for scrobbles stored in your [**Atmosphere Account**](https://atmosphereaccount.com/). Navigate to the Account settings for your Atmosphere account on your respective PDS and create a new **App Password**. If you don't know what a PDS is or how to find this, just use Bluesky: * Sign in to [Bluesky](https://bsky.app) with your Atmosphere Account * Navigate to https://bsky.app/settings/app-passwords * Settings -> Privacy and Security -> App passwords * Create a new **App Password** and save it somewhere, it will not be shown again 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.](#create-docker-compose-file) ```yaml placeholder="myToken,alice.bsky.social,xxxx-xxxx-xxxx-xxxx" title="~/msData/docker-compose.yml" - TEALFM_ID=myTeal - TEALFM_IDENTIFIER=alice.bsky.social - TEALFM_APP_PW=xxxx-xxxx-xxxx-xxxx ``` Setup a [Maloja server](https://github.com/krateng/maloja?tab=readme-ov-file#how-to-install) if you have not already done this.
Maloja Setup Intructions Using Maloja's example `docker-compose.yml`: Uncomment `environment` and add `MALOJA_FORCE_PASSWORD=CHANGE_ME` to set an admin password Start the container: ```shell title="~/malojaData" docker compose up -d ```
* Navigate to the Admin Panel (Cog in upper-right corner) -> API Keys (or at http://192.168.0.100:42010/admin_apikeys) * Create a **New Key** and then copy the generated key value Finally, add these values to the `environment` section in the [`docker-compose.yml` you created for multi-scrobbler earlier.](#create-docker-compose-file) ```yaml title="~/msData/docker-compose.yml" - MALOJA_URL=http://192.168.0.100:42010 - MALOJA_API_KEY=myApiKey - MALOJA_ID=myMaloja ```
[**Last.fm is ending free API Keys!**](/configuration/clients/lastfm) [Register for an API account at Last.fm.](https://www.last.fm/api/account/create) Use the following for **Callback URL**: ```text placeholder="http://YOUR_MS_DOMAIN:9078" http://YOUR_MS_DOMAIN:9078/lastfm/callback ``` After account creation use the displayed information and add these values to the `environment` section in the [`docker-compose.yml` you created for multi-scrobbler earlier.](#create-docker-compose-file) ```yaml title="~/msData/docker-compose.yml" - LASTFM_API_KEY=myApiKey - LASTFM_SECRET=myApiSecret - LASTFM_ID=myLfmClient ```
## Start Multi-Scrobbler :::tip If you are running your multi-scrobbler container on a Linux host see [these instructions for setting proper file permissions.](/installation?dockerSetting=linuxHost#recommended-settings) ::: From the same directory as the [`docker-compose.yml` you created earlier](#create-docker-compose-file) start the container: ```shell title="~/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 ## Next Steps * **[Secure your Multi-Scrobbler instance](/security/overview)** * See more advanced docker options as well as other install methods in the [**Installation**](/installation#docker) docs * Setup [secondary caching](/configuration#secondary-caching) with [valkey](/installation?dockerSetting=caching#recommended-settings) for increased performance and reduced memory usage * Review the [**Configuration**](/configuration) docs * Learn about how to configure multi-scrobbler using files for more complicated Source/Client scenarios * See all available [**Sources**](/configuration/sources) and [**Clients**](/configuration/clients) alongside configuration examples * Learn how to set up [notification webhooks](/configuration#webhook-configurations) * Check out the [kitchensink example](/configuration/kitchensink) * Setup [Scrobble Enhancements](/configuration/transforms) with [Musicbrainz](/configuration/transforms/musicbrainz) to automatically correct and fill in missing track information for your scrobbles * Consult the [**FAQ**](/FAQ) for solutions to common problems