From 6bb7b17e97c84e31e137e1bf575cfba676454853 Mon Sep 17 00:00:00 2001 From: FoxxMD Date: Tue, 7 Apr 2026 12:39:41 +0000 Subject: [PATCH] docs: Update readme with new doc site base url --- README.md | 108 +++++++++++++++++++++++++++--------------------------- 1 file changed, 54 insertions(+), 54 deletions(-) diff --git a/README.md b/README.md index 5a4e4496..73af9689 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![Latest Release](https://img.shields.io/github/v/release/foxxmd/multi-scrobbler)](https://github.com/FoxxMD/multi-scrobbler/releases) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![Docker Pulls](https://img.shields.io/docker/pulls/foxxmd/multi-scrobbler)](https://hub.docker.com/r/foxxmd/multi-scrobbler) -[![Docs](https://img.shields.io/badge/Read%20The%20Docs-1082c2)](https://foxxmd.github.io/multi-scrobbler/) +[![Docs](https://img.shields.io/badge/Read%20The%20Docs-1082c2)](https://docs.multi-scrobbler.app/) multi-scrobbler logo A dockerized app that monitors your music listening activity from *everywhere* and scrobbles it *anywhere*. -* Supports scrobbling from many [**Sources**](https://foxxmd.github.io/multi-scrobbler/configuration/sources) - * [Azuracast](https://foxxmd.github.io/multi-scrobbler/configuration/sources/azuracast) - * [Deezer](https://foxxmd.github.io/multi-scrobbler/configuration/sources/deezer) - * [Google Cast (Chromecast)](https://foxxmd.github.io/multi-scrobbler/configuration/sources/google-cast) - * [Icecast](https://foxxmd.github.io/multi-scrobbler/configuration/sources/icecast) - * [Jellyfin](https://foxxmd.github.io/multi-scrobbler/configuration/sources/jellyfin) - * [JRiver](https://foxxmd.github.io/multi-scrobbler/configuration/sources/jriver) - * [Kodi](https://foxxmd.github.io/multi-scrobbler/configuration/sources/kodi) - * [Koito](https://foxxmd.github.io/multi-scrobbler/configuration/sources/koito-source) - * [Last.fm](https://foxxmd.github.io/multi-scrobbler/configuration/sources/lastfm-source) - * [Last.fm (Endpoint)](https://foxxmd.github.io/multi-scrobbler/configuration/sources/lastfm-endpoint) - * [Libre.fm](https://foxxmd.github.io/multi-scrobbler/configuration/sources/librefm-source) - * [ListenBrainz](https://foxxmd.github.io/multi-scrobbler/configuration/sources/listenbrainz-source) - * [ListenBrainz (Endpoint)](https://foxxmd.github.io/multi-scrobbler/configuration/sources/listenbrainz-endpoint) - * [Maloja](https://foxxmd.github.io/multi-scrobbler/configuration/sources/maloja) - * [Mopidy](https://foxxmd.github.io/multi-scrobbler/configuration/sources/mopidy) - * [MPD (Music Player Daemon)](https://foxxmd.github.io/multi-scrobbler/configuration/sources/mpd) - * [MPRIS (Linux Desktop)](https://foxxmd.github.io/multi-scrobbler/configuration/sources/mpris) - * [Musikcube](https://foxxmd.github.io/multi-scrobbler/configuration/sources/musikcube) - * [Music Assistant](https://foxxmd.github.io/multi-scrobbler/configuration/sources/listenbrainz-endpoint#music-assistant) - * [Plex](https://foxxmd.github.io/multi-scrobbler/configuration/sources/plex) - * [Rocksky](https://foxxmd.github.io/multi-scrobbler/configuration/sources/rocksky-source) - * [Sonos](https://foxxmd.github.io/multi-scrobbler/configuration/sources/sonos) - * [Spotify](https://foxxmd.github.io/multi-scrobbler/configuration/sources/spotify) - * [Subsonic-compatible APIs](https://foxxmd.github.io/multi-scrobbler/configuration/sources/subsonic) (like [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/)) - * [teal.fm](https://foxxmd.github.io/multi-scrobbler/configuration/sources/tealfm-source) - * [WebScrobbler](https://foxxmd.github.io/multi-scrobbler/configuration/sources/webscrobbler) - * [VLC](https://foxxmd.github.io/multi-scrobbler/configuration/sources/vlc) - * [Yamaha MusicCast](https://foxxmd.github.io/multi-scrobbler/configuration/sources/yamaha-musiccast) - * [Youtube Music](https://foxxmd.github.io/multi-scrobbler/configuration/sources/youtube-music) -* Supports scrobbling to many [**Clients**](https://foxxmd.github.io/multi-scrobbler/configuration/clients) - * [Discord](https://foxxmd.github.io/multi-scrobbler/configuration/clients/discord) (Now Playing) - * [Koito](https://foxxmd.github.io/multi-scrobbler/configuration/clients/koito) - * [Last.fm](https://foxxmd.github.io/multi-scrobbler/configuration/clients/lastfm) - * [Libre.fm](https://foxxmd.github.io/multi-scrobbler/configuration/clients/librefm) - * [ListenBrainz](https://foxxmd.github.io/multi-scrobbler/configuration/clients/listenbrainz) - * [Maloja](https://foxxmd.github.io/multi-scrobbler/configuration/clients/maloja) - * [Rocksky](https://foxxmd.github.io/multi-scrobbler/configuration/clients/rocksky) - * [teal.fm](https://foxxmd.github.io/multi-scrobbler/configuration/clients/tealfm) -* Monitor status of Sources and Clients using [webhooks (Gotify, Ntfy, Apprise)](https://foxxmd.github.io/multi-scrobbler/configuration#webhook-configurations), [healthcheck endpoints](https://foxxmd.github.io/multi-scrobbler/configuration#health-endpoint), or [prometheus metrics](https://foxxmd.github.io/multi-scrobbler/configuration/#prometheus). -* Supports [Now Playing](https://foxxmd.github.io/multi-scrobbler/configuration/clients#now-playing) for scrobble Clients +* Supports scrobbling from many [**Sources**](https://docs.multi-scrobbler.app/configuration/sources) + * [Azuracast](https://docs.multi-scrobbler.app/configuration/sources/azuracast) + * [Deezer](https://docs.multi-scrobbler.app/configuration/sources/deezer) + * [Google Cast (Chromecast)](https://docs.multi-scrobbler.app/configuration/sources/google-cast) + * [Icecast](https://docs.multi-scrobbler.app/configuration/sources/icecast) + * [Jellyfin](https://docs.multi-scrobbler.app/configuration/sources/jellyfin) + * [JRiver](https://docs.multi-scrobbler.app/configuration/sources/jriver) + * [Kodi](https://docs.multi-scrobbler.app/configuration/sources/kodi) + * [Koito](https://docs.multi-scrobbler.app/configuration/sources/koito-source) + * [Last.fm](https://docs.multi-scrobbler.app/configuration/sources/lastfm-source) + * [Last.fm (Endpoint)](https://docs.multi-scrobbler.app/configuration/sources/lastfm-endpoint) + * [Libre.fm](https://docs.multi-scrobbler.app/configuration/sources/librefm-source) + * [ListenBrainz](https://docs.multi-scrobbler.app/configuration/sources/listenbrainz-source) + * [ListenBrainz (Endpoint)](https://docs.multi-scrobbler.app/configuration/sources/listenbrainz-endpoint) + * [Maloja](https://docs.multi-scrobbler.app/configuration/sources/maloja) + * [Mopidy](https://docs.multi-scrobbler.app/configuration/sources/mopidy) + * [MPD (Music Player Daemon)](https://docs.multi-scrobbler.app/configuration/sources/mpd) + * [MPRIS (Linux Desktop)](https://docs.multi-scrobbler.app/configuration/sources/mpris) + * [Musikcube](https://docs.multi-scrobbler.app/configuration/sources/musikcube) + * [Music Assistant](https://docs.multi-scrobbler.app/configuration/sources/listenbrainz-endpoint#music-assistant) + * [Plex](https://docs.multi-scrobbler.app/configuration/sources/plex) + * [Rocksky](https://docs.multi-scrobbler.app/configuration/sources/rocksky-source) + * [Sonos](https://docs.multi-scrobbler.app/configuration/sources/sonos) + * [Spotify](https://docs.multi-scrobbler.app/configuration/sources/spotify) + * [Subsonic-compatible APIs](https://docs.multi-scrobbler.app/configuration/sources/subsonic) (like [Airsonic](https://airsonic.github.io/) and [Navidrome](https://www.navidrome.org/)) + * [teal.fm](https://docs.multi-scrobbler.app/configuration/sources/tealfm-source) + * [WebScrobbler](https://docs.multi-scrobbler.app/configuration/sources/webscrobbler) + * [VLC](https://docs.multi-scrobbler.app/configuration/sources/vlc) + * [Yamaha MusicCast](https://docs.multi-scrobbler.app/configuration/sources/yamaha-musiccast) + * [Youtube Music](https://docs.multi-scrobbler.app/configuration/sources/youtube-music) +* Supports scrobbling to many [**Clients**](https://docs.multi-scrobbler.app/configuration/clients) + * [Discord](https://docs.multi-scrobbler.app/configuration/clients/discord) (Now Playing) + * [Koito](https://docs.multi-scrobbler.app/configuration/clients/koito) + * [Last.fm](https://docs.multi-scrobbler.app/configuration/clients/lastfm) + * [Libre.fm](https://docs.multi-scrobbler.app/configuration/clients/librefm) + * [ListenBrainz](https://docs.multi-scrobbler.app/configuration/clients/listenbrainz) + * [Maloja](https://docs.multi-scrobbler.app/configuration/clients/maloja) + * [Rocksky](https://docs.multi-scrobbler.app/configuration/clients/rocksky) + * [teal.fm](https://docs.multi-scrobbler.app/configuration/clients/tealfm) +* Monitor status of Sources and Clients using [webhooks (Gotify, Ntfy, Apprise)](https://docs.multi-scrobbler.app/configuration#webhook-configurations), [healthcheck endpoints](https://docs.multi-scrobbler.app/configuration#health-endpoint), or [prometheus metrics](https://docs.multi-scrobbler.app/configuration/#prometheus). +* Supports [Now Playing](https://docs.multi-scrobbler.app/configuration/clients#now-playing) for scrobble Clients * 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](ttps://foxxmd.github.io/multi-scrobbler/configuration#configuration-types) -* Modify data before scrobbling with [regular expression or search patterns](https://foxxmd.github.io/multi-scrobbler/configuration/transforms) -* Install using [Docker images for x86/ARM](https://foxxmd.github.io/multi-scrobbler/installation#docker) or [locally with NodeJS](https://foxxmd.github.io/multi-scrobbler/installation#nodejs) +* Modify data before scrobbling with [regular expression or search patterns](https://docs.multi-scrobbler.app/configuration/transforms) +* Install using [Docker images for x86/ARM](https://docs.multi-scrobbler.app/installation#docker) or [locally with NodeJS](https://docs.multi-scrobbler.app/installation#nodejs) -[**Quick Start Guide**](https://foxxmd.github.io/multi-scrobbler//quickstart) +[**Quick Start Guide**](https://docs.multi-scrobbler.app//quickstart) @@ -73,15 +73,15 @@ A dockerized app that monitors your music listening activity from *everywhere* a **But I already scrobble my music to Last.fm/ListenBrainz, is multi-scrobbler for me?** -Yes! You can use [Last.fm as a **Source**](https://foxxmd.github.io/multi-scrobbler/configuration/sources/lastfm-source) or [Listenbrainz as a **Source**](https://foxxmd.github.io/multi-scrobbler/configuration/sources/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. +Yes! You can use [Last.fm as a **Source**](https://docs.multi-scrobbler.app/configuration/sources/lastfm-source) or [Listenbrainz as a **Source**](https://docs.multi-scrobbler.app/configuration/sources/listenbrainz-source) to forward scrobbles from your profile to any other Client! That way you can keep your current scrobble setup as-is but still get the benefit of capturing your data to a self-hosted location. ## How Does multi-scrobbler (MS) Work? -You set up [configurations](https://foxxmd.github.io/multi-scrobbler/configuration) for one or more [**Sources**](https://foxxmd.github.io/multi-scrobbler/configuration/sources) and one or more [**Clients**](https://foxxmd.github.io/multi-scrobbler/configuration/clients). MS monitors all of your configured **Sources**. When new tracks are played by a Source MS grabs that information and then sends it (scrobbles it) to all **Clients** that Source is configured to forward to. +You set up [configurations](https://docs.multi-scrobbler.app/configuration) for one or more [**Sources**](https://docs.multi-scrobbler.app/configuration/sources) and one or more [**Clients**](https://docs.multi-scrobbler.app/configuration/clients). MS monitors all of your configured **Sources**. When new tracks are played by a Source MS grabs that information and then sends it (scrobbles it) to all **Clients** that Source is configured to forward to. ### Source -A [**Source**](https://foxxmd.github.io/multi-scrobbler/configuration/sources) is a data source that contains information about music you are playing or have listened to, such as: a desktop player, web music player, or cloud music service. Examples are **Spotify, Jellyfin, Plex, Youtube Music, Navidrome**, etc... +A [**Source**](https://docs.multi-scrobbler.app/configuration/sources) is a data source that contains information about music you are playing or have listened to, such as: a desktop player, web music player, or cloud music service. Examples are **Spotify, Jellyfin, Plex, Youtube Music, Navidrome**, etc... Source configurations consist of: @@ -91,7 +91,7 @@ Source configurations consist of: ### Client -A [**Client**](https://foxxmd.github.io/multi-scrobbler/configuration/clients) is an application that stores the historical information about what music you have played (scrobbles). Examples are **Koito, Last.fm, Listenbrainz**... +A [**Client**](https://docs.multi-scrobbler.app/configuration/clients) is an application that stores the historical information about what music you have played (scrobbles). Examples are **Koito, Last.fm, Listenbrainz**... Client configurations consist of: @@ -100,15 +100,15 @@ Client configurations consist of: ## Quick Start -[See the **Quick Start Guide**](https://foxxmd.github.io/multi-scrobbler/quickstart) +[See the **Quick Start Guide**](https://docs.multi-scrobbler.app/quickstart) ## Installation -[See the **Installation** documentation](https://foxxmd.github.io/multi-scrobbler/installation) +[See the **Installation** documentation](https://docs.multi-scrobbler.app/installation) ## Configuration -[See the **Configuration** documentation](https://foxxmd.github.io/multi-scrobbler/configuration) +[See the **Configuration** documentation](https://docs.multi-scrobbler.app/configuration) ## Usage @@ -123,11 +123,11 @@ On first startup you may need to authorize Spotify and/or Last.fm by visiting th ## Help/FAQ -Having issues with connections or configuration? Check the [FAQ](https://foxxmd.github.io/multi-scrobbler/FAQ) before creating an issue! +Having issues with connections or configuration? Check the [FAQ](https://docs.multi-scrobbler.app/FAQ) before creating an issue! ## Development -[Detailed architecture and development guides for Sources/Clients](https://foxxmd.github.io/multi-scrobbler/development/dev-common) +[Detailed architecture and development guides for Sources/Clients](https://docs.multi-scrobbler.app/development/dev-common) ## License