diff --git a/README.md b/README.md index 8e16a191..be467c2d 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ multi-scrobbler logo -A javascript app to scrobble music you listen to, to [Maloja](https://github.com/krateng/maloja), [Last.fm](https://www.last.fm), [ListenBrainz](https://listenbrainz.org), and other services. +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) @@ -79,7 +79,7 @@ You set up [configurations](https://foxxmd.github.io/multi-scrobbler/configurati ### 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, like a desktop player, web music player, or cloud music service. Examples are **Spotify, Jellyfin, Plex, Youtube Music, Navidrome**, etc... +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... Source configurations consist of: @@ -89,7 +89,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 **Maloja, Last.fm, Listenbrainz**... +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**... Client configurations consist of: diff --git a/docsite/docs/index.mdx b/docsite/docs/index.mdx index 5115a003..9ec147da 100644 --- a/docsite/docs/index.mdx +++ b/docsite/docs/index.mdx @@ -10,9 +10,9 @@ sidebar_position: 1 multi-scrobbler logo -A javascript app to scrobble music you listened to, to [Maloja](https://github.com/krateng/maloja), [Last.fm](https://www.last.fm), [ListenBrainz](https://listenbrainz.org), and [Koito](https://koito.io/). +A dockerized app that monitors your music listening activity from *everywhere* and scrobbles it *anywhere*. -* Supports scrobbling from many [**Sources**](/configuration/sources) +* Supports monitoring activity from many [**Sources**](/configuration/sources) * [Azuracast](/configuration/sources/azuracast) * [Deezer](/configuration/sources/deezer) * [Google Cast (Chromecast)](/configuration/sources/google-cast) @@ -83,7 +83,7 @@ You set up [configurations](/configuration) for one or more [**Sources**](/confi ### Source -A [**Source**](/configuration/sources) is a data source that contains information about music you are playing or have listened to, like a desktop player, web music player, or cloud music service. Examples are **Spotify, Jellyfin, Plex, Youtube Music, Navidrome**, etc... +A [**Source**](/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: @@ -93,7 +93,7 @@ Source configurations consist of: ### Client -A [**Client**](/configuration/clients) is an application that stores the historical information about what music you have played (scrobbles). Examples are **Maloja, Last.fm, Listenbrainz**... +A [**Client**](/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: diff --git a/docsite/docs/quickstart.mdx b/docsite/docs/quickstart.mdx index 44460a53..4d2938a5 100644 --- a/docsite/docs/quickstart.mdx +++ b/docsite/docs/quickstart.mdx @@ -232,37 +232,33 @@ Modify the `lastfm.json` file you created in the [Setup Sources](#setup-sources) [**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 [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`: + + Setup a [Koito server](https://koito.io/guides/installation/) if you have not already done this. - ```yaml reference title="~/malojaData/docker-compose.yml" - https://github.com/krateng/maloja/blob/master/example-compose.yml - ``` + * [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 `myUser`) + * 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 `myURL` below with `http://192.168.0.100:4110` + * [More info on the URL to use is the full docs](/configuration/clients/koito) - Uncomment `environment` and add `MALOJA_FORCE_PASSWORD=CHANGE_ME` to set an admin password + 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) - Start the container: + ```yaml title="~/msData/docker-compose.yml" + - KOITO_TOKEN=myToken + - KOITO_USER=myUser + - KOITO_URL=myURL + ``` - ```shell title="~/malojaData" - docker compose up -d - ``` -
+ :::tip - * 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 + Ensure that Koito is configured to allow requests from multi-scrobbler! In Koito config set [`KOITO_ALLOWED_HOSTS`](https://koito.io/reference/configuration/#koito_allowed_hosts) to the IP the multi-scrobbler dashboard is accessible from. - 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 - ``` [Register for an API account at Last.fm.](https://www.last.fm/api/account/create) @@ -280,33 +276,37 @@ Modify the `lastfm.json` file you created in the [Setup Sources](#setup-sources) - LASTFM_SECRET=myApiSecret ``` - - Setup a [Koito server](https://koito.io/guides/installation/) if you have not already done this. + + Setup a [Maloja server](https://github.com/krateng/maloja?tab=readme-ov-file#how-to-install) 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 `myUser`) - * 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 `myURL` 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) + Maloja Setup Intructions - ```yaml title="~/msData/docker-compose.yml" - - KOITO_TOKEN=myToken - - KOITO_USER=myUser - - KOITO_URL=myURL - ``` + Using Maloja's example `docker-compose.yml`: - :::tip + ```yaml reference title="~/malojaData/docker-compose.yml" + https://github.com/krateng/maloja/blob/master/example-compose.yml + ``` - Ensure that Koito is configured to allow requests from multi-scrobbler! In Koito config set [`KOITO_ALLOWED_HOSTS`](https://koito.io/reference/configuration/#koito_allowed_hosts) to the IP the multi-scrobbler dashboard is accessible from. + 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 + ```