diff --git a/docsite/docs/configuration/sources/sources.mdx b/docsite/docs/configuration/sources/sources.mdx index 8e85655e..80628b90 100644 --- a/docsite/docs/configuration/sources/sources.mdx +++ b/docsite/docs/configuration/sources/sources.mdx @@ -40,6 +40,7 @@ A **Source** is a data source that contains information about tracks you are pla | [WebScrobbler](/configuration/sources/webscrobbler) | [Ingress](./?sourceComm=active#by-communication-method) | [History](./?sot=history#by-data-source-of-truth) | ❌ | ✅ | ❌ | ❌ | | [VLC](/configuration/sources/vlc) | [Active](./?sourceComm=active#by-communication-method) | [Activity](./?sot=activity#by-data-source-of-truth) | ❌ | ✅ | ✅ | ❌ | | [Yamaha MusicCast](/configuration/sources/yamaha-musiccast) | [Active](./?sourceComm=active#by-communication-method) | [Activity](./?sot=activity#by-data-source-of-truth) | ❌ | ✅ | ✅ | ❌ | +| [Yandex Music](/configuration/sources/yandex-music) | [Active](./?sourceComm=active#by-communication-method) | [Activity](./?sot=activity#by-data-source-of-truth) | | ✅ | ✅ | ❌ | | [Youtube Music](/configuration/sources/youtube-music) | [Active](./?sourceComm=active#by-communication-method) | [History](./?sot=history#by-data-source-of-truth) | ❌ | ✅ | ❌ | ❌ | ## Features diff --git a/docsite/docs/configuration/sources/yandex-music.mdx b/docsite/docs/configuration/sources/yandex-music.mdx new file mode 100644 index 00000000..b37d96ad --- /dev/null +++ b/docsite/docs/configuration/sources/yandex-music.mdx @@ -0,0 +1,79 @@ +--- +title: Yandex Music +toc_min_heading_level: 2 +toc_max_heading_level: 5 +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; +import CodeBlock from '@theme/CodeBlock'; +import JsonConfig from '!!raw-loader!@site/../config/ymbridge.json.example'; + +Monitor your [**Yandex Music**](https://music.yandex.com) listening activity in real-time. + +This Source requires a third party docker container to communicate with Yandex Music, [`yandex-music-bridge`](https://github.com/Druidblack/yandex-music-bridge). + +
+ +Example Docker Compose with `yandex-music-bridge` + +```yaml title="~/msData/docker-compose.yml" +services: + multi-scrobbler: + image: foxxmd/multi-scrobbler + container_name: multi-scrobbler + environment: + - TZ=Etc/GMT + # ...your other sources/clients here + + # add for yandex music + // highlight-start + - YMBRIDGE_URL=http://yandex-music-bridge:9980 + - YMBRIDGE_API_KEY=change-me + // highlight-end + + volumes: + - "./config:/config" + ports: + - "9078:9078" + restart: unless-stopped + + // highlight-start + yandex-music-bridge: + image: ghcr.io/druidblack/yandex-music-bridge:latest + environment: + - TZ=Europe/Moscow + - YM_TOKEN=AgAAAAACO3_345345 + - YM_API_KEY=change-me + - YM_PORT=9980 + - YM_LANGUAGE=ru + - YM_ENABLE_YNISON=true + - YM_PUSH_TTL=45 + - YM_QUEUE_CACHE_TTL=15 + - YM_LOG_LEVEL=INFO + ports: + - "9980:9980" + restart: unless-stopped + // highlight-end +``` + +You will need to acquire your own token for `YM_TOKEN` used in [`yandex-music-bridge`](https://github.com/Druidblack/yandex-music-bridge) using the instructions provided there. + +
+ + + +If your issue is specifically related to [`yandex-music-bridge`](https://github.com/Druidblack/yandex-music-bridge) (errors in the container, usage instructions, general Yandex setup like token etc...) please open an issue on **that repository** instead of Multi-Scrobbler's. + +If you have issues specifically with the MS Source please mention [**Druidblack**](https://github.com/Druidblack) (`@Druidblack`) when opening an [issue](https://github.com/FoxxMD/multi-scrobbler/issues/new/choose) or [discussion](https://github.com/FoxxMD/multi-scrobbler/discussions/new/choose). Yandex Music is [not available](https://en.wikipedia.org/wiki/Yandex_Music) in the country of the main Multi-Scrobbler developer (FoxxMD) so they can only help troubleshooting general MS issues related to Yandex Music. + + + +## Configuration + + + | Environmental Variable | Required? | Default | Description | + | :--------------------- | :-------- | ------- | :------------------------------------------------------------------------ | + | `YMBRIDGE_URL` | Yes | | `http://URL:PORT` for the `yandex-music-bridge` container | + | `YMBRIDGE_API_KEY` | No | | The same key used for `YM_API_KEY` on the `yandex-music-bridge` container | + \ No newline at end of file diff --git a/docsite/docs/index.mdx b/docsite/docs/index.mdx index 19006c42..a6d829ba 100644 --- a/docsite/docs/index.mdx +++ b/docsite/docs/index.mdx @@ -41,6 +41,7 @@ A dockerized app that monitors your music listening activity from *everywhere* a * [WebScrobbler](/configuration/sources/webscrobbler) * [VLC](/configuration/sources/vlc) * [Yamaha MusicCast](/configuration/sources/yamaha-musiccast) + * [Yandex Music](/configuration/sources/yandex-music) * [Youtube Music](/configuration/sources/youtube-music) * Supports scrobbling to many [**Clients**](/configuration/clients) * [Discord](/configuration/clients/discord) (Now Playing)